spawntree
/
matsen-tool-be
2
0
Forkuj 0
Kod Zgłoszenia 0 Oczekujące zmiany 0 Wydania 0 Wiki Aktywność
Przeglądaj źródła

openapi

master
Florian Eisenmenger 1 rok temu
rodzic
9ed7679520
commit
9e4093ac9d
2 zmienionych plików z 712 dodań i 18 usunięć
Widok podzielony
Opcje porównania
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania
  1. +1
    -1
      export/openapi.json
  2. +711
    -17
      export/openapi.yaml

+ 1
- 1
export/openapi.json
Plik diff jest za duży
Wyświetl plik


+ 711
- 17
export/openapi.yaml Wyświetl plik

@@ -500,6 +500,244 @@ paths:
required: true
deprecated: false
parameters: []
/api/documents:
get:
operationId: api_documents_get_collection
tags:
- Document
responses:
200:
description: 'Document collection'
content:
application/ld+json:
schema:
type: object
properties:
'hydra:member': { type: array, items: { $ref: '#/components/schemas/Document.jsonld-document_object.read' } }
'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/Document-document_object.read'
text/html:
schema:
type: array
items:
$ref: '#/components/schemas/Document-document_object.read'
application/hal+json:
schema:
type: object
properties:
_embedded: { type: array, items: { $ref: '#/components/schemas/Document.jsonhal-document_object.read' } }
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 Document resources.'
description: 'Retrieves the collection of Document 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
-
name: partner
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: string
style: form
explode: false
allowReserved: false
-
name: 'partner[]'
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: array
items:
type: string
style: form
explode: true
allowReserved: false
-
name: product
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: string
style: form
explode: false
allowReserved: false
-
name: 'product[]'
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: array
items:
type: string
style: form
explode: true
allowReserved: false
deprecated: false
post:
operationId: api_documents_post
tags:
- Document
responses:
201:
description: 'Document resource created'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Document.jsonld-document_object.read'
application/json:
schema:
$ref: '#/components/schemas/Document-document_object.read'
text/html:
schema:
$ref: '#/components/schemas/Document-document_object.read'
application/hal+json:
schema:
$ref: '#/components/schemas/Document.jsonhal-document_object.read'
links: { }
400:
description: 'Invalid input'
422:
description: 'Unprocessable entity'
summary: 'Creates a Document resource.'
description: 'Creates a Document resource.'
parameters: []
requestBody:
description: ''
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
partner:
type: string
format: iri_reference
example: 'https://example.com/'
product:
type: string
format: iri_reference
example: 'https://example.com/'
required: false
deprecated: false
parameters: []
'/api/documents/{id}':
get:
operationId: api_documents_id_get
tags:
- Document
responses:
200:
description: 'Document resource'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Document.jsonld-document_object.read'
application/json:
schema:
$ref: '#/components/schemas/Document-document_object.read'
text/html:
schema:
$ref: '#/components/schemas/Document-document_object.read'
application/hal+json:
schema:
$ref: '#/components/schemas/Document.jsonhal-document_object.read'
404:
description: 'Resource not found'
summary: 'Retrieves a Document resource.'
description: 'Retrieves a Document resource.'
parameters:
-
name: id
in: path
description: 'DocumentObject identifier'
required: true
deprecated: false
allowEmptyValue: false
schema:
type: string
style: simple
explode: false
allowReserved: false
deprecated: false
delete:
operationId: api_documents_id_delete
tags:
- Document
responses:
204:
description: 'Document resource deleted'
404:
description: 'Resource not found'
summary: 'Removes the Document resource.'
description: 'Removes the Document resource.'
parameters:
-
name: id
in: path
description: 'DocumentObject identifier'
required: true
deprecated: false
allowEmptyValue: false
schema:
type: string
style: simple
explode: false
allowReserved: false
deprecated: false
parameters: []
/api/medias:
get:
operationId: api_medias_get_collection
@@ -613,36 +851,245 @@ paths:
required: false
deprecated: false
parameters: []
'/api/medias/{id}':
'/api/medias/{id}':
get:
operationId: api_medias_id_get
tags:
- Media
responses:
200:
description: 'Media resource'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Media.jsonld-media_object.read'
application/json:
schema:
$ref: '#/components/schemas/Media-media_object.read'
text/html:
schema:
$ref: '#/components/schemas/Media-media_object.read'
application/hal+json:
schema:
$ref: '#/components/schemas/Media.jsonhal-media_object.read'
404:
description: 'Resource not found'
summary: 'Retrieves a Media resource.'
description: 'Retrieves a Media resource.'
parameters:
-
name: id
in: path
description: 'MediaObject identifier'
required: true
deprecated: false
allowEmptyValue: false
schema:
type: string
style: simple
explode: false
allowReserved: false
deprecated: false
delete:
operationId: api_medias_id_delete
tags:
- Media
responses:
204:
description: 'Media resource deleted'
404:
description: 'Resource not found'
summary: 'Removes the Media resource.'
description: 'Removes the Media resource.'
parameters:
-
name: id
in: path
description: 'MediaObject identifier'
required: true
deprecated: false
allowEmptyValue: false
schema:
type: string
style: simple
explode: false
allowReserved: false
deprecated: false
parameters: []
/api/partner_follows:
get:
operationId: api_partner_follows_get_collection
tags:
- PartnerFollow
responses:
200:
description: 'PartnerFollow collection'
content:
application/ld+json:
schema:
type: object
properties:
'hydra:member': { type: array, items: { $ref: '#/components/schemas/PartnerFollow.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/PartnerFollow'
text/html:
schema:
type: array
items:
$ref: '#/components/schemas/PartnerFollow'
application/hal+json:
schema:
type: object
properties:
_embedded: { type: array, items: { $ref: '#/components/schemas/PartnerFollow.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 PartnerFollow resources.'
description: 'Retrieves the collection of PartnerFollow 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
-
name: partner
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: string
style: form
explode: false
allowReserved: false
-
name: 'partner[]'
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: array
items:
type: string
style: form
explode: true
allowReserved: false
deprecated: false
post:
operationId: api_partner_follows_post
tags:
- PartnerFollow
responses:
201:
description: 'PartnerFollow resource created'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/PartnerFollow.jsonld'
application/json:
schema:
$ref: '#/components/schemas/PartnerFollow'
text/html:
schema:
$ref: '#/components/schemas/PartnerFollow'
application/hal+json:
schema:
$ref: '#/components/schemas/PartnerFollow.jsonhal'
links: { }
400:
description: 'Invalid input'
422:
description: 'Unprocessable entity'
summary: 'Creates a PartnerFollow resource.'
description: 'Creates a PartnerFollow resource.'
parameters: []
requestBody:
description: 'The new PartnerFollow resource'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/PartnerFollow.jsonld'
application/json:
schema:
$ref: '#/components/schemas/PartnerFollow'
text/html:
schema:
$ref: '#/components/schemas/PartnerFollow'
application/hal+json:
schema:
$ref: '#/components/schemas/PartnerFollow.jsonhal'
required: true
deprecated: false
parameters: []
'/api/partner_follows/{id}':
get:
operationId: api_medias_id_get
operationId: api_partner_follows_id_get
tags:
- Media
- PartnerFollow
responses:
200:
description: 'Media resource'
description: 'PartnerFollow resource'
content:
application/ld+json:
schema:
$ref: '#/components/schemas/Media.jsonld-media_object.read'
$ref: '#/components/schemas/PartnerFollow.jsonld'
application/json:
schema:
$ref: '#/components/schemas/Media-media_object.read'
$ref: '#/components/schemas/PartnerFollow'
text/html:
schema:
$ref: '#/components/schemas/Media-media_object.read'
$ref: '#/components/schemas/PartnerFollow'
application/hal+json:
schema:
$ref: '#/components/schemas/Media.jsonhal-media_object.read'
$ref: '#/components/schemas/PartnerFollow.jsonhal'
404:
description: 'Resource not found'
summary: 'Retrieves a Media resource.'
description: 'Retrieves a Media resource.'
summary: 'Retrieves a PartnerFollow resource.'
description: 'Retrieves a PartnerFollow resource.'
parameters:
-
name: id
in: path
description: 'MediaObject identifier'
description: 'PartnerFollowApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -653,21 +1100,21 @@ paths:
allowReserved: false
deprecated: false
delete:
operationId: api_medias_id_delete
operationId: api_partner_follows_id_delete
tags:
- Media
- PartnerFollow
responses:
204:
description: 'Media resource deleted'
description: 'PartnerFollow resource deleted'
404:
description: 'Resource not found'
summary: 'Removes the Media resource.'
description: 'Removes the Media resource.'
summary: 'Removes the PartnerFollow resource.'
description: 'Removes the PartnerFollow resource.'
parameters:
-
name: id
in: path
description: 'MediaObject identifier'
description: 'PartnerFollowApi identifier'
required: true
deprecated: false
allowEmptyValue: false
@@ -2488,6 +2935,30 @@ paths:
style: form
explode: false
allowReserved: false
-
name: firstName
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: string
style: form
explode: false
allowReserved: false
-
name: lastName
in: query
description: ''
required: false
deprecated: false
allowEmptyValue: true
schema:
type: string
style: form
explode: false
allowReserved: false
deprecated: false
post:
operationId: api_users_post
@@ -3045,6 +3516,77 @@ components:
- string
- 'null'
format: date-time
Document-document_object.read:
type: object
description: ''
deprecated: false
externalDocs:
url: 'https://schema.org/MediaObject'
properties:
contentUrl:
externalDocs:
url: 'https://schema.org/contentUrl'
type:
- string
- 'null'
Document.jsonhal-document_object.read:
type: object
description: ''
deprecated: false
externalDocs:
url: 'https://schema.org/MediaObject'
properties:
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
format: iri-reference
contentUrl:
externalDocs:
url: 'https://schema.org/contentUrl'
type:
- string
- 'null'
Document.jsonld-document_object.read:
type: object
description: ''
deprecated: false
externalDocs:
url: 'https://schema.org/MediaObject'
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
contentUrl:
externalDocs:
url: 'https://schema.org/contentUrl'
type:
- string
- 'null'
Media-media_object.read:
type: object
description: ''
@@ -3361,6 +3903,152 @@ components:
type: string
format: iri-reference
example: 'https://example.com/'
PartnerFollow:
type: object
description: ''
deprecated: false
properties:
user:
readOnly: true
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
userName:
readOnly: true
type:
- string
- 'null'
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
partnerName:
readOnly: true
type:
- string
- 'null'
createdAt:
readOnly: true
type:
- string
- 'null'
format: date-time
required:
- partner
PartnerFollow.jsonhal:
type: object
description: ''
deprecated: false
properties:
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
format: iri-reference
user:
readOnly: true
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
userName:
readOnly: true
type:
- string
- 'null'
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
partnerName:
readOnly: true
type:
- string
- 'null'
createdAt:
readOnly: true
type:
- string
- 'null'
format: date-time
required:
- partner
PartnerFollow.jsonld:
type: object
description: ''
deprecated: false
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
user:
readOnly: true
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
userName:
readOnly: true
type:
- string
- 'null'
partner:
'owl:maxCardinality': 1
type:
- string
- 'null'
format: iri-reference
example: 'https://example.com/'
partnerName:
readOnly: true
type:
- string
- 'null'
createdAt:
readOnly: true
type:
- string
- 'null'
format: date-time
required:
- partner
Post:
type: object
description: ''
@@ -3412,6 +4100,7 @@ components:
format: iri-reference
example: 'https://example.com/'
comments:
readOnly: true
description: 'array<int, CommentApi>'
type: array
items:
@@ -3535,6 +4224,7 @@ components:
format: iri-reference
example: 'https://example.com/'
comments:
readOnly: true
description: 'array<int, CommentApi>'
type: array
items:
@@ -3665,6 +4355,7 @@ components:
format: iri-reference
example: 'https://example.com/'
comments:
readOnly: true
description: 'array<int, CommentApi>'
type: array
items:
@@ -4242,6 +4933,7 @@ components:
- boolean
- 'null'
taskNotes:
readOnly: true
description: 'array<int, TaskNoteApi>'
type: array
items:
@@ -4346,6 +5038,7 @@ components:
- boolean
- 'null'
taskNotes:
readOnly: true
description: 'array<int, TaskNoteApi>'
type: array
items:
@@ -4464,6 +5157,7 @@ components:
- boolean
- 'null'
taskNotes:
readOnly: true
description: 'array<int, TaskNoteApi>'
type: array
items:


Napisz Podgląd
Ładowanie…
Anuluj
Zapisz