banana/definma-api
Archived
2
Fork 0
Code Releases Activity

added authorization

Browse Source
This commit is contained in:
VLE2FE
2020-04-23 13:59:45 +02:00
parent 90d34f1e1b
commit 1a3fdc567d
21 changed files with 393 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
oas/condition.yaml
View File

@ -3,7 +3,7 @@
- $ref: 'oas.yaml#/components/parameters/Id'
get:
summary: TODO condition by id
description: 'levels: read, write, maintain, dev, admin'
description: 'Auth: all, levels: read, write, maintain, dev, admin'
tags:
- /condition
responses:
@ -23,9 +23,11 @@
$ref: 'oas.yaml#/components/responses/500'
put:
summary: TODO add/change condition
description: 'levels: write, maintain, dev, admin'
description: 'Auth: basic, levels: write, maintain, dev, admin'
tags:
- /condition
security:
- BasicAuth: []
requestBody:
required: true
content:
@ -51,9 +53,11 @@
$ref: 'oas.yaml#/components/responses/500'
delete:
summary: TODO delete condition
description: 'levels: write, maintain, dev, admin'
description: 'Auth: basic, levels: write, maintain, dev, admin'
tags:
- /condition
security:
- BasicAuth: []
responses:
200:
$ref: 'oas.yaml#/components/responses/Ok'

10
oas/material.yaml
View File

@ -3,7 +3,7 @@
- $ref: 'oas.yaml#/components/parameters/Id'
get:
summary: TODO get material details
description: 'levels: read, write, maintain, dev, admin'
description: 'Auth: all, levels: read, write, maintain, dev, admin'
tags:
- /material
responses:
@ -21,9 +21,11 @@
$ref: 'oas.yaml#/components/responses/500'
put:
summary: TODO add/change material
description: 'levels: write, maintain, dev, admin'
description: 'Auth: basic, levels: write, maintain, dev, admin'
tags:
- /material
security:
- BasicAuth: []
requestBody:
required: true
content:
@ -47,9 +49,11 @@
$ref: 'oas.yaml#/components/responses/500'
delete:
summary: TODO delete material
description: 'levels: write, maintain, dev, admin'
description: 'Auth: basic, levels: write, maintain, dev, admin'
tags:
- /material
security:
- BasicAuth: []
responses:
200:
$ref: 'oas.yaml#/components/responses/Ok'

10
oas/measurement.yaml
View File

@ -3,7 +3,7 @@
- $ref: 'oas.yaml#/components/parameters/Id'
get:
summary: TODO measurement values by id
description: 'levels: read, write, maintain, dev, admin'
description: 'Auth: all, levels: read, write, maintain, dev, admin'
tags:
- /measurement
responses:
@ -23,9 +23,11 @@
$ref: 'oas.yaml#/components/responses/500'
put:
summary: TODO add/change measurement
description: 'levels: write, maintain, dev, admin'
description: 'Auth: basic, levels: write, maintain, dev, admin'
tags:
- /measurement
security:
- BasicAuth: []
requestBody:
required: true
content:
@ -51,9 +53,11 @@
$ref: 'oas.yaml#/components/responses/500'
delete:
summary: TODO delete measurement
description: 'levels: write, maintain, dev, admin'
description: 'Auth: basic, levels: write, maintain, dev, admin'
tags:
- /measurement
security:
- BasicAuth: []
responses:
200:
$ref: 'oas.yaml#/components/responses/Ok'

8
oas/model.yaml
View File

