WIP: OAS3: Add endpoint for validation #3
1 changed files with 44 additions and 0 deletions
44
OAS3.yml
44
OAS3.yml
|
@ -200,6 +200,36 @@ paths:
|
|||
'404':
|
||||
$ref: '#/components/responses/NotFound'
|
||||
|
||||
/validate:
|
||||
parameters:
|
||||
- in: header
|
||||
name: Authentication
|
||||
schema:
|
||||
type: string
|
||||
description: Authentication token
|
||||
post:
|
||||
summary: Validate an entity
|
||||
tags:
|
||||
- entities
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: Entity JSON
|
||||
responses:
|
||||
'200':
|
||||
description: Validation result
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/validation'
|
||||
'400':
|
||||
$ref: '#/components/responses/InvalidInput'
|
||||
'401':
|
||||
$ref: '#/components/responses/AuthenticationRequired'
|
||||
'403':
|
||||
$ref: '#/components/responses/NotAllowed'
|
||||
components:
|
||||
schemas:
|
||||
health:
|
||||
|
@ -215,6 +245,20 @@ components:
|
|||
uptime:
|
||||
type: string
|
||||
example: ISO8601 conforming timespan
|
||||
validation:
|
||||
type: object
|
||||
properties:
|
||||
valid:
|
||||
type: boolean
|
||||
findings:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
field:
|
||||
type: string
|
||||
message:
|
||||
type: string
|
||||
responses:
|
||||
AuthenticationRequired:
|
||||
description: Authentication is required (401)
|
||||
|
|
Loading…
Reference in a new issue