spawntree
/
matsen-tool-be
2
0
Fork 0
Code Issues 0 Pull-Requests 0 Releases 0 Wiki Aktivität
Quellcode durchsuchen

openapi

master
Florian Eisenmenger vor 2 Jahren
Ursprung
8ef162ace6
Commit
8e3339bf23
2 geänderte Dateien mit 534 neuen und 26 gelöschten Zeilen
Geteilte Ansicht
Diff-Optionen
Statistiken anzeigen Patch-Datei herunterladen Vergleichs-Datei herunterladen
  1. +1
    -1
      export/openapi.json
  2. +533
    -25
      export/openapi.yaml

+ 1
- 1
export/openapi.json
Datei-Diff unterdrückt, da er zu groß ist
Datei anzeigen


+ 533
- 25
export/openapi.yaml Datei anzeigen

@@ -155,7 +155,7 @@ paths:
-
name: id
in: path
description: 'Comment identifier'
description: 'CommentApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -180,7 +180,7 @@ paths:
-
name: id
in: path
description: 'Comment identifier'
description: 'CommentApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -223,7 +223,7 @@ paths:
-
name: id
in: path
description: 'Comment identifier'
description: 'CommentApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -414,7 +414,7 @@ paths:
-
name: id
in: path
description: 'Contact identifier'
description: 'ContactApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -439,7 +439,7 @@ paths:
-
name: id
in: path
description: 'Contact identifier'
description: 'ContactApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -482,7 +482,7 @@ paths:
-
name: id
in: path
description: 'Contact identifier'
description: 'ContactApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -500,9 +500,9 @@ paths:
required: true
deprecated: false
parameters: []
/api/medias:
/api/media:
get:
operationId: api_medias_get_collection
operationId: api_media_get_collection
tags:
- Media
responses:
@@ -573,7 +573,7 @@ paths:
allowReserved: false
deprecated: false
post:
operationId: api_medias_post
operationId: api_media_post
tags:
- Media
responses:
@@ -613,9 +613,9 @@ paths:
required: false
deprecated: false
parameters: []
'/api/medias/{id}':
'/api/media/{id}':
get:
operationId: api_medias_id_get
operationId: api_media_id_get
tags:
- Media
responses:
@@ -642,7 +642,7 @@ paths:
-
name: id
in: path
description: 'Media identifier'
description: 'MediaObject identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -653,7 +653,7 @@ paths:
allowReserved: false
deprecated: false
delete:
operationId: api_medias_id_delete
operationId: api_media_id_delete
tags:
- Media
responses:
@@ -667,7 +667,7 @@ paths:
-
name: id
in: path
description: 'Media identifier'
description: 'MediaObject identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -896,7 +896,7 @@ paths:
-
name: id
in: path
description: 'Partner identifier'
description: 'PartnerApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -921,7 +921,7 @@ paths:
-
name: id
in: path
description: 'Partner identifier'
description: 'PartnerApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -964,7 +964,7 @@ paths:
-
name: id
in: path
description: 'Partner identifier'
description: 'PartnerApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -1181,7 +1181,7 @@ paths:
-
name: id
in: path
description: 'Post identifier'
description: 'PostingApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -1206,7 +1206,7 @@ paths:
-
name: id
in: path
description: 'Post identifier'
description: 'PostingApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -1249,7 +1249,7 @@ paths:
-
name: id
in: path
description: 'Post identifier'
description: 'PostingApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -1429,7 +1429,7 @@ paths:
-
name: id
in: path
description: 'Product identifier'
description: 'ProductApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -1454,7 +1454,7 @@ paths:
-
name: id
in: path
description: 'Product identifier'
description: 'ProductApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -1497,7 +1497,7 @@ paths:
-
name: id
in: path
description: 'Product identifier'
description: 'ProductApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -1515,6 +1515,239 @@ paths:
required: true
deprecated: false
parameters: []
/api/tasks:
get:
operationId: api_tasks_get_collection
tags:
- Task
responses:
200:
description: 'Task collection'
content:
application/ld+json:
schema:
type: object
properties:
'hydra:member': { type: array, items: { $ref: '#/components/schemas/Task.jsonld' } }
'hydra:totalItems': { type: integer, minimum: 0 }
'hydra:view': { type: object, properties: { '@id': { type: string, format: iri-reference }, '@type': { type: string }, 'hydra:first': { type: string, format: iri-reference }, 'hydra:last': { type: string, format: iri-reference }, 'hydra:previous': { type: string, format: iri-reference }, 'hydra:next': { type: string, format: iri-reference } }, example: { '@id': string, type: string, 'hydra:first': string, 'hydra:last': string, 'hydra:previous': string, 'hydra:next': string } }
'hydra:search': { type: object, properties: { '@type': { type: string }, 'hydra:template': { type: string }, 'hydra:variableRepresentation': { type: string }, 'hydra:mapping': { type: array, items: { type: object, properties: { '@type': { type: string }, variable: { type: string }, property: { type: [string, 'null'] }, required: { type: boolean } } } } } }
required:
- 'hydra:member'
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Task'
text/html:
schema:
type: array
items:
$ref: '#/components/schemas/Task'
application/hal+json:
schema:
type: object
properties:
_embedded: { type: array, items: { $ref: '#/components/schemas/Task.jsonhal' } }
totalItems: { type: integer, minimum: 0 }
itemsPerPage: { type: integer, minimum: 0 }
_links: { type: object, properties: { self: { type: object, properties: { href: { type: string, format: iri-reference } } }, first: { type: object, properties: { href: { type: string, format: iri-reference } } }, last: { type: object, properties: { href: { type: string, format: iri-reference } } }, next: { type: object, properties: { href: { type: string, format: iri-reference } } }, previous: { type: object, properties: { href: { type: string, format: iri-reference } } } } }
required:
- _links
- _embedded
summary: 'Retrieves the collection of Task resources.'
description: 'Retrieves the collection of Task resources.'
parameters:
-
name: page
in: query
description: 'The collection page number'
required: false
deprecated: false
allowEmptyValue: true
schema:
type: integer
default: 1
style: form
explode: false
allowReserved: false
-
name: itemsPerPage
in: query
description: 'The number of items per page'
required: false
deprecated: false
allowEmptyValue: true
schema:
type: integer
default: 10
minimum: 0
maximum: 50
style: form
explode: false
allowReserved: false
deprecated: false
post:
operationId: api_tasks_post
tags:
- Task
responses:
201:
description: 'Task resource created'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Task.jsonld'
application/json:
schema:
$ref: '#/components/schemas/Task'
text/html:
schema:
$ref: '#/components/schemas/Task'
application/hal+json:
schema:
$ref: '#/components/schemas/Task.jsonhal'
links: { }
400:
description: 'Invalid input'
422:
description: 'Unprocessable entity'
summary: 'Creates a Task resource.'
description: 'Creates a Task resource.'
parameters: []
requestBody:
description: 'The new Task resource'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Task.jsonld'
application/json:
schema:
$ref: '#/components/schemas/Task'
text/html:
schema:
$ref: '#/components/schemas/Task'
application/hal+json:
schema:
$ref: '#/components/schemas/Task.jsonhal'
required: true
deprecated: false
parameters: []
'/api/tasks/{id}':
get:
operationId: api_tasks_id_get
tags:
- Task
responses:
200:
description: 'Task resource'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Task.jsonld'
application/json:
schema:
$ref: '#/components/schemas/Task'
text/html:
schema:
$ref: '#/components/schemas/Task'
application/hal+json:
schema:
$ref: '#/components/schemas/Task.jsonhal'
404:
description: 'Resource not found'
summary: 'Retrieves a Task resource.'
description: 'Retrieves a Task resource.'
parameters:
-
name: id
in: path
description: 'TaskApi identifier'
required: true
deprecated: false
allowEmptyValue: false
schema:
type: string
style: simple
explode: false
allowReserved: false
deprecated: false
delete:
operationId: api_tasks_id_delete
tags:
- Task
responses:
204:
description: 'Task resource deleted'
404:
description: 'Resource not found'
summary: 'Removes the Task resource.'
description: 'Removes the Task resource.'
parameters:
-
name: id
in: path
description: 'TaskApi identifier'
required: true
deprecated: false
allowEmptyValue: false
schema:
type: string
style: simple
explode: false
allowReserved: false
deprecated: false
patch:
operationId: api_tasks_id_patch
tags:
- Task
responses:
200:
description: 'Task resource updated'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Task.jsonld'
application/json:
schema:
$ref: '#/components/schemas/Task'
text/html:
schema:
$ref: '#/components/schemas/Task'
application/hal+json:
schema:
$ref: '#/components/schemas/Task.jsonhal'
links: { }
400:
description: 'Invalid input'
422:
description: 'Unprocessable entity'
404:
description: 'Resource not found'
summary: 'Updates the Task resource.'
description: 'Updates the Task resource.'
parameters:
-
name: id
in: path
description: 'TaskApi identifier'
required: true
deprecated: false
allowEmptyValue: false
schema:
type: string
style: simple
explode: false
allowReserved: false
requestBody:
description: 'The updated Task resource'
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/Task'
required: true
deprecated: false
parameters: []
/api/users:
get:
operationId: api_users_get_collection
@@ -1662,7 +1895,7 @@ paths:
-
name: id
in: path
description: 'User identifier'
description: 'UserApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -1705,7 +1938,7 @@ paths:
-
name: id
in: path
description: 'User identifier'
description: 'UserApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -1774,6 +2007,7 @@ components:
- 'null'
owner:
readOnly: true
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -1785,6 +2019,7 @@ components:
- string
- 'null'
post:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -1818,6 +2053,7 @@ components:
- 'null'
owner:
readOnly: true
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -1829,6 +2065,7 @@ components:
- string
- 'null'
post:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -1876,6 +2113,7 @@ components:
- 'null'
owner:
readOnly: true
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -1887,6 +2125,7 @@ components:
- string
- 'null'
post:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -1916,6 +2155,7 @@ components:
- string
- 'null'
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -1926,6 +2166,7 @@ components:
- string
- 'null'
image:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -1991,6 +2232,7 @@ components:
- string
- 'null'
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2001,6 +2243,7 @@ components:
- string
- 'null'
image:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2080,6 +2323,7 @@ components:
- string
- 'null'
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2090,6 +2334,7 @@ components:
- string
- 'null'
image:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2240,6 +2485,7 @@ components:
- string
- 'null'
logo:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2313,6 +2559,7 @@ components:
- string
- 'null'
logo:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2400,6 +2647,7 @@ components:
- string
- 'null'
logo:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2441,6 +2689,7 @@ components:
- 'null'
owner:
readOnly: true
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2452,12 +2701,14 @@ components:
- string
- 'null'
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
contact:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2491,12 +2742,14 @@ components:
- string
- 'null'
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
contact:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2545,6 +2798,7 @@ components:
- 'null'
owner:
readOnly: true
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2556,12 +2810,14 @@ components:
- string
- 'null'
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
contact:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2604,12 +2860,14 @@ components:
- string
- 'null'
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
contact:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2656,6 +2914,7 @@ components:
- 'null'
owner:
readOnly: true
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2667,12 +2926,14 @@ components:
- string
- 'null'
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
contact:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2706,12 +2967,14 @@ components:
- string
- 'null'
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
contact:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2731,6 +2994,7 @@ components:
- string
- 'null'
image:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2769,6 +3033,7 @@ components:
- string
- 'null'
image:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2821,6 +3086,7 @@ components:
- string
- 'null'
image:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2836,6 +3102,245 @@ components:
- string
- 'null'
format: date-time
Task:
type: object
description: ''
deprecated: false
required:
- headline
- description
- assignedTo
- dueAt
- prio
properties:
headline:
type:
- string
- 'null'
description:
type:
- string
- 'null'
createdBy:
readOnly: true
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
assignedTo:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
dueAt:
type:
- string
- 'null'
format: date-time
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
contact:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
prio:
type: string
enum:
- low
- medium
- high
completed:
type:
- boolean
- 'null'
createdAt:
readOnly: true
type:
- string
- 'null'
format: date-time
Task.jsonhal:
type: object
description: ''
deprecated: false
required:
- headline
- description
- assignedTo
- dueAt
- prio
properties:
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
format: iri-reference
headline:
type:
- string
- 'null'
description:
type:
- string
- 'null'
createdBy:
readOnly: true
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
assignedTo:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
dueAt:
type:
- string
- 'null'
format: date-time
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
contact:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
prio:
type: string
enum:
- low
- medium
- high
completed:
type:
- boolean
- 'null'
createdAt:
readOnly: true
type:
- string
- 'null'
format: date-time
Task.jsonld:
type: object
description: ''
deprecated: false
required:
- headline
- description
- assignedTo
- dueAt
- prio
properties:
'@context':
readOnly: true
oneOf:
-
type: string
-
type: object
properties:
'@vocab':
type: string
hydra:
type: string
enum: ['http://www.w3.org/ns/hydra/core#']
required:
- '@vocab'
- hydra
additionalProperties: true
'@id':
readOnly: true
type: string
'@type':
readOnly: true
type: string
headline:
type:
- string
- 'null'
description:
type:
- string
- 'null'
createdBy:
readOnly: true
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
assignedTo:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
dueAt:
type:
- string
- 'null'
format: date-time
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
contact:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
prio:
type: string
enum:
- low
- medium
- high
completed:
type:
- boolean
- 'null'
createdAt:
readOnly: true
type:
- string
- 'null'
format: date-time
User:
type: object
description: ''
@@ -2861,6 +3366,7 @@ components:
- string
- 'null'
image:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2914,6 +3420,7 @@ components:
- string
- 'null'
image:
'owl:maxCardinality': 1
type:
- string
- 'null'
@@ -2981,6 +3488,7 @@ components:
- string
- 'null'
image:
'owl:maxCardinality': 1
type:
- string
- 'null'


Verfassen Vorschau
Laden…
Abbrechen
Speichern