|
- openapi: 3.1.0
- info:
- title: 'Matsen API Platform'
- description: ''
- version: 1.0.0
- servers:
- -
- url: /
- description: ''
- paths:
- /api/comments:
- get:
- operationId: api_comments_get_collection
- tags:
- - Comment
- responses:
- 200:
- description: 'Comment collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Comment.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/Comment'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Comment'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/Comment.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 Comment resources.'
- description: 'Retrieves the collection of Comment 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: posting
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'posting[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: owner
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'owner[]'
- 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_comments_post
- tags:
- - Comment
- responses:
- 201:
- description: 'Comment resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Comment.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Comment'
- text/html:
- schema:
- $ref: '#/components/schemas/Comment'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Comment.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a Comment resource.'
- description: 'Creates a Comment resource.'
- parameters: []
- requestBody:
- description: 'The new Comment resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Comment.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Comment'
- text/html:
- schema:
- $ref: '#/components/schemas/Comment'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Comment.jsonhal'
- required: true
- deprecated: false
- parameters: []
- '/api/comments/{id}':
- get:
- operationId: api_comments_id_get
- tags:
- - Comment
- responses:
- 200:
- description: 'Comment resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Comment.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Comment'
- text/html:
- schema:
- $ref: '#/components/schemas/Comment'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Comment.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a Comment resource.'
- description: 'Retrieves a Comment resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Comment identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_comments_id_patch
- tags:
- - Comment
- responses:
- 200:
- description: 'Comment resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Comment.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Comment'
- text/html:
- schema:
- $ref: '#/components/schemas/Comment'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Comment.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- 404:
- description: 'Resource not found'
- summary: 'Updates the Comment resource.'
- description: 'Updates the Comment resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Comment identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated Comment resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/Comment'
- required: true
- deprecated: false
- parameters: []
- /api/contact_partner_products:
- get:
- operationId: api_contact_partner_products_get_collection
- tags:
- - ContactPartnerProduct
- responses:
- 200:
- description: 'ContactPartnerProduct collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/ContactPartnerProduct.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/ContactPartnerProduct'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/ContactPartnerProduct'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/ContactPartnerProduct.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 ContactPartnerProduct resources.'
- description: 'Retrieves the collection of ContactPartnerProduct 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: contact
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'contact[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: partnerProduct.product.name
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[partnerProduct.product.name]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_contact_partner_products_post
- tags:
- - ContactPartnerProduct
- responses:
- 201:
- description: 'ContactPartnerProduct resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ContactPartnerProduct.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/ContactPartnerProduct'
- text/html:
- schema:
- $ref: '#/components/schemas/ContactPartnerProduct'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/ContactPartnerProduct.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a ContactPartnerProduct resource.'
- description: 'Creates a ContactPartnerProduct resource.'
- parameters: []
- requestBody:
- description: 'The new ContactPartnerProduct resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ContactPartnerProduct.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/ContactPartnerProduct'
- text/html:
- schema:
- $ref: '#/components/schemas/ContactPartnerProduct'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/ContactPartnerProduct.jsonhal'
- required: true
- deprecated: false
- parameters: []
- '/api/contact_partner_products/{id}':
- get:
- operationId: api_contact_partner_products_id_get
- tags:
- - ContactPartnerProduct
- responses:
- 200:
- description: 'ContactPartnerProduct resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/ContactPartnerProduct.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/ContactPartnerProduct'
- text/html:
- schema:
- $ref: '#/components/schemas/ContactPartnerProduct'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/ContactPartnerProduct.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a ContactPartnerProduct resource.'
- description: 'Retrieves a ContactPartnerProduct resource.'
- parameters:
- -
- name: id
- in: path
- description: 'ContactPartnerProduct identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_contact_partner_products_id_delete
- tags:
- - ContactPartnerProduct
- responses:
- 204:
- description: 'ContactPartnerProduct resource deleted'
- 404:
- description: 'Resource not found'
- summary: 'Removes the ContactPartnerProduct resource.'
- description: 'Removes the ContactPartnerProduct resource.'
- parameters:
- -
- name: id
- in: path
- description: 'ContactPartnerProduct identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- parameters: []
- /api/contacts:
- get:
- operationId: api_contacts_get_collection
- tags:
- - Contact
- responses:
- 200:
- description: 'Contact collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Contact.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/Contact'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Contact'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/Contact.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 Contact resources.'
- description: 'Retrieves the collection of Contact 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: nameSearch
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_contacts_post
- tags:
- - Contact
- responses:
- 201:
- description: 'Contact resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Contact.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Contact'
- text/html:
- schema:
- $ref: '#/components/schemas/Contact'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Contact.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a Contact resource.'
- description: 'Creates a Contact resource.'
- parameters: []
- requestBody:
- description: 'The new Contact resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Contact.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Contact'
- text/html:
- schema:
- $ref: '#/components/schemas/Contact'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Contact.jsonhal'
- required: true
- deprecated: false
- parameters: []
- '/api/contacts/{id}':
- get:
- operationId: api_contacts_id_get
- tags:
- - Contact
- responses:
- 200:
- description: 'Contact resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Contact.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Contact'
- text/html:
- schema:
- $ref: '#/components/schemas/Contact'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Contact.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a Contact resource.'
- description: 'Retrieves a Contact resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Contact identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_contacts_id_patch
- tags:
- - Contact
- responses:
- 200:
- description: 'Contact resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Contact.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Contact'
- text/html:
- schema:
- $ref: '#/components/schemas/Contact'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Contact.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- 404:
- description: 'Resource not found'
- summary: 'Updates the Contact resource.'
- description: 'Updates the Contact resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Contact identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated Contact resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/Contact'
- required: true
- deprecated: false
- parameters: []
- /api/document_objects:
- get:
- operationId: api_document_objects_get_collection
- tags:
- - DocumentObject
- responses:
- 200:
- description: 'DocumentObject collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/DocumentObject.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/DocumentObject-document_object.read'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/DocumentObject-document_object.read'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/DocumentObject.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 DocumentObject resources.'
- description: 'Retrieves the collection of DocumentObject 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_document_objects_post
- tags:
- - DocumentObject
- responses:
- 201:
- description: 'DocumentObject resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/DocumentObject.jsonld-document_object.read'
- application/json:
- schema:
- $ref: '#/components/schemas/DocumentObject-document_object.read'
- text/html:
- schema:
- $ref: '#/components/schemas/DocumentObject-document_object.read'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/DocumentObject.jsonhal-document_object.read'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a DocumentObject resource.'
- description: 'Creates a DocumentObject resource.'
- parameters: []
- requestBody:
- description: ''
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- file:
- type: string
- format: binary
- required: false
- deprecated: false
- parameters: []
- '/api/document_objects/{id}':
- get:
- operationId: api_document_objects_id_get
- tags:
- - DocumentObject
- responses:
- 200:
- description: 'DocumentObject resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/DocumentObject.jsonld-document_object.read'
- application/json:
- schema:
- $ref: '#/components/schemas/DocumentObject-document_object.read'
- text/html:
- schema:
- $ref: '#/components/schemas/DocumentObject-document_object.read'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/DocumentObject.jsonhal-document_object.read'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a DocumentObject resource.'
- description: 'Retrieves a DocumentObject 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_document_objects_id_delete
- tags:
- - DocumentObject
- responses:
- 204:
- description: 'DocumentObject resource deleted'
- 404:
- description: 'Resource not found'
- summary: 'Removes the DocumentObject resource.'
- description: 'Removes the DocumentObject 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/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' } }
- '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'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Document'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/Document.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 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: name
- 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: 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
- -
- name: 'order[name]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[partner.name]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[product.name]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- 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'
- application/json:
- schema:
- $ref: '#/components/schemas/Document'
- text/html:
- schema:
- $ref: '#/components/schemas/Document'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Document.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a Document resource.'
- description: 'Creates a Document resource.'
- parameters: []
- requestBody:
- description: 'The new Document resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Document.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Document'
- text/html:
- schema:
- $ref: '#/components/schemas/Document'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Document.jsonhal'
- required: true
- 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'
- application/json:
- schema:
- $ref: '#/components/schemas/Document'
- text/html:
- schema:
- $ref: '#/components/schemas/Document'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Document.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a Document resource.'
- description: 'Retrieves a Document resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Document identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_documents_id_patch
- tags:
- - Document
- responses:
- 200:
- description: 'Document resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Document.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Document'
- text/html:
- schema:
- $ref: '#/components/schemas/Document'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Document.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- 404:
- description: 'Resource not found'
- summary: 'Updates the Document resource.'
- description: 'Updates the Document resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Document identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated Document resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/Document'
- required: true
- deprecated: false
- parameters: []
- /api/media_objects:
- get:
- operationId: api_media_objects_get_collection
- tags:
- - MediaObject
- responses:
- 200:
- description: 'MediaObject collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonld-media_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/MediaObject-media_object.read'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/MediaObject-media_object.read'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/MediaObject.jsonhal-media_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 MediaObject resources.'
- description: 'Retrieves the collection of MediaObject 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_media_objects_post
- tags:
- - MediaObject
- responses:
- 201:
- description: 'MediaObject resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/MediaObject.jsonld-media_object.read'
- application/json:
- schema:
- $ref: '#/components/schemas/MediaObject-media_object.read'
- text/html:
- schema:
- $ref: '#/components/schemas/MediaObject-media_object.read'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a MediaObject resource.'
- description: 'Creates a MediaObject resource.'
- parameters: []
- requestBody:
- description: ''
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- file:
- type: string
- format: binary
- required: false
- deprecated: false
- parameters: []
- '/api/media_objects/{id}':
- get:
- operationId: api_media_objects_id_get
- tags:
- - MediaObject
- responses:
- 200:
- description: 'MediaObject resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/MediaObject.jsonld-media_object.read'
- application/json:
- schema:
- $ref: '#/components/schemas/MediaObject-media_object.read'
- text/html:
- schema:
- $ref: '#/components/schemas/MediaObject-media_object.read'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/MediaObject.jsonhal-media_object.read'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a MediaObject resource.'
- description: 'Retrieves a MediaObject 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_media_objects_id_delete
- tags:
- - MediaObject
- responses:
- 204:
- description: 'MediaObject resource deleted'
- 404:
- description: 'Resource not found'
- summary: 'Removes the MediaObject resource.'
- description: 'Removes the MediaObject 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
- -
- name: partner.name
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: user
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'user[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: partner.type
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'partner.type[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: 'order[partner.name]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[partner.city]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[partner.website]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- 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_partner_follows_id_get
- tags:
- - PartnerFollow
- responses:
- 200:
- description: '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'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a PartnerFollow resource.'
- description: 'Retrieves a PartnerFollow resource.'
- parameters:
- -
- name: id
- in: path
- description: 'PartnerFollow identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_partner_follows_id_delete
- tags:
- - PartnerFollow
- responses:
- 204:
- description: 'PartnerFollow resource deleted'
- 404:
- description: 'Resource not found'
- summary: 'Removes the PartnerFollow resource.'
- description: 'Removes the PartnerFollow resource.'
- parameters:
- -
- name: id
- in: path
- description: 'PartnerFollow identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- parameters: []
- /api/partner_products:
- get:
- operationId: api_partner_products_get_collection
- tags:
- - PartnerProduct
- responses:
- 200:
- description: 'PartnerProduct collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/PartnerProduct.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/PartnerProduct'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/PartnerProduct'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/PartnerProduct.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 PartnerProduct resources.'
- description: 'Retrieves the collection of PartnerProduct 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: partner.name
- 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: 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
- -
- name: product.name
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: partner.type
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'partner.type[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: excludeContactId
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[product.name]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[partner.name]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[partner.city]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[partner.website]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_partner_products_post
- tags:
- - PartnerProduct
- responses:
- 201:
- description: 'PartnerProduct resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/PartnerProduct.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/PartnerProduct'
- text/html:
- schema:
- $ref: '#/components/schemas/PartnerProduct'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/PartnerProduct.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a PartnerProduct resource.'
- description: 'Creates a PartnerProduct resource.'
- parameters: []
- requestBody:
- description: 'The new PartnerProduct resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/PartnerProduct.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/PartnerProduct'
- text/html:
- schema:
- $ref: '#/components/schemas/PartnerProduct'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/PartnerProduct.jsonhal'
- required: true
- deprecated: false
- parameters: []
- '/api/partner_products/{id}':
- get:
- operationId: api_partner_products_id_get
- tags:
- - PartnerProduct
- responses:
- 200:
- description: 'PartnerProduct resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/PartnerProduct.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/PartnerProduct'
- text/html:
- schema:
- $ref: '#/components/schemas/PartnerProduct'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/PartnerProduct.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a PartnerProduct resource.'
- description: 'Retrieves a PartnerProduct resource.'
- parameters:
- -
- name: id
- in: path
- description: 'PartnerProduct identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_partner_products_id_delete
- tags:
- - PartnerProduct
- responses:
- 204:
- description: 'PartnerProduct resource deleted'
- 404:
- description: 'Resource not found'
- summary: 'Removes the PartnerProduct resource.'
- description: 'Removes the PartnerProduct resource.'
- parameters:
- -
- name: id
- in: path
- description: 'PartnerProduct identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- parameters: []
- /api/partners:
- get:
- operationId: api_partners_get_collection
- tags:
- - Partner
- responses:
- 200:
- description: 'Partner collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Partner.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/Partner'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Partner'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/Partner.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 Partner resources.'
- description: 'Retrieves the collection of Partner 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: type
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'type[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: name
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: excludeProductId
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[name]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[city]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[website]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_partners_post
- tags:
- - Partner
- responses:
- 201:
- description: 'Partner resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Partner.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Partner'
- text/html:
- schema:
- $ref: '#/components/schemas/Partner'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Partner.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a Partner resource.'
- description: 'Creates a Partner resource.'
- parameters: []
- requestBody:
- description: 'The new Partner resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Partner.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Partner'
- text/html:
- schema:
- $ref: '#/components/schemas/Partner'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Partner.jsonhal'
- required: true
- deprecated: false
- parameters: []
- '/api/partners/{id}':
- get:
- operationId: api_partners_id_get
- tags:
- - Partner
- responses:
- 200:
- description: 'Partner resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Partner.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Partner'
- text/html:
- schema:
- $ref: '#/components/schemas/Partner'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Partner.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a Partner resource.'
- description: 'Retrieves a Partner resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Partner identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_partners_id_patch
- tags:
- - Partner
- responses:
- 200:
- description: 'Partner resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Partner.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Partner'
- text/html:
- schema:
- $ref: '#/components/schemas/Partner'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Partner.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- 404:
- description: 'Resource not found'
- summary: 'Updates the Partner resource.'
- description: 'Updates the Partner resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Partner identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated Partner resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/Partner'
- required: true
- deprecated: false
- parameters: []
- /api/posts:
- get:
- operationId: api_posts_get_collection
- tags:
- - Post
- responses:
- 200:
- description: 'Post collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Post.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/Post'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Post'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/Post.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 Post resources.'
- description: 'Retrieves the collection of Post 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: contact
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'contact[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: sale
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'sale[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: owner
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'owner[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- allowReserved: false
- -
- name: 'exists[contact]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: boolean
- style: form
- explode: false
- allowReserved: false
- -
- name: 'exists[sale]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: boolean
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_posts_post
- tags:
- - Post
- responses:
- 201:
- description: 'Post resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Post.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Post'
- text/html:
- schema:
- $ref: '#/components/schemas/Post'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Post.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a Post resource.'
- description: 'Creates a Post resource.'
- parameters: []
- requestBody:
- description: 'The new Post resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Post.jsonld-posting.create'
- application/json:
- schema:
- $ref: '#/components/schemas/Post-posting.create'
- text/html:
- schema:
- $ref: '#/components/schemas/Post-posting.create'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Post.jsonhal-posting.create'
- required: true
- deprecated: false
- parameters: []
- '/api/posts/{id}':
- get:
- operationId: api_posts_id_get
- tags:
- - Post
- responses:
- 200:
- description: 'Post resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Post.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Post'
- text/html:
- schema:
- $ref: '#/components/schemas/Post'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Post.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a Post resource.'
- description: 'Retrieves a Post resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Post identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_posts_id_patch
- tags:
- - Post
- responses:
- 200:
- description: 'Post resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Post.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Post'
- text/html:
- schema:
- $ref: '#/components/schemas/Post'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Post.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- 404:
- description: 'Resource not found'
- summary: 'Updates the Post resource.'
- description: 'Updates the Post resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Post identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated Post resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/Post-posting.patch'
- required: true
- deprecated: false
- parameters: []
- /api/products:
- get:
- operationId: api_products_get_collection
- tags:
- - Product
- responses:
- 200:
- description: 'Product collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Product.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/Product'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Product'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/Product.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 Product resources.'
- description: 'Retrieves the collection of Product 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: name
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: excludePartnerId
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[name]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_products_post
- tags:
- - Product
- responses:
- 201:
- description: 'Product resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Product.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Product'
- text/html:
- schema:
- $ref: '#/components/schemas/Product'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Product.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a Product resource.'
- description: 'Creates a Product resource.'
- parameters: []
- requestBody:
- description: 'The new Product resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Product.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Product'
- text/html:
- schema:
- $ref: '#/components/schemas/Product'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Product.jsonhal'
- required: true
- deprecated: false
- parameters: []
- '/api/products/{id}':
- get:
- operationId: api_products_id_get
- tags:
- - Product
- responses:
- 200:
- description: 'Product resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Product.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Product'
- text/html:
- schema:
- $ref: '#/components/schemas/Product'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Product.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a Product resource.'
- description: 'Retrieves a Product resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Product identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_products_id_patch
- tags:
- - Product
- responses:
- 200:
- description: 'Product resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Product.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Product'
- text/html:
- schema:
- $ref: '#/components/schemas/Product'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Product.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- 404:
- description: 'Resource not found'
- summary: 'Updates the Product resource.'
- description: 'Updates the Product resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Product identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated Product resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/Product'
- required: true
- deprecated: false
- parameters: []
- /api/sale_summaries:
- get:
- operationId: api_sale_summaries_get_collection
- tags:
- - SaleSummary
- responses:
- 200:
- description: 'SaleSummary collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/SaleSummary.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/SaleSummary'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/SaleSummary'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/SaleSummary.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 SaleSummary resources.'
- description: 'Retrieves the collection of SaleSummary 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
- parameters: []
- '/api/sale_summaries/{userId}':
- get:
- operationId: api_sale_summaries_userId_get
- tags:
- - SaleSummary
- responses:
- 200:
- description: 'SaleSummary resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/SaleSummary.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/SaleSummary'
- text/html:
- schema:
- $ref: '#/components/schemas/SaleSummary'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/SaleSummary.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a SaleSummary resource.'
- description: 'Retrieves a SaleSummary resource.'
- parameters:
- -
- name: userId
- in: path
- description: 'SaleSummary identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- parameters: []
- /api/sales:
- get:
- operationId: api_sales_get_collection
- tags:
- - Sale
- responses:
- 200:
- description: 'Sale collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/Sale.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/Sale'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Sale'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/Sale.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 Sale resources.'
- description: 'Retrieves the collection of Sale 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: owner
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'owner[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- 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
- -
- name: 'order[owner.lastName]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[partner.name]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[product.name]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[turnover]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[profit]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[createdAt]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_sales_post
- tags:
- - Sale
- responses:
- 201:
- description: 'Sale resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Sale.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Sale'
- text/html:
- schema:
- $ref: '#/components/schemas/Sale'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Sale.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a Sale resource.'
- description: 'Creates a Sale resource.'
- parameters: []
- requestBody:
- description: 'The new Sale resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Sale.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Sale'
- text/html:
- schema:
- $ref: '#/components/schemas/Sale'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Sale.jsonhal'
- required: true
- deprecated: false
- parameters: []
- '/api/sales/{id}':
- get:
- operationId: api_sales_id_get
- tags:
- - Sale
- responses:
- 200:
- description: 'Sale resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Sale.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Sale'
- text/html:
- schema:
- $ref: '#/components/schemas/Sale'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Sale.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a Sale resource.'
- description: 'Retrieves a Sale resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Sale identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_sales_id_patch
- tags:
- - Sale
- responses:
- 200:
- description: 'Sale resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/Sale.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/Sale'
- text/html:
- schema:
- $ref: '#/components/schemas/Sale'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/Sale.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- 404:
- description: 'Resource not found'
- summary: 'Updates the Sale resource.'
- description: 'Updates the Sale resource.'
- parameters:
- -
- name: id
- in: path
- description: 'Sale identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated Sale resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/Sale'
- required: true
- deprecated: false
- parameters: []
- /api/task_notes:
- get:
- operationId: api_task_notes_get_collection
- tags:
- - TaskNote
- responses:
- 200:
- description: 'TaskNote collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/TaskNote.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/TaskNote'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/TaskNote'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/TaskNote.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 TaskNote resources.'
- description: 'Retrieves the collection of TaskNote 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: task
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'task[]'
- 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_task_notes_post
- tags:
- - TaskNote
- responses:
- 201:
- description: 'TaskNote resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/TaskNote.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/TaskNote'
- text/html:
- schema:
- $ref: '#/components/schemas/TaskNote'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/TaskNote.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a TaskNote resource.'
- description: 'Creates a TaskNote resource.'
- parameters: []
- requestBody:
- description: 'The new TaskNote resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/TaskNote.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/TaskNote'
- text/html:
- schema:
- $ref: '#/components/schemas/TaskNote'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/TaskNote.jsonhal'
- required: true
- deprecated: false
- parameters: []
- '/api/task_notes/{id}':
- get:
- operationId: api_task_notes_id_get
- tags:
- - TaskNote
- responses:
- 200:
- description: 'TaskNote resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/TaskNote.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/TaskNote'
- text/html:
- schema:
- $ref: '#/components/schemas/TaskNote'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/TaskNote.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a TaskNote resource.'
- description: 'Retrieves a TaskNote resource.'
- parameters:
- -
- name: id
- in: path
- description: 'TaskNote identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- patch:
- operationId: api_task_notes_id_patch
- tags:
- - TaskNote
- responses:
- 200:
- description: 'TaskNote resource updated'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/TaskNote.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/TaskNote'
- text/html:
- schema:
- $ref: '#/components/schemas/TaskNote'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/TaskNote.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- 404:
- description: 'Resource not found'
- summary: 'Updates the TaskNote resource.'
- description: 'Updates the TaskNote resource.'
- parameters:
- -
- name: id
- in: path
- description: 'TaskNote identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- requestBody:
- description: 'The updated TaskNote resource'
- content:
- application/merge-patch+json:
- schema:
- $ref: '#/components/schemas/TaskNote'
- 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
- -
- name: assignedTo
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'assignedTo[]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: array
- items:
- type: string
- style: form
- explode: true
- 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: contact
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'contact[]'
- 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_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: 'Task 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: 'Task 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/user_products:
- get:
- operationId: api_user_products_get_collection
- tags:
- - UserProduct
- responses:
- 200:
- description: 'UserProduct collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/UserProduct.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/UserProduct'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/UserProduct'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/UserProduct.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 UserProduct resources.'
- description: 'Retrieves the collection of UserProduct 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: user
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'user[]'
- 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
- -
- name: 'order[product.name]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_user_products_post
- tags:
- - UserProduct
- responses:
- 201:
- description: 'UserProduct resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserProduct.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/UserProduct'
- text/html:
- schema:
- $ref: '#/components/schemas/UserProduct'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/UserProduct.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a UserProduct resource.'
- description: 'Creates a UserProduct resource.'
- parameters: []
- requestBody:
- description: 'The new UserProduct resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserProduct.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/UserProduct'
- text/html:
- schema:
- $ref: '#/components/schemas/UserProduct'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/UserProduct.jsonhal'
- required: true
- deprecated: false
- parameters: []
- '/api/user_products/{id}':
- get:
- operationId: api_user_products_id_get
- tags:
- - UserProduct
- responses:
- 200:
- description: 'UserProduct resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/UserProduct.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/UserProduct'
- text/html:
- schema:
- $ref: '#/components/schemas/UserProduct'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/UserProduct.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a UserProduct resource.'
- description: 'Retrieves a UserProduct resource.'
- parameters:
- -
- name: id
- in: path
- description: 'UserProduct identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- delete:
- operationId: api_user_products_id_delete
- tags:
- - UserProduct
- responses:
- 204:
- description: 'UserProduct resource deleted'
- 404:
- description: 'Resource not found'
- summary: 'Removes the UserProduct resource.'
- description: 'Removes the UserProduct resource.'
- parameters:
- -
- name: id
- in: path
- description: 'UserProduct identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- parameters: []
- /api/users:
- get:
- operationId: api_users_get_collection
- tags:
- - User
- responses:
- 200:
- description: 'User collection'
- content:
- application/ld+json:
- schema:
- type: object
- properties:
- 'hydra:member': { type: array, items: { $ref: '#/components/schemas/User.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/User'
- text/html:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/User'
- application/hal+json:
- schema:
- type: object
- properties:
- _embedded: { type: array, items: { $ref: '#/components/schemas/User.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 User resources.'
- description: 'Retrieves the collection of User 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: 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
- -
- name: nameSearch
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[firstName]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- -
- name: 'order[lastName]'
- in: query
- description: ''
- required: false
- deprecated: false
- allowEmptyValue: true
- schema:
- type: string
- enum:
- - asc
- - desc
- style: form
- explode: false
- allowReserved: false
- deprecated: false
- post:
- operationId: api_users_post
- tags:
- - User
- responses:
- 201:
- description: 'User resource created'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/User.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/User'
- text/html:
- schema:
- $ref: '#/components/schemas/User'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/User.jsonhal'
- links: { }
- 400:
- description: 'Invalid input'
- 422:
- description: 'Unprocessable entity'
- summary: 'Creates a User resource.'
- description: 'Creates a User resource.'
- parameters: []
- requestBody:
- description: 'The new User resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/User.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/User'
- text/html:
- schema:
- $ref: '#/components/schemas/User'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/User.jsonhal'
- required: true
- deprecated: false
- parameters: []
- '/api/users/{id}':
- get:
- operationId: api_users_id_get
- tags:
- - User
- responses:
- 200:
- description: 'User resource'
- content:
- application/ld+json:
- schema:
- $ref: '#/components/schemas/User.jsonld'
- application/json:
- schema:
- $ref: '#/components/schemas/User'
- text/html:
- schema:
- $ref: '#/components/schemas/User'
- application/hal+json:
- schema:
- $ref: '#/components/schemas/User.jsonhal'
- 404:
- description: 'Resource not found'
- summary: 'Retrieves a User resource.'
- description: 'Retrieves a User resource.'
- parameters:
- -
- name: id
- in: path
- description: 'User identifier'
- required: true
- deprecated: false
- allowEmptyValue: false
- schema:
- type: string
- style: simple
- explode: false
- allowReserved: false
- deprecated: false
- parameters: []
- /auth:
- post:
- operationId: login_check_post
- tags:
- - 'Login Check'
- responses:
- 200:
- description: 'User token created'
- content:
- application/json:
- schema:
- type: object
- properties:
- token: { readOnly: true, type: string, nullable: false }
- required:
- - token
- summary: 'Creates a user token.'
- description: 'Creates a user token.'
- requestBody:
- description: 'The login data'
- content:
- application/json:
- schema:
- type: object
- properties:
- email:
- type: string
- nullable: false
- password:
- type: string
- nullable: false
- required:
- - email
- - password
- required: true
- parameters: []
- components:
- schemas:
- Comment:
- type: object
- description: ''
- deprecated: false
- required:
- - message
- properties:
- message:
- type:
- - string
- - 'null'
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User'
- postIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Comment.jsonhal:
- type: object
- description: ''
- deprecated: false
- required:
- - message
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- message:
- type:
- - string
- - 'null'
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonhal'
- postIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Comment.jsonld:
- type: object
- description: ''
- deprecated: false
- required:
- - message
- 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
- message:
- type:
- - string
- - 'null'
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonld'
- postIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Contact:
- type: object
- description: ''
- deprecated: false
- required:
- - firstName
- - lastName
- - partnerIri
- properties:
- firstName:
- type:
- - string
- - 'null'
- lastName:
- type:
- - string
- - 'null'
- fullName:
- type:
- - string
- - 'null'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- birthday:
- type:
- - string
- - 'null'
- format: date-time
- image:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- imageUrl:
- readOnly: true
- type:
- - string
- - 'null'
- position:
- type:
- - string
- - 'null'
- phone:
- type:
- - string
- - 'null'
- email:
- format: email
- externalDocs:
- url: 'https://schema.org/email'
- type:
- - string
- - 'null'
- posts:
- readOnly: true
- type: array
- items:
- type: string
- format: iri-reference
- example: 'https://example.com/'
- createdBy:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Contact.jsonhal:
- type: object
- description: ''
- deprecated: false
- required:
- - firstName
- - lastName
- - partnerIri
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- firstName:
- type:
- - string
- - 'null'
- lastName:
- type:
- - string
- - 'null'
- fullName:
- type:
- - string
- - 'null'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonhal'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- birthday:
- type:
- - string
- - 'null'
- format: date-time
- image:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- imageUrl:
- readOnly: true
- type:
- - string
- - 'null'
- position:
- type:
- - string
- - 'null'
- phone:
- type:
- - string
- - 'null'
- email:
- format: email
- externalDocs:
- url: 'https://schema.org/email'
- type:
- - string
- - 'null'
- posts:
- readOnly: true
- type: array
- items:
- type: string
- format: iri-reference
- example: 'https://example.com/'
- createdBy:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonhal'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Contact.jsonld:
- type: object
- description: ''
- deprecated: false
- required:
- - firstName
- - lastName
- - partnerIri
- 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
- firstName:
- type:
- - string
- - 'null'
- lastName:
- type:
- - string
- - 'null'
- fullName:
- type:
- - string
- - 'null'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonld'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- birthday:
- type:
- - string
- - 'null'
- format: date-time
- image:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- imageUrl:
- readOnly: true
- type:
- - string
- - 'null'
- position:
- type:
- - string
- - 'null'
- phone:
- type:
- - string
- - 'null'
- email:
- format: email
- externalDocs:
- url: 'https://schema.org/email'
- type:
- - string
- - 'null'
- posts:
- readOnly: true
- type: array
- items:
- type: string
- format: iri-reference
- example: 'https://example.com/'
- createdBy:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonld'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- ContactPartnerProduct:
- type: object
- description: ''
- deprecated: false
- required:
- - contactIri
- - partnerProductIri
- properties:
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- partnerProductIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- partnerProduct:
- readOnly: true
- description: '?PartnerProduct'
- $ref: '#/components/schemas/PartnerProduct'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- ContactPartnerProduct.jsonhal:
- type: object
- description: ''
- deprecated: false
- required:
- - contactIri
- - partnerProductIri
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- partnerProductIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- partnerProduct:
- readOnly: true
- description: '?PartnerProduct'
- $ref: '#/components/schemas/PartnerProduct.jsonhal'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonhal'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- ContactPartnerProduct.jsonld:
- type: object
- description: ''
- deprecated: false
- required:
- - contactIri
- - partnerProductIri
- 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
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- partnerProductIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- partnerProduct:
- readOnly: true
- description: '?PartnerProduct'
- $ref: '#/components/schemas/PartnerProduct.jsonld'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonld'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Document:
- type: object
- description: ''
- deprecated: false
- required:
- - name
- - documentObject
- properties:
- name:
- type:
- - string
- - 'null'
- description:
- type:
- - string
- - 'null'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- documentObject:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- documentUrl:
- readOnly: true
- type:
- - string
- - 'null'
- createdBy:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Document.jsonhal:
- type: object
- description: ''
- deprecated: false
- required:
- - name
- - documentObject
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- name:
- type:
- - string
- - 'null'
- description:
- type:
- - string
- - 'null'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonhal'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonhal'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- documentObject:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- documentUrl:
- readOnly: true
- type:
- - string
- - 'null'
- createdBy:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonhal'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Document.jsonld:
- type: object
- description: ''
- deprecated: false
- required:
- - name
- - documentObject
- 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
- name:
- type:
- - string
- - 'null'
- description:
- type:
- - string
- - 'null'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonld'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonld'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- documentObject:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- documentUrl:
- readOnly: true
- type:
- - string
- - 'null'
- createdBy:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonld'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- DocumentObject-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'
- DocumentObject.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'
- DocumentObject.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'
- MediaObject-media_object.read:
- type: object
- description: ''
- deprecated: false
- externalDocs:
- url: 'https://schema.org/MediaObject'
- properties:
- contentUrl:
- externalDocs:
- url: 'https://schema.org/contentUrl'
- type:
- - string
- - 'null'
- MediaObject.jsonhal-media_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'
- MediaObject.jsonld-media_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'
- Partner:
- type: object
- description: ''
- deprecated: false
- required:
- - name
- - partnerType
- properties:
- name:
- type: string
- navisionId:
- type:
- - integer
- - 'null'
- nameAddition:
- type:
- - string
- - 'null'
- partnerType:
- type: string
- enum:
- - customer
- - supplier
- - service
- description:
- type:
- - string
- - 'null'
- street:
- type:
- - string
- - 'null'
- addressAddition:
- type:
- - string
- - 'null'
- streetNo:
- type:
- - string
- - 'null'
- zip:
- type:
- - string
- - 'null'
- city:
- type:
- - string
- - 'null'
- country:
- type:
- - string
- - 'null'
- phone:
- type:
- - string
- - 'null'
- language:
- type:
- - string
- - 'null'
- currency:
- type:
- - string
- - 'null'
- paymentCondition:
- type:
- - string
- - 'null'
- deliveryCondition:
- type:
- - string
- - 'null'
- businessGroup:
- type:
- - string
- - 'null'
- vatBusinessGroup:
- type:
- - string
- - 'null'
- creditLimit:
- type:
- - integer
- - 'null'
- routePoint:
- type:
- - string
- - 'null'
- website:
- type:
- - string
- - 'null'
- logo:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- logoUrl:
- readOnly: true
- type:
- - string
- - 'null'
- createdByIri:
- readOnly: true
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Partner.jsonhal:
- type: object
- description: ''
- deprecated: false
- required:
- - name
- - partnerType
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- name:
- type: string
- navisionId:
- type:
- - integer
- - 'null'
- nameAddition:
- type:
- - string
- - 'null'
- partnerType:
- type: string
- enum:
- - customer
- - supplier
- - service
- description:
- type:
- - string
- - 'null'
- street:
- type:
- - string
- - 'null'
- addressAddition:
- type:
- - string
- - 'null'
- streetNo:
- type:
- - string
- - 'null'
- zip:
- type:
- - string
- - 'null'
- city:
- type:
- - string
- - 'null'
- country:
- type:
- - string
- - 'null'
- phone:
- type:
- - string
- - 'null'
- language:
- type:
- - string
- - 'null'
- currency:
- type:
- - string
- - 'null'
- paymentCondition:
- type:
- - string
- - 'null'
- deliveryCondition:
- type:
- - string
- - 'null'
- businessGroup:
- type:
- - string
- - 'null'
- vatBusinessGroup:
- type:
- - string
- - 'null'
- creditLimit:
- type:
- - integer
- - 'null'
- routePoint:
- type:
- - string
- - 'null'
- website:
- type:
- - string
- - 'null'
- logo:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- logoUrl:
- readOnly: true
- type:
- - string
- - 'null'
- createdByIri:
- readOnly: true
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Partner.jsonld:
- type: object
- description: ''
- deprecated: false
- required:
- - name
- - partnerType
- 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
- name:
- type: string
- navisionId:
- type:
- - integer
- - 'null'
- nameAddition:
- type:
- - string
- - 'null'
- partnerType:
- type: string
- enum:
- - customer
- - supplier
- - service
- description:
- type:
- - string
- - 'null'
- street:
- type:
- - string
- - 'null'
- addressAddition:
- type:
- - string
- - 'null'
- streetNo:
- type:
- - string
- - 'null'
- zip:
- type:
- - string
- - 'null'
- city:
- type:
- - string
- - 'null'
- country:
- type:
- - string
- - 'null'
- phone:
- type:
- - string
- - 'null'
- language:
- type:
- - string
- - 'null'
- currency:
- type:
- - string
- - 'null'
- paymentCondition:
- type:
- - string
- - 'null'
- deliveryCondition:
- type:
- - string
- - 'null'
- businessGroup:
- type:
- - string
- - 'null'
- vatBusinessGroup:
- type:
- - string
- - 'null'
- creditLimit:
- type:
- - integer
- - 'null'
- routePoint:
- type:
- - string
- - 'null'
- website:
- type:
- - string
- - 'null'
- logo:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- logoUrl:
- readOnly: true
- type:
- - string
- - 'null'
- createdByIri:
- readOnly: true
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- PartnerFollow:
- type: object
- description: ''
- deprecated: false
- properties:
- userIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- owner:
- readOnly: true
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- required:
- - partnerIri
- PartnerFollow.jsonhal:
- type: object
- description: ''
- deprecated: false
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- userIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonhal'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- owner:
- readOnly: true
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- required:
- - partnerIri
- 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
- userIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonld'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- owner:
- readOnly: true
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- required:
- - partnerIri
- PartnerProduct:
- type: object
- description: ''
- deprecated: false
- properties:
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - partnerIri
- - productIri
- PartnerProduct.jsonhal:
- type: object
- description: ''
- deprecated: false
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonhal'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonhal'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - partnerIri
- - productIri
- PartnerProduct.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
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonld'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonld'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - partnerIri
- - productIri
- Post:
- type: object
- description: ''
- deprecated: false
- required:
- - headline
- - message
- properties:
- headline:
- type:
- - string
- - 'null'
- message:
- type:
- - string
- - 'null'
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contact:
- readOnly: true
- description: '?ContactApi'
- $ref: '#/components/schemas/Contact'
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- sale:
- readOnly: true
- description: '?SaleApi'
- $ref: '#/components/schemas/Contact'
- saleIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- numComments:
- readOnly: true
- type:
- - integer
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Post-posting.create:
- type: object
- description: ''
- deprecated: false
- required:
- - headline
- - message
- properties:
- headline:
- type:
- - string
- - 'null'
- message:
- type:
- - string
- - 'null'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- saleIri:
- 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:
- 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'
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonhal'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonhal'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonhal'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contact:
- readOnly: true
- description: '?ContactApi'
- $ref: '#/components/schemas/Contact.jsonhal'
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- sale:
- readOnly: true
- description: '?SaleApi'
- $ref: '#/components/schemas/Contact.jsonhal'
- saleIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- numComments:
- readOnly: true
- type:
- - integer
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- 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'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- saleIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- Post.jsonld:
- type: object
- description: ''
- deprecated: false
- required:
- - headline
- - message
- 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'
- message:
- type:
- - string
- - 'null'
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonld'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonld'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonld'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contact:
- readOnly: true
- description: '?ContactApi'
- $ref: '#/components/schemas/Contact.jsonld'
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- sale:
- readOnly: true
- description: '?SaleApi'
- $ref: '#/components/schemas/Contact.jsonld'
- saleIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- numComments:
- readOnly: true
- type:
- - integer
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Post.jsonld-posting.create:
- type: object
- description: ''
- deprecated: false
- required:
- - headline
- - message
- properties:
- headline:
- type:
- - string
- - 'null'
- message:
- type:
- - string
- - 'null'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- saleIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- Product:
- type: object
- description: ''
- deprecated: false
- required:
- - name
- - blocked
- - inventory
- properties:
- name:
- type: string
- description:
- type:
- - string
- - 'null'
- blocked:
- type:
- - boolean
- - 'null'
- inventory:
- type:
- - number
- - 'null'
- baseUnit:
- type:
- - string
- - 'null'
- buyUnit:
- type:
- - string
- - 'null'
- sellUnit:
- type:
- - string
- - 'null'
- trackingCode:
- type:
- - string
- - 'null'
- productGroup:
- type:
- - string
- - 'null'
- customsPosition:
- type:
- - string
- - 'null'
- productBookingGroup:
- type:
- - string
- - 'null'
- vatProductBookingGroup:
- type:
- - string
- - 'null'
- image:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- imageUrl:
- readOnly: true
- type:
- - string
- - 'null'
- createdBy:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User'
- createdAt:
- type:
- - string
- - 'null'
- format: date-time
- Product.jsonhal:
- type: object
- description: ''
- deprecated: false
- required:
- - name
- - blocked
- - inventory
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- name:
- type: string
- description:
- type:
- - string
- - 'null'
- blocked:
- type:
- - boolean
- - 'null'
- inventory:
- type:
- - number
- - 'null'
- baseUnit:
- type:
- - string
- - 'null'
- buyUnit:
- type:
- - string
- - 'null'
- sellUnit:
- type:
- - string
- - 'null'
- trackingCode:
- type:
- - string
- - 'null'
- productGroup:
- type:
- - string
- - 'null'
- customsPosition:
- type:
- - string
- - 'null'
- productBookingGroup:
- type:
- - string
- - 'null'
- vatProductBookingGroup:
- type:
- - string
- - 'null'
- image:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- imageUrl:
- readOnly: true
- type:
- - string
- - 'null'
- createdBy:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonhal'
- createdAt:
- type:
- - string
- - 'null'
- format: date-time
- Product.jsonld:
- type: object
- description: ''
- deprecated: false
- required:
- - name
- - blocked
- - inventory
- 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
- name:
- type: string
- description:
- type:
- - string
- - 'null'
- blocked:
- type:
- - boolean
- - 'null'
- inventory:
- type:
- - number
- - 'null'
- baseUnit:
- type:
- - string
- - 'null'
- buyUnit:
- type:
- - string
- - 'null'
- sellUnit:
- type:
- - string
- - 'null'
- trackingCode:
- type:
- - string
- - 'null'
- productGroup:
- type:
- - string
- - 'null'
- customsPosition:
- type:
- - string
- - 'null'
- productBookingGroup:
- type:
- - string
- - 'null'
- vatProductBookingGroup:
- type:
- - string
- - 'null'
- image:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- imageUrl:
- readOnly: true
- type:
- - string
- - 'null'
- createdBy:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonld'
- createdAt:
- type:
- - string
- - 'null'
- format: date-time
- Sale:
- type: object
- description: ''
- deprecated: false
- properties:
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- turnover:
- type:
- - integer
- - 'null'
- profit:
- type:
- - integer
- - 'null'
- quantity:
- type:
- - integer
- - 'null'
- comment:
- type:
- - string
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - partnerIri
- - productIri
- - turnover
- - profit
- - quantity
- Sale.jsonhal:
- type: object
- description: ''
- deprecated: false
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonhal'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonhal'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonhal'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- turnover:
- type:
- - integer
- - 'null'
- profit:
- type:
- - integer
- - 'null'
- quantity:
- type:
- - integer
- - 'null'
- comment:
- type:
- - string
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - partnerIri
- - productIri
- - turnover
- - profit
- - quantity
- Sale.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
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonld'
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonld'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonld'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- turnover:
- type:
- - integer
- - 'null'
- profit:
- type:
- - integer
- - 'null'
- quantity:
- type:
- - integer
- - 'null'
- comment:
- type:
- - string
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- required:
- - partnerIri
- - productIri
- - turnover
- - profit
- - quantity
- SaleSummary:
- type: object
- description: ''
- deprecated: false
- properties:
- userId:
- type: integer
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User'
- turnover:
- type:
- - integer
- - 'null'
- profit:
- type:
- - integer
- - 'null'
- SaleSummary.jsonhal:
- type: object
- description: ''
- deprecated: false
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- userId:
- type: integer
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonhal'
- turnover:
- type:
- - integer
- - 'null'
- profit:
- type:
- - integer
- - 'null'
- SaleSummary.jsonld:
- type: object
- description: ''
- deprecated: false
- properties:
- '@id':
- readOnly: true
- type: string
- '@type':
- readOnly: true
- type: string
- '@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
- userId:
- type: integer
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonld'
- turnover:
- type:
- - integer
- - 'null'
- profit:
- type:
- - integer
- - 'null'
- Task:
- type: object
- description: ''
- deprecated: false
- required:
- - headline
- - assignedToIri
- - dueAt
- - productIri
- - prio
- - completed
- properties:
- headline:
- type:
- - string
- - 'null'
- description:
- type:
- - string
- - 'null'
- createdBy:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User'
- assignedTo:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User'
- assignedToIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- dueAt:
- type:
- - string
- - 'null'
- format: date-time
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contact:
- readOnly: true
- description: '?ContactApi'
- $ref: '#/components/schemas/Contact'
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- prio:
- type: string
- enum:
- - low
- - medium
- - high
- completed:
- type:
- - boolean
- - 'null'
- numTaskNotes:
- readOnly: true
- type:
- - integer
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Task.jsonhal:
- type: object
- description: ''
- deprecated: false
- required:
- - headline
- - assignedToIri
- - dueAt
- - productIri
- - prio
- - completed
- 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
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonhal'
- assignedTo:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonhal'
- assignedToIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- dueAt:
- type:
- - string
- - 'null'
- format: date-time
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonhal'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonhal'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contact:
- readOnly: true
- description: '?ContactApi'
- $ref: '#/components/schemas/Contact.jsonhal'
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- prio:
- type: string
- enum:
- - low
- - medium
- - high
- completed:
- type:
- - boolean
- - 'null'
- numTaskNotes:
- readOnly: true
- type:
- - integer
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- Task.jsonld:
- type: object
- description: ''
- deprecated: false
- required:
- - headline
- - assignedToIri
- - dueAt
- - productIri
- - prio
- - completed
- 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
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonld'
- assignedTo:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonld'
- assignedToIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- dueAt:
- type:
- - string
- - 'null'
- format: date-time
- partner:
- readOnly: true
- description: '?PartnerApi'
- $ref: '#/components/schemas/Partner.jsonld'
- partnerIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonld'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contact:
- readOnly: true
- description: '?ContactApi'
- $ref: '#/components/schemas/Contact.jsonld'
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- prio:
- type: string
- enum:
- - low
- - medium
- - high
- completed:
- type:
- - boolean
- - 'null'
- numTaskNotes:
- readOnly: true
- type:
- - integer
- - 'null'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- TaskNote:
- type: object
- description: ''
- deprecated: false
- required:
- - message
- - taskIri
- - contactType
- properties:
- message:
- type:
- - string
- - 'null'
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User'
- taskIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contact:
- readOnly: true
- description: '?ContactApi'
- $ref: '#/components/schemas/Contact'
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contactType:
- type: string
- enum:
- - personal
- - phone
- - email
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- TaskNote.jsonhal:
- type: object
- description: ''
- deprecated: false
- required:
- - message
- - taskIri
- - contactType
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- message:
- type:
- - string
- - 'null'
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonhal'
- taskIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contact:
- readOnly: true
- description: '?ContactApi'
- $ref: '#/components/schemas/Contact.jsonhal'
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contactType:
- type: string
- enum:
- - personal
- - phone
- - email
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- TaskNote.jsonld:
- type: object
- description: ''
- deprecated: false
- required:
- - message
- - taskIri
- - contactType
- 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
- message:
- type:
- - string
- - 'null'
- owner:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonld'
- taskIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contact:
- readOnly: true
- description: '?ContactApi'
- $ref: '#/components/schemas/Contact.jsonld'
- contactIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- contactType:
- type: string
- enum:
- - personal
- - phone
- - email
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- User:
- type: object
- description: ''
- deprecated: false
- required:
- - email
- - firstName
- - lastName
- properties:
- email:
- format: email
- externalDocs:
- url: 'https://schema.org/email'
- type:
- - string
- - 'null'
- firstName:
- type:
- - string
- - 'null'
- lastName:
- type:
- - string
- - 'null'
- goals:
- type:
- - string
- - 'null'
- image:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- imageUrl:
- readOnly: true
- type:
- - string
- - 'null'
- fullName:
- readOnly: true
- type:
- - string
- - 'null'
- password:
- writeOnly: true
- description: 'The plaintext password when being set or changed.'
- type:
- - string
- - 'null'
- active:
- type: boolean
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- User.jsonhal:
- type: object
- description: ''
- deprecated: false
- required:
- - email
- - firstName
- - lastName
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- email:
- format: email
- externalDocs:
- url: 'https://schema.org/email'
- type:
- - string
- - 'null'
- firstName:
- type:
- - string
- - 'null'
- lastName:
- type:
- - string
- - 'null'
- goals:
- type:
- - string
- - 'null'
- image:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- imageUrl:
- readOnly: true
- type:
- - string
- - 'null'
- fullName:
- readOnly: true
- type:
- - string
- - 'null'
- password:
- writeOnly: true
- description: 'The plaintext password when being set or changed.'
- type:
- - string
- - 'null'
- active:
- type: boolean
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- User.jsonld:
- type: object
- description: ''
- deprecated: false
- required:
- - email
- - firstName
- - lastName
- 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
- email:
- format: email
- externalDocs:
- url: 'https://schema.org/email'
- type:
- - string
- - 'null'
- firstName:
- type:
- - string
- - 'null'
- lastName:
- type:
- - string
- - 'null'
- goals:
- type:
- - string
- - 'null'
- image:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- imageUrl:
- readOnly: true
- type:
- - string
- - 'null'
- fullName:
- readOnly: true
- type:
- - string
- - 'null'
- password:
- writeOnly: true
- description: 'The plaintext password when being set or changed.'
- type:
- - string
- - 'null'
- active:
- type: boolean
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- UserProduct:
- type: object
- description: ''
- deprecated: false
- properties:
- user:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- owner:
- readOnly: true
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- required:
- - productIri
- UserProduct.jsonhal:
- type: object
- description: ''
- deprecated: false
- properties:
- _links:
- type: object
- properties:
- self:
- type: object
- properties:
- href:
- type: string
- format: iri-reference
- user:
- readOnly: true
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonhal'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonhal'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- owner:
- readOnly: true
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- required:
- - productIri
- UserProduct.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
- description: '?UserApi'
- $ref: '#/components/schemas/User.jsonld'
- product:
- readOnly: true
- description: '?ProductApi'
- $ref: '#/components/schemas/Product.jsonld'
- productIri:
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- createdAt:
- readOnly: true
- type:
- - string
- - 'null'
- format: date-time
- owner:
- readOnly: true
- type:
- - string
- - 'null'
- format: iri-reference
- example: 'https://example.com/'
- required:
- - productIri
- responses: { }
- parameters: { }
- examples: { }
- requestBodies: { }
- headers: { }
- securitySchemes:
- JWT:
- type: http
- scheme: bearer
- bearerFormat: JWT
- security:
- -
- JWT: []
- tags: []
|