@ -3,7 +3,7 @@
- $ref: 'oas.yaml#/components/parameters/Name'
get:
summary: TODO get model data by name
description: 'levels: dev, admin'
description: 'Auth: all, levels: dev, admin'
tags:
- /model
responses:
@ -24,7 +24,7 @@
$ref: 'oas.yaml#/components/responses/500'
put:
summary: TODO add/replace model data by name
description: 'levels: dev, admin'
description: 'Auth: all, levels: dev, admin'
tags:
- /model
requestBody:
@ -50,9 +50,11 @@
$ref: 'oas.yaml#/components/responses/500'
delete:
summary: TODO delete model data
description: 'levels: dev, admin'
description: 'Auth: basic, levels: dev, admin'
tags:
- /model
security:
- BasicAuth: []
responses:
200:
$ref: 'oas.yaml#/components/responses/Ok'

5
oas/oas.yaml
View File

@ -6,7 +6,10 @@ info:
version: 1.0.0
description: |
This API gives access to the project database.<br>
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<br>
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<br>
The description lists available authentication methods, also the locks of each method close correspondingly
if the entered authentication is allowed.<br><br>
There are a number of different user levels: <br>
<ul>
<li>read: read access to the samples database</li>

25
oas/others.yaml
View File

@ -1,6 +1,7 @@
/:
get:
summary: Root method
description: 'Auth: none'
tags:
- /
security: []
@ -14,5 +15,29 @@
status:
type: string
example: 'API server up and running!'
500:
$ref: 'oas.yaml#/components/responses/500'
/authorized:
get:
summary: Checks authorization
description: 'Auth: all, levels: read, write, maintain, dev, admin'
tags:
- /
responses:
200:
description: Authorized
content:
application/json:
schema:
properties:
status:
type: string
example: 'Authorization successful'
method:
type: string
example: 'basic'
401:
$ref: 'oas.yaml#/components/responses/401'
500:
$ref: 'oas.yaml#/components/responses/500'

14
oas/sample.yaml
View File

@ -1,7 +1,7 @@
/samples:
get:
summary: TODO all samples in overview
description: 'levels: read, write, maintain, dev, admin'
description: 'Auth: all, levels: read, write, maintain, dev, admin'
tags:
- /sample
responses:
@ -20,7 +20,7 @@
- $ref: 'oas.yaml#/components/parameters/Id'
get:
summary: TODO sample details
description: 'levels: read, write, maintain, dev, admin'
description: 'Auth: all, levels: read, write, maintain, dev, admin'
tags:
- /sample
responses:
@ -40,9 +40,11 @@
$ref: 'oas.yaml#/components/responses/500'
put:
summary: TODO add/change sample
description: 'levels: write, maintain, dev, admin'
description: 'Auth: basic, levels: write, maintain, dev, admin'
tags:
- /sample
security:
- BasicAuth: []
requestBody:
required: true
content:
@ -68,9 +70,11 @@
$ref: 'oas.yaml#/components/responses/500'
delete:
summary: TODO delete sample
description: 'levels: write, maintain, dev, admin'
description: 'Auth: basic, levels: write, maintain, dev, admin'
tags:
- /sample
security:
- BasicAuth: []
responses:
200:
$ref: 'oas.yaml#/components/responses/Ok'
@ -87,7 +91,7 @@
/sample/notes/fields:
get:
summary: TODO list all existing field names for custom notes fields
description: 'levels: write, maintain, dev, admin'
description: 'Auth: all, levels: write, maintain, dev, admin'
tags:
- /sample
responses:

24
oas/template.yaml
View File

@ -1,7 +1,7 @@
/template/treatments:
get:
summary: TODO all available treatment methods
description: 'levels: read, write, maintain, dev, admin'
description: 'Auth: basic, levels: read, write, maintain, dev, admin'
tags:
- /templates
security:
@ -30,7 +30,7 @@
- $ref: 'oas.yaml#/components/parameters/Name'
get:
summary: TODO treatment method details
description: 'levels: read, write, maintain, admin'
description: 'Auth: basic, levels: read, write, maintain, admin'
tags:
- /templates
security:
@ -59,9 +59,11 @@
$ref: 'oas.yaml#/components/responses/500'
put:
summary: TODO add/change treatment method
description: 'levels: maintain, admin'
description: 'Auth: basic, levels: maintain, admin'
tags:
- /templates
security:
- BasicAuth: []
requestBody:
required: true
content:
@ -101,9 +103,11 @@
$ref: 'oas.yaml#/components/responses/500'
delete:
summary: TODO delete treatment method
description: 'levels: maintain, admin'
description: 'Auth: basic, levels: maintain, admin'
tags:
- /templates
security:
- BasicAuth: []
responses:
200:
$ref: 'oas.yaml#/components/responses/Ok'
@ -120,7 +124,7 @@
/template/measurements:
get:
summary: TODO all available measurement methods
description: 'levels: read, write, maintain, dev, admin'
description: 'Auth: basic, levels: read, write, maintain, dev, admin'
tags:
- /templates
security:
@ -150,7 +154,7 @@
- $ref: 'oas.yaml#/components/parameters/Name'
get:
summary: TODO measurement method details
description: 'levels: read, write, maintain, admin'
description: 'Auth: basic, levels: read, write, maintain, admin'
tags:
- /templates
security:
@ -180,9 +184,11 @@
$ref: 'oas.yaml#/components/responses/500'
put:
summary: TODO add/change measurement method
description: 'levels: maintain, admin'
description: 'Auth: basic, levels: maintain, admin'
tags:
- /templates
security:
- BasicAuth: []
requestBody:
required: true
content:
@ -224,9 +230,11 @@
$ref: 'oas.yaml#/components/responses/500'
delete:
summary: TODO delete measurement method
description: 'levels: maintain, admin'
description: 'Auth: basic, levels: maintain, admin'
tags:
- /templates
security:
- BasicAuth: []
responses:
200:
$ref: 'oas.yaml#/components/responses/Ok'

17
oas/user.yaml
View File

@ -1,7 +1,7 @@
/users:
get:
summary: TODO lists all users
description: 'levels: admin'
description: 'Auth: basic, levels: admin'
tags:
- /user
security:
@ -26,7 +26,7 @@
- $ref: 'oas.yaml#/components/parameters/Name'
get:
summary: TODO list user details
description: 'levels: read, write, maintain, dev get their own information without a name property specified, level: admin can get any user using the name parameter'
description: 'Auth: basic, levels: read, write, maintain, dev get their own information without a name property specified, level: admin can get any user using the name parameter'
tags:
- /user
security:
@ -52,9 +52,11 @@
$ref: 'oas.yaml#/components/responses/500'
put:
summary: TODO change user details
description: 'levels: read, write, maintain, dev can change their own information (except level) without a name property specified, level: admin can change any user using the name parameter'
description: 'Auth: basic, levels: read, write, maintain, dev can change their own information (except level) without a name property specified, level: admin can change any user using the name parameter'
tags:
- /user
security:
- BasicAuth: []
requestBody:
required: true
content:
@ -82,9 +84,11 @@
$ref: 'oas.yaml#/components/responses/500'
delete:
summary: TODO delete user
description: 'levels: read, write, maintain, dev can delete their own account, level: admin can delete any user using the name parameter'
description: 'Auth: basic, levels: read, write, maintain, dev can delete their own account, level: admin can delete any user using the name parameter'
tags:
- /user
security:
- BasicAuth: []
responses:
200:
$ref: 'oas.yaml#/components/responses/Ok'
@ -101,7 +105,7 @@
/user/key:
get:
summary: TODO get API key for the user
description: 'levels: read, write, maintain, dev, admin'
description: 'Auth: basic, levels: read, write, maintain, dev, admin'
tags:
- /user
security:
@ -120,7 +124,7 @@
/user/new:
post:
summary: TODO add new user
description: 'levels: admin'
description: 'Auth: basic, levels: admin'
tags:
- /user
security:
@ -157,6 +161,7 @@
/user/passreset:
post:
summary: TODO reset password and send mail to restore
description: 'Auth: none'
tags:
- /user
security: []