diff --git a/README.rst b/README.rst index e5ff0862..f4c47747 100644 --- a/README.rst +++ b/README.rst @@ -88,16 +88,3 @@ Features :target: https://github.com/psf/black .. _documentatie: https://commonground-api-common.readthedocs.io/en/latest/?badge=latest - - - -**todo** -* notifications-webhook.yaml - return it back -* make rest_framework_gis optional for configuration - -* finish Sonny comments -* process my comments -* compare with Open Zaak spectacular implementation -* return AuthScopesRequired ??? -* return generating notification consumer oas: - * bin/generate_notifications_api_spec.sh diff --git a/notifications_webhook/settings.py b/notifications_webhook/settings.py index e7649f5f..b05c27c6 100644 --- a/notifications_webhook/settings.py +++ b/notifications_webhook/settings.py @@ -2,7 +2,6 @@ from vng_api_common.conf.api import * # noqa - DEBUG = os.getenv("DEBUG", "no").lower() in ["yes", "true", "1"] BASE_DIR = os.path.abspath(os.path.dirname(__file__)) @@ -52,6 +51,9 @@ "TITLE": "Notifications webhook receiver", "VERSION": "v1", "DESCRIPTION": "API Specification to be able to receive notifications from the NRC", - "CONTACT": {"name": "VNG Realisatie", "url": "https://github.com/VNG-Realisatie/gemma-zaken"}, + "CONTACT": { + "name": "VNG Realisatie", + "url": "https://github.com/VNG-Realisatie/gemma-zaken", + }, } ) diff --git a/notifications_webhook/views.py b/notifications_webhook/views.py index 6799abcd..0fff65ee 100644 --- a/notifications_webhook/views.py +++ b/notifications_webhook/views.py @@ -6,4 +6,5 @@ class NotificationView(_NotificationView): """ Ontvang notificaties via webhook """ + schema = AutoSchema() diff --git a/testapp/openapi.yaml b/testapp/openapi.yaml deleted file mode 100644 index 6d526b00..00000000 --- a/testapp/openapi.yaml +++ /dev/null @@ -1,1861 +0,0 @@ -openapi: 3.0.3 -info: - title: '' - version: 0.0.0 -paths: - /api/groups: - get: - operationId: group_list - tags: - - api - security: - - JWT-Claims: [] - - {} - responses: - '200': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Group' - description: '' - '400': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: '' - '401': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '403': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '406': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '409': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '410': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '415': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '429': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '500': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - post: - operationId: group_create - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type of the request body. - required: true - tags: - - api - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Group' - required: true - security: - - JWT-Claims: [] - - {} - responses: - '201': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - content: - application/json: - schema: - $ref: '#/components/schemas/Group' - description: '' - '400': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: '' - '401': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '403': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '406': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '409': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '410': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '415': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '429': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '500': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - /api/groups/{id}: - get: - operationId: group_read - parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this group. - required: true - tags: - - api - security: - - JWT-Claims: [] - - {} - responses: - '200': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Group' - description: '' - '401': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '403': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '404': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '406': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '409': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '410': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '415': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '429': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '500': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - put: - operationId: group_update - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type of the request body. - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this group. - required: true - tags: - - api - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Group' - required: true - security: - - JWT-Claims: [] - - {} - responses: - '200': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Group' - description: '' - '400': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: '' - '401': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '403': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '404': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '406': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '409': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '410': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '415': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '429': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '500': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - patch: - operationId: group_partial_update - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type of the request body. - required: true - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this group. - required: true - tags: - - api - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedGroup' - security: - - JWT-Claims: [] - - {} - responses: - '200': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Group' - description: '' - '400': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: '' - '401': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '403': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '404': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '406': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '409': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '410': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '415': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '429': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '500': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - delete: - operationId: group_delete - parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this group. - required: true - tags: - - api - security: - - JWT-Claims: [] - - {} - responses: - '204': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: No response body - '401': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '403': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '404': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '406': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '409': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '410': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '415': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '429': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '500': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - /api/hobbies: - get: - operationId: hobby_list - tags: - - api - security: - - JWT-Claims: [] - - {} - responses: - '200': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Hobby' - description: '' - '400': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: '' - '401': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '403': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '406': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '409': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '410': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '415': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '429': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '500': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - /api/hobbies/{id}: - get: - operationId: hobby_read - parameters: - - in: header - name: If-None-Match - schema: - type: string - description: Perform conditional requests. This header should contain one - or multiple ETag values of resources the client has cached. If the current - resource ETag value is in this set, then an HTTP 304 empty body will be - returned. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - for details. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: One ETag value - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Multiple ETag values - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this hobby. - required: true - tags: - - api - security: - - JWT-Claims: [] - - {} - responses: - '200': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - ETag: - schema: - type: string - description: De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - content: - application/json: - schema: - $ref: '#/components/schemas/Hobby' - description: '' - '401': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '403': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '404': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '406': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '409': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '410': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '415': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '429': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '500': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - head: - operationId: hobby_head - parameters: - - in: header - name: If-None-Match - schema: - type: string - description: Perform conditional requests. This header should contain one - or multiple ETag values of resources the client has cached. If the current - resource ETag value is in this set, then an HTTP 304 empty body will be - returned. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - for details. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: One ETag value - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Multiple ETag values - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this hobby. - required: true - tags: - - api - security: - - JWT-Claims: [] - - {} - responses: - '200': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - ETag: - schema: - type: string - description: De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - description: No response body - /api/jwtsecret/: - post: - operationId: api_jwtsecret_create - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type of the request body. - required: true - tags: - - api - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/JWTSecret' - required: true - security: - - JWT-Claims: - - autorisaties.credentials-registreren - responses: - '201': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - content: - application/json: - schema: - $ref: '#/components/schemas/JWTSecret' - description: '' - '400': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: '' - '401': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '403': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '406': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '409': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '410': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '415': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '429': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '500': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - /api/persons: - get: - operationId: person_list - description: |- - Summary - - More summary - tags: - - api - security: - - JWT-Claims: [] - - {} - responses: - '200': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/Person' - description: '' - '400': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: '' - '401': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '403': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '406': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '409': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '410': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '415': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '429': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '500': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - /api/persons/{id}: - get: - operationId: person_read - description: Some description - parameters: - - in: header - name: If-None-Match - schema: - type: string - description: Perform conditional requests. This header should contain one - or multiple ETag values of resources the client has cached. If the current - resource ETag value is in this set, then an HTTP 304 empty body will be - returned. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - for details. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: One ETag value - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Multiple ETag values - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this person. - required: true - tags: - - api - security: - - JWT-Claims: [] - - {} - responses: - '200': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - ETag: - schema: - type: string - description: De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - content: - application/json: - schema: - $ref: '#/components/schemas/Person' - description: '' - '401': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '403': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '404': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '406': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '409': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '410': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '415': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '429': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - '500': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Fout' - description: '' - head: - operationId: person_head - description: Some description - parameters: - - in: header - name: If-None-Match - schema: - type: string - description: Perform conditional requests. This header should contain one - or multiple ETag values of resources the client has cached. If the current - resource ETag value is in this set, then an HTTP 304 empty body will be - returned. See [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - for details. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: One ETag value - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Multiple ETag values - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this person. - required: true - tags: - - api - security: - - JWT-Claims: [] - - {} - responses: - '200': - headers: - API-version: - schema: - type: string - description: 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - ETag: - schema: - type: string - description: De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - description: No response body -components: - schemas: - Address: - type: object - properties: - street: - type: string - title: Street name - maxLength: 255 - number: - type: string - title: House number - maxLength: 10 - required: - - number - - street - FieldValidationError: - type: object - description: Formaat van validatiefouten. - properties: - name: - type: string - description: Naam van het veld met ongeldige gegevens - code: - type: string - description: Systeemcode die het type fout aangeeft - reason: - type: string - description: Uitleg wat er precies fout is met de gegevens - required: - - code - - name - - reason - Fout: - type: object - description: Formaat van HTTP 4xx en 5xx fouten. - properties: - type: - type: string - description: URI referentie naar het type fout, bedoeld voor developers - code: - type: string - description: Systeemcode die het type fout aangeeft - title: - type: string - description: Generieke titel voor het type fout - status: - type: integer - description: De HTTP status code - detail: - type: string - description: Extra informatie bij de fout, indien beschikbaar - instance: - type: string - description: URI met referentie naar dit specifiek voorkomen van de fout. - Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. - required: - - code - - detail - - instance - - status - - title - Group: - type: object - properties: - person: - type: array - items: - $ref: '#/components/schemas/Person' - required: - - person - Hobby: - type: object - properties: - name: - type: string - maxLength: 100 - people: - type: array - items: - type: integer - required: - - name - - people - JWTSecret: - type: object - properties: - identifier: - type: string - title: Client ID - description: Client ID to identify external API's and applications that - access this API. - maxLength: 50 - secret: - type: string - description: Secret belonging to the client ID. - maxLength: 255 - required: - - identifier - - secret - PatchedGroup: - type: object - properties: - person: - type: array - items: - $ref: '#/components/schemas/Person' - Person: - type: object - properties: - address: - allOf: - - $ref: '#/components/schemas/Address' - nullable: true - name: - type: string - maxLength: 50 - groupName: - type: string - readOnly: true - required: - - address - - groupName - - name - ValidatieFout: - type: object - description: Formaat van HTTP 4xx en 5xx fouten. - properties: - type: - type: string - description: URI referentie naar het type fout, bedoeld voor developers - code: - type: string - description: Systeemcode die het type fout aangeeft - title: - type: string - description: Generieke titel voor het type fout - status: - type: integer - description: De HTTP status code - detail: - type: string - description: Extra informatie bij de fout, indien beschikbaar - instance: - type: string - description: URI met referentie naar dit specifiek voorkomen van de fout. - Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. - invalidParams: - type: array - items: - $ref: '#/components/schemas/FieldValidationError' - required: - - code - - detail - - instance - - invalidParams - - status - - title - securitySchemes: - JWT-Claims: - type: http - bearerFormat: JWT - scheme: bearer -tags: -- name: moloko_milk_bar - description: Global tag description via settings