diff --git a/.idea/dictionaries/VLE2FE.xml b/.idea/dictionaries/VLE2FE.xml index 2d3f5ec..16f4de3 100644 --- a/.idea/dictionaries/VLE2FE.xml +++ b/.idea/dictionaries/VLE2FE.xml @@ -18,6 +18,7 @@ frameguard functionlink glassfibrecontent + isin janedoe johnnydoe kfingew diff --git a/api/api.yaml b/api/api.yaml index 7089f4a..45be8c4 100644 --- a/api/api.yaml +++ b/api/api.yaml @@ -5,28 +5,35 @@ info: title: Digital fingerprint of plastics - API version: 1.0.0 description: | - This API gives access to the project database.
+ This **API** gives access to the project database. + Access is restricted. Authentication can be obtained with HTTP Basic Auth using username and password. - Data access methods can also be accessed using an API key at the URL ending like ?key=xxx
+ Data access methods can also be accessed using an API key at the URL ending like ?key=xxx + The description lists available authentication methods, also the locks of each method close correspondingly - if the entered authentication is allowed.

- There are a number of different user levels:
- + if the entered authentication is allowed. + + + There are a number of different user levels: + + | | read sample data | add samples/edit own | read spectral data | edit other's data | maintain templates | edit users | + |:-----:|:----------------:|:--------------------:|:------------------:|:-----------------:|:------------------:|:----------:| + | read | yes | no | no | no | no | no | + | write | yes | yes | no | no | no | no | + | dev | yes | yes | yes | yes | yes | no | + | admin | yes | yes | yes | yes | yes | yes | + Password policy: - + + - at least one digit + - at least one lower case letter + - at least one upper case letter + - at least one of the following special characters: !"#%&'()*+,-./:;<=>?@[\]^_`{|}~ + - no whitespace + - at least 8 characters + +
+ x-doc: | status: