Skip to content

Latest commit

 

History

History
69 lines (49 loc) · 3.84 KB

DESIGN.md

File metadata and controls

69 lines (49 loc) · 3.84 KB
Raw

Design Considerations

This component was designd inline with the NL API Strategie and https://www.noraonline.nl/wiki/Standaarden.

Dutch versus English

NL API Standard

solution geldigOp is suported as a backup for validOn, but only validOn us documented.

Comma Notation versus Bracket Notation on arrays's

The NL API standaard uses comma notation on array's in http requests. E.g. fields=id,name,description however common browsers(based on chromium e.g. chrome and edge) use bracker notation for query style array's e.g. fields[]=id&fields[]=name,&fields[]=description. The difrence ofcoure is obvius since comma notation doesn't allow you to index arrays. Interestengly enough there isn't actually a rfc spec for this.

It is precievable that in future iterations we would like to use indexd array in situations where the index of the array can't be assumed on basis of url notation, when indexes arn't numirical, when we dont want an index to start at 0 or when indexes are purpusly missing (comma notation of id,name,description would always refert to te equvalant of fields: [ 0 => id, 1 => name, 2 => description ]

solution We support both comma and bracket notation on array's, but only document bracket notation since it is prevered.

Timetraveling

The commonground proto componant natively supports time traveling on all entities that are annotaded with the @Gedmo\Loggable, this is done by adding the ?validOn=[date] query to a request, date can iether be a datetime or datedatime string. Ant value suported by php's strtotime() is suported. Keep in mind that this returns the entity a as it was valid on that time or better put, the last changed verion BEFORE that moment. To get a complete list of all changes on a item the ?showLogs=true quary can be used.

NLX Audit trail

NLX uses headers for her audit trail, we curently log the following headers per request but dont validate on content thereof.

  • X-NLX-Request-User-Id, the id of the user performing the request
  • X-NLX-Request-Application-Id, the id of the application performing the request
  • X-NLX-Request-Subject-Identifier, an subject identifier for purpose registration (doelbinding)
  • X-NLX-Request-Process-Id, a process id for purpose registration (doelbinding)
  • X-NLX-Request-Data-Elements, a list of requested data elements
  • X-NLX-Request-Data-Subject

NLX Authentication

Filtering

Becouse it is based on api-platform de proto component supports filter functions as in api platform aditionaly there are custom filter types available for commonground.

Regex Exact

Regex Contains

Like_ The like filters is used to search for enities with the traditional sql LIKE operator. If pattern does not contain percent signs or underscores, then the pattern only represents the string itself; in that case LIKE acts like the equals operator. An underscore (_) in pattern stands for (matches) any single character; a percent sign (%) matches any sequence of zero or more characters.

Some examples:

'abc' LIKE 'abc' true 'abc' LIKE 'a%' true 'abc' LIKE 'b' true 'abc' LIKE 'c' false LIKE pattern matching always covers the entire string. Therefore, if it's desired to match a sequence anywhere within a string, the pattern must start and end with a percent sign.

To match a literal underscore or percent sign without matching other characters, the respective character in pattern must be preceded by a backlash.

JSON-HAL versus JSON-LD

Error Handling http://www.hydra-cg.com/spec/latest/core/#description-of-http-status-codes-and-errors