spawntree
/
matsen-tool-be
2
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

openapi

master
Florian Eisenmenger 2 years ago
parent
e9a55ab7f5
commit
5a26a374f4
2 changed files with 186 additions and 47 deletions
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. +1
    -1
      export/openapi.json
  2. +185
    -46
      export/openapi.yaml

+ 1
- 1
export/openapi.json
File diff suppressed because it is too large
View File


+ 185
- 46
export/openapi.yaml View File

@@ -500,20 +500,20 @@ paths:
required: true required: true
deprecated: false deprecated: false
parameters: [] parameters: []
/api/media_objects:
/api/medias:
get: get:
operationId: api_media_objects_get_collection
operationId: api_medias_get_collection
tags: tags:
- MediaObject
- Media
responses: responses:
200: 200:
description: 'MediaObject collection'
description: 'Media collection'
content: content:
application/ld+json: application/ld+json:
schema: schema:
type: object type: object
properties: properties:
'hydra:member': { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonld-media_object.read' } }
'hydra:member': { type: array, items: { $ref: '#/components/schemas/Media.jsonld-media_object.read' } }
'hydra:totalItems': { type: integer, minimum: 0 } '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: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 } } } } } } '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 } } } } } }
@@ -523,25 +523,25 @@ paths:
schema: schema:
type: array type: array
items: items:
$ref: '#/components/schemas/MediaObject-media_object.read'
$ref: '#/components/schemas/Media-media_object.read'
text/html: text/html:
schema: schema:
type: array type: array
items: items:
$ref: '#/components/schemas/MediaObject-media_object.read'
$ref: '#/components/schemas/Media-media_object.read'
application/hal+json: application/hal+json:
schema: schema:
type: object type: object
properties: properties:
_embedded: { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read' } }
_embedded: { type: array, items: { $ref: '#/components/schemas/Media.jsonhal-media_object.read' } }
totalItems: { type: integer, minimum: 0 } totalItems: { type: integer, minimum: 0 }
itemsPerPage: { 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 } } } } } _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: required:
- _links - _links
- _embedded - _embedded
summary: 'Retrieves the collection of MediaObject resources.'
description: 'Retrieves the collection of MediaObject resources.'
summary: 'Retrieves the collection of Media resources.'
description: 'Retrieves the collection of Media resources.'
parameters: parameters:
- -
name: page name: page
@@ -573,32 +573,32 @@ paths:
allowReserved: false allowReserved: false
deprecated: false deprecated: false
post: post:
operationId: api_media_objects_post
operationId: api_medias_post
tags: tags:
- MediaObject
- Media
responses: responses:
201: 201:
description: 'MediaObject resource created'
description: 'Media resource created'
content: content:
application/ld+json: application/ld+json:
schema: schema:
$ref: '#/components/schemas/MediaObject.jsonld-media_object.read'
$ref: '#/components/schemas/Media.jsonld-media_object.read'
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/MediaObject-media_object.read'
$ref: '#/components/schemas/Media-media_object.read'
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MediaObject-media_object.read'
$ref: '#/components/schemas/Media-media_object.read'
application/hal+json: application/hal+json:
schema: schema:
$ref: '#/components/schemas/MediaObject.jsonhal-media_object.read'
$ref: '#/components/schemas/Media.jsonhal-media_object.read'
links: { } links: { }
400: 400:
description: 'Invalid input' description: 'Invalid input'
422: 422:
description: 'Unprocessable entity' description: 'Unprocessable entity'
summary: 'Creates a MediaObject resource.'
description: 'Creates a MediaObject resource.'
summary: 'Creates a Media resource.'
description: 'Creates a Media resource.'
parameters: [] parameters: []
requestBody: requestBody:
description: '' description: ''
@@ -613,31 +613,31 @@ paths:
required: false required: false
deprecated: false deprecated: false
parameters: [] parameters: []
'/api/media_objects/{id}':
'/api/medias/{id}':
get: get:
operationId: api_media_objects_id_get
operationId: api_medias_id_get
tags: tags:
- MediaObject
- Media
responses: responses:
200: 200:
description: 'MediaObject resource'
description: 'Media resource'
content: content:
application/ld+json: application/ld+json:
schema: schema:
$ref: '#/components/schemas/MediaObject.jsonld-media_object.read'
$ref: '#/components/schemas/Media.jsonld-media_object.read'
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/MediaObject-media_object.read'
$ref: '#/components/schemas/Media-media_object.read'
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/MediaObject-media_object.read'
$ref: '#/components/schemas/Media-media_object.read'
application/hal+json: application/hal+json:
schema: schema:
$ref: '#/components/schemas/MediaObject.jsonhal-media_object.read'
$ref: '#/components/schemas/Media.jsonhal-media_object.read'
404: 404:
description: 'Resource not found' description: 'Resource not found'
summary: 'Retrieves a MediaObject resource.'
description: 'Retrieves a MediaObject resource.'
summary: 'Retrieves a Media resource.'
description: 'Retrieves a Media resource.'
parameters: parameters:
- -
name: id name: id
@@ -1114,16 +1114,16 @@ paths:
content: content:
application/ld+json: application/ld+json:
schema: schema:
$ref: '#/components/schemas/Post.jsonld'
$ref: '#/components/schemas/Post.jsonld-posting_create'
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/Post'
$ref: '#/components/schemas/Post-posting_create'
text/html: text/html:
schema: schema:
$ref: '#/components/schemas/Post'
$ref: '#/components/schemas/Post-posting_create'
application/hal+json: application/hal+json:
schema: schema:
$ref: '#/components/schemas/Post.jsonhal'
$ref: '#/components/schemas/Post.jsonhal-posting_create'
required: true required: true
deprecated: false deprecated: false
parameters: [] parameters: []
@@ -1238,7 +1238,7 @@ paths:
content: content:
application/merge-patch+json: application/merge-patch+json:
schema: schema:
$ref: '#/components/schemas/Post'
$ref: '#/components/schemas/Post-posting_patch'
required: true required: true
deprecated: false deprecated: false
parameters: [] parameters: []
@@ -1500,6 +1500,7 @@ components:
- string - string
- 'null' - 'null'
owner: owner:
readOnly: true
'owl:maxCardinality': 1 'owl:maxCardinality': 1
type: type:
- string - string
@@ -1511,7 +1512,7 @@ components:
type: type:
- string - string
- 'null' - 'null'
posting:
post:
'owl:maxCardinality': 1 'owl:maxCardinality': 1
type: type:
- string - string
@@ -1545,6 +1546,7 @@ components:
- string - string
- 'null' - 'null'
owner: owner:
readOnly: true
'owl:maxCardinality': 1 'owl:maxCardinality': 1
type: type:
- string - string
@@ -1556,7 +1558,7 @@ components:
type: type:
- string - string
- 'null' - 'null'
posting:
post:
'owl:maxCardinality': 1 'owl:maxCardinality': 1
type: type:
- string - string
@@ -1604,6 +1606,7 @@ components:
- string - string
- 'null' - 'null'
owner: owner:
readOnly: true
'owl:maxCardinality': 1 'owl:maxCardinality': 1
type: type:
- string - string
@@ -1615,7 +1618,7 @@ components:
type: type:
- string - string
- 'null' - 'null'
posting:
post:
'owl:maxCardinality': 1 'owl:maxCardinality': 1
type: type:
- string - string
@@ -1635,6 +1638,7 @@ components:
required: required:
- firstName - firstName
- lastName - lastName
- partner
properties: properties:
firstName: firstName:
type: type:
@@ -1683,13 +1687,15 @@ components:
type: type:
- string - string
- 'null' - 'null'
postings:
posts:
readOnly: true
type: array type: array
items: items:
type: string type: string
format: iri-reference format: iri-reference
example: 'https://example.com/' example: 'https://example.com/'
createdAt: createdAt:
readOnly: true
type: type:
- string - string
- 'null' - 'null'
@@ -1701,6 +1707,7 @@ components:
required: required:
- firstName - firstName
- lastName - lastName
- partner
properties: properties:
_links: _links:
type: object type: object
@@ -1758,13 +1765,15 @@ components:
type: type:
- string - string
- 'null' - 'null'
postings:
posts:
readOnly: true
type: array type: array
items: items:
type: string type: string
format: iri-reference format: iri-reference
example: 'https://example.com/' example: 'https://example.com/'
createdAt: createdAt:
readOnly: true
type: type:
- string - string
- 'null' - 'null'
@@ -1776,6 +1785,7 @@ components:
required: required:
- firstName - firstName
- lastName - lastName
- partner
properties: properties:
'@context': '@context':
readOnly: true readOnly: true
@@ -1847,18 +1857,20 @@ components:
type: type:
- string - string
- 'null' - 'null'
postings:
posts:
readOnly: true
type: array type: array
items: items:
type: string type: string
format: iri-reference format: iri-reference
example: 'https://example.com/' example: 'https://example.com/'
createdAt: createdAt:
readOnly: true
type: type:
- string - string
- 'null' - 'null'
format: date-time format: date-time
MediaObject-media_object.read:
Media-media_object.read:
type: object type: object
description: '' description: ''
deprecated: false deprecated: false
@@ -1871,7 +1883,7 @@ components:
type: type:
- string - string
- 'null' - 'null'
MediaObject.jsonhal-media_object.read:
Media.jsonhal-media_object.read:
type: object type: object
description: '' description: ''
deprecated: false deprecated: false
@@ -1893,7 +1905,7 @@ components:
type: type:
- string - string
- 'null' - 'null'
MediaObject.jsonld-media_object.read:
Media.jsonld-media_object.read:
type: object type: object
description: '' description: ''
deprecated: false deprecated: false
@@ -1987,6 +1999,7 @@ components:
- 'null' - 'null'
format: date-time format: date-time
contacts: contacts:
readOnly: true
type: array type: array
items: items:
type: string type: string
@@ -2059,6 +2072,7 @@ components:
- 'null' - 'null'
format: date-time format: date-time
contacts: contacts:
readOnly: true
type: array type: array
items: items:
type: string type: string
@@ -2145,6 +2159,7 @@ components:
- 'null' - 'null'
format: date-time format: date-time
contacts: contacts:
readOnly: true
type: array type: array
items: items:
type: string type: string
@@ -2167,6 +2182,7 @@ components:
- string - string
- 'null' - 'null'
owner: owner:
readOnly: true
'owl:maxCardinality': 1 'owl:maxCardinality': 1
type: type:
- string - string
@@ -2193,6 +2209,7 @@ components:
format: iri-reference format: iri-reference
example: 'https://example.com/' example: 'https://example.com/'
comments: comments:
readOnly: true
type: array type: array
items: items:
$ref: '#/components/schemas/Comment' $ref: '#/components/schemas/Comment'
@@ -2202,6 +2219,52 @@ components:
- string - string
- 'null' - 'null'
format: date-time format: date-time
Post-posting_create:
type: object
description: ''
deprecated: false
required:
- headline
- message
properties:
headline:
type:
- string
- 'null'
message:
type:
- string
- 'null'
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/'
Post-posting_patch:
type: object
description: ''
deprecated: false
required:
- headline
- message
properties:
headline:
type:
- string
- 'null'
message:
type:
- string
- 'null'
Post.jsonhal: Post.jsonhal:
type: object type: object
description: '' description: ''
@@ -2228,6 +2291,7 @@ components:
- string - string
- 'null' - 'null'
owner: owner:
readOnly: true
'owl:maxCardinality': 1 'owl:maxCardinality': 1
type: type:
- string - string
@@ -2254,6 +2318,7 @@ components:
format: iri-reference format: iri-reference
example: 'https://example.com/' example: 'https://example.com/'
comments: comments:
readOnly: true
type: array type: array
items: items:
$ref: '#/components/schemas/Comment.jsonhal' $ref: '#/components/schemas/Comment.jsonhal'
@@ -2263,6 +2328,45 @@ components:
- string - string
- 'null' - 'null'
format: date-time format: date-time
Post.jsonhal-posting_create:
type: object
description: ''
deprecated: false
required:
- headline
- message
properties:
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
format: iri-reference
headline:
type:
- string
- 'null'
message:
type:
- string
- 'null'
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/'
Post.jsonld: Post.jsonld:
type: object type: object
description: '' description: ''
@@ -2303,6 +2407,7 @@ components:
- string - string
- 'null' - 'null'
owner: owner:
readOnly: true
'owl:maxCardinality': 1 'owl:maxCardinality': 1
type: type:
- string - string
@@ -2329,6 +2434,7 @@ components:
format: iri-reference format: iri-reference
example: 'https://example.com/' example: 'https://example.com/'
comments: comments:
readOnly: true
type: array type: array
items: items:
$ref: '#/components/schemas/Comment.jsonld' $ref: '#/components/schemas/Comment.jsonld'
@@ -2338,6 +2444,36 @@ components:
- string - string
- 'null' - 'null'
format: date-time format: date-time
Post.jsonld-posting_create:
type: object
description: ''
deprecated: false
required:
- headline
- message
properties:
headline:
type:
- string
- 'null'
message:
type:
- string
- 'null'
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/'
User: User:
type: object type: object
description: '' description: ''
@@ -2370,7 +2506,8 @@ components:
- 'null' - 'null'
active: active:
type: boolean type: boolean
postings:
posts:
readOnly: true
type: array type: array
items: items:
type: string type: string
@@ -2423,7 +2560,8 @@ components:
- 'null' - 'null'
active: active:
type: boolean type: boolean
postings:
posts:
readOnly: true
type: array type: array
items: items:
type: string type: string
@@ -2490,7 +2628,8 @@ components:
- 'null' - 'null'
active: active:
type: boolean type: boolean
postings:
posts:
readOnly: true
type: array type: array
items: items:
type: string type: string


Write Preview
Loading…
Cancel
Save