diff --git a/src/openapi.yaml b/src/openapi.yaml index f4abcf55..a5c64f56 100644 --- a/src/openapi.yaml +++ b/src/openapi.yaml @@ -147,40 +147,1246 @@ paths: $ref: '#/components/schemas/Fout' tags: - objecttypes + post: + operationId: objecttype_create + description: '' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/ObjectType' + responses: + '201': + description: Created + 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/ObjectType' + '400': + description: Bad request + 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/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + '401': + description: Unauthorized + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '403': + description: Forbidden + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '406': + description: Not acceptable + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '409': + description: Conflict + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '410': + description: Gone + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '415': + description: Unsupported media type + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '429': + description: Too many requests + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '500': + description: Internal server error + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + tags: + - objecttypes parameters: [] + /objecttypes/{objecttype_uuid}/versions: + get: + operationId: objectversion_list + description: '' + responses: + '200': + description: OK + 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/ObjectVersion' + '401': + description: Unauthorized + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '403': + description: Forbidden + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '406': + description: Not acceptable + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '409': + description: Conflict + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '410': + description: Gone + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '415': + description: Unsupported media type + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '429': + description: Too many requests + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '500': + description: Internal server error + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + tags: + - objecttypes + post: + operationId: objectversion_create + description: '' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/ObjectVersion' + responses: + '201': + description: Created + 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/ObjectVersion' + '400': + description: Bad request + 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/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + '401': + description: Unauthorized + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '403': + description: Forbidden + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '406': + description: Not acceptable + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '409': + description: Conflict + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '410': + description: Gone + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '415': + description: Unsupported media type + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '429': + description: Too many requests + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '500': + description: Internal server error + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + tags: + - objecttypes + parameters: + - name: objecttype_uuid + in: path + required: true + description: Unieke resource identifier (UUID4) + schema: + type: string + format: uuid + /objecttypes/{objecttype_uuid}/versions/{version}: + get: + operationId: objectversion_read + description: '' + parameters: + - name: If-None-Match + in: header + description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string + responses: + '200': + description: OK + headers: + ETag: + 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. + schema: + type: string + 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/ObjectVersion' + '401': + description: Unauthorized + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '403': + description: Forbidden + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '404': + description: Not found + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '406': + description: Not acceptable + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '409': + description: Conflict + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '410': + description: Gone + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '415': + description: Unsupported media type + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '429': + description: Too many requests + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '500': + description: Internal server error + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + tags: + - objecttypes + put: + operationId: objectversion_update + description: '' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/ObjectVersion' + responses: + '200': + description: OK + 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/ObjectVersion' + '400': + description: Bad request + 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/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + '401': + description: Unauthorized + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '403': + description: Forbidden + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '404': + description: Not found + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '406': + description: Not acceptable + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '409': + description: Conflict + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '410': + description: Gone + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '415': + description: Unsupported media type + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '429': + description: Too many requests + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '500': + description: Internal server error + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + tags: + - objecttypes + patch: + operationId: objectversion_partial_update + description: '' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/ObjectVersion' + responses: + '200': + description: OK + 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/ObjectVersion' + '400': + description: Bad request + 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/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + '401': + description: Unauthorized + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '403': + description: Forbidden + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '404': + description: Not found + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '406': + description: Not acceptable + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '409': + description: Conflict + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '410': + description: Gone + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '415': + description: Unsupported media type + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '429': + description: Too many requests + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '500': + description: Internal server error + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + tags: + - objecttypes + parameters: + - name: objecttype_uuid + in: path + required: true + description: Unieke resource identifier (UUID4) + schema: + type: string + format: uuid + - name: version + in: path + description: Integer version of the OBJECTTYPE + required: true + schema: + type: integer + /objecttypes/{objecttype_uuid}/versions/{version}/publish: + post: + operationId: objectversion_publish + description: '' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + responses: + '201': + description: Created + 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/ObjectVersion' + tags: + - objecttypes + parameters: + - name: objecttype_uuid + in: path + required: true + description: Unieke resource identifier (UUID4) + schema: + type: string + format: uuid + - name: version + in: path + description: Integer version of the OBJECTTYPE + required: true + schema: + type: integer /objecttypes/{uuid}: get: operationId: objecttype_read description: '' parameters: - - name: If-None-Match + - name: If-None-Match + in: header + description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string + responses: + '200': + description: OK + headers: + ETag: + 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. + schema: + type: string + 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/ObjectType' + '401': + description: Unauthorized + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '403': + description: Forbidden + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '404': + description: Not found + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '406': + description: Not acceptable + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '409': + description: Conflict + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '410': + description: Gone + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '415': + description: Unsupported media type + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '429': + description: Too many requests + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '500': + description: Internal server error + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + tags: + - objecttypes + put: + operationId: objecttype_update + description: '' + parameters: + - name: Content-Type in: header - description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - required: false - examples: - oneValue: - summary: "E\xE9n ETag-waarde" - value: '"79054025255fb1a26e4bc422aef54eb4"' - multipleValues: - summary: Meerdere ETag-waardes - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + description: Content type van de verzoekinhoud. + required: true schema: type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/ObjectType' responses: '200': description: OK headers: - ETag: - 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. + 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/ObjectType' + '400': + description: Bad request + 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/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + '401': + description: Unauthorized + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '403': + description: Forbidden + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '404': + description: Not found + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '406': + description: Not acceptable + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '409': + description: Conflict + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '410': + description: Gone + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '415': + description: Unsupported media type + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '429': + description: Too many requests + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '500': + description: Internal server error + 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/problem+json: + schema: + $ref: '#/components/schemas/Fout' + tags: + - objecttypes + patch: + operationId: objecttype_partial_update + description: '' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/ObjectType' + responses: + '200': + description: OK + headers: API-version: schema: type: string @@ -190,6 +1396,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ObjectType' + '400': + description: Bad request + 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/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' '401': description: Unauthorized headers: @@ -314,44 +1532,29 @@ tags: servers: - url: https://example.com/api/v1 components: + requestBodies: + ObjectType: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectType' + required: true + ObjectVersion: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectVersion' + required: true securitySchemes: Token: type: apiKey name: Authorization in: header schemas: - ObjectVersion: - type: object - properties: - version: - title: Versie - description: Integer version of the OBJECTTYPE - type: integer - maximum: 32767 - minimum: 0 - publicationDate: - title: Publicationdate - description: Date of Version publication - type: string - format: date - status: - title: Status - description: Status of the object type version - type: string - enum: - - published - - draft - - deprecated - readOnly: true - jsonSchema: - title: JSON schema - description: JSON schema for Object validation - type: object ObjectType: required: - name - namePlural - - versions type: object properties: url: @@ -447,7 +1650,10 @@ components: versions: type: array items: - $ref: '#/components/schemas/ObjectVersion' + type: string + format: uri + readOnly: true + uniqueItems: true Fout: required: - code @@ -551,3 +1757,40 @@ components: type: array items: $ref: '#/components/schemas/FieldValidationError' + ObjectVersion: + type: object + properties: + url: + title: Url + type: string + format: uri + readOnly: true + version: + title: Versie + description: Integer version of the OBJECTTYPE + type: integer + readOnly: true + objectType: + title: Objecttype + type: string + format: uri + readOnly: true + publicationDate: + title: Publicationdate + description: Date of Version publication + type: string + format: date + readOnly: true + status: + title: Status + description: Status of the object type version + type: string + enum: + - published + - draft + - deprecated + readOnly: true + jsonSchema: + title: JSON schema + description: JSON schema for Object validation + type: object diff --git a/src/swagger2.0.json b/src/swagger2.0.json index ff4ac62e..ade57b10 100755 --- a/src/swagger2.0.json +++ b/src/swagger2.0.json @@ -197,28 +197,1505 @@ "objecttypes" ] }, + "post": { + "operationId": "objecttype_create", + "description": "", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ObjectType" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ObjectType" + }, + "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." + } + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/ValidatieFout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "406": { + "description": "Not acceptable", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "409": { + "description": "Conflict", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "410": { + "description": "Gone", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "415": { + "description": "Unsupported media type", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "500": { + "description": "Internal server error", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + } + }, + "tags": [ + "objecttypes" + ] + }, "parameters": [] }, + "/objecttypes/{objecttype_uuid}/versions": { + "get": { + "operationId": "objectversion_list", + "description": "", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ObjectVersion" + } + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "406": { + "description": "Not acceptable", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "409": { + "description": "Conflict", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "410": { + "description": "Gone", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "415": { + "description": "Unsupported media type", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "500": { + "description": "Internal server error", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + } + }, + "tags": [ + "objecttypes" + ] + }, + "post": { + "operationId": "objectversion_create", + "description": "", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ObjectVersion" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ObjectVersion" + }, + "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." + } + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/ValidatieFout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "406": { + "description": "Not acceptable", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "409": { + "description": "Conflict", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "410": { + "description": "Gone", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "415": { + "description": "Unsupported media type", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "500": { + "description": "Internal server error", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + } + }, + "tags": [ + "objecttypes" + ] + }, + "parameters": [ + { + "name": "objecttype_uuid", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "Unieke resource identifier (UUID4)" + } + ] + }, + "/objecttypes/{objecttype_uuid}/versions/{version}": { + "get": { + "operationId": "objectversion_read", + "description": "", + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n of meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. Indien de waarde van de ETag van de huidige resource voorkomt in deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) voor meer informatie.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ObjectVersion" + }, + "headers": { + "ETag": { + "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.", + "type": "string" + }, + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "406": { + "description": "Not acceptable", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "409": { + "description": "Conflict", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "410": { + "description": "Gone", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "415": { + "description": "Unsupported media type", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "500": { + "description": "Internal server error", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + } + }, + "tags": [ + "objecttypes" + ] + }, + "put": { + "operationId": "objectversion_update", + "description": "", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ObjectVersion" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ObjectVersion" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/ValidatieFout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "406": { + "description": "Not acceptable", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "409": { + "description": "Conflict", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "410": { + "description": "Gone", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "415": { + "description": "Unsupported media type", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "500": { + "description": "Internal server error", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + } + }, + "tags": [ + "objecttypes" + ] + }, + "patch": { + "operationId": "objectversion_partial_update", + "description": "", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ObjectVersion" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ObjectVersion" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/ValidatieFout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "406": { + "description": "Not acceptable", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "409": { + "description": "Conflict", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "410": { + "description": "Gone", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "415": { + "description": "Unsupported media type", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "500": { + "description": "Internal server error", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + } + }, + "tags": [ + "objecttypes" + ] + }, + "parameters": [ + { + "name": "objecttype_uuid", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "Unieke resource identifier (UUID4)" + }, + { + "name": "version", + "in": "path", + "description": "Integer version of the OBJECTTYPE", + "required": true, + "type": "integer" + } + ] + }, + "/objecttypes/{objecttype_uuid}/versions/{version}/publish": { + "post": { + "operationId": "objectversion_publish", + "description": "", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ObjectVersion" + }, + "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." + } + } + } + }, + "tags": [ + "objecttypes" + ] + }, + "parameters": [ + { + "name": "objecttype_uuid", + "in": "path", + "required": true, + "type": "string", + "format": "uuid", + "description": "Unieke resource identifier (UUID4)" + }, + { + "name": "version", + "in": "path", + "description": "Integer version of the OBJECTTYPE", + "required": true, + "type": "integer" + } + ] + }, "/objecttypes/{uuid}": { "get": { "operationId": "objecttype_read", "description": "", "parameters": [ { - "name": "If-None-Match", + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n of meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. Indien de waarde van de ETag van de huidige resource voorkomt in deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) voor meer informatie.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ObjectType" + }, + "headers": { + "ETag": { + "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.", + "type": "string" + }, + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "406": { + "description": "Not acceptable", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "409": { + "description": "Conflict", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "410": { + "description": "Gone", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "415": { + "description": "Unsupported media type", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "500": { + "description": "Internal server error", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + } + }, + "tags": [ + "objecttypes" + ] + }, + "put": { + "operationId": "objecttype_update", + "description": "", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ObjectType" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ObjectType" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/ValidatieFout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "406": { + "description": "Not acceptable", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "409": { + "description": "Conflict", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "410": { + "description": "Gone", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "415": { + "description": "Unsupported media type", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "500": { + "description": "Internal server error", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + } + }, + "tags": [ + "objecttypes" + ] + }, + "patch": { + "operationId": "objecttype_partial_update", + "description": "", + "parameters": [ + { + "name": "Content-Type", "in": "header", - "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n of meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. Indien de waarde van de ETag van de huidige resource voorkomt in deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) voor meer informatie.", - "required": false, + "description": "Content type van de verzoekinhoud.", + "required": true, "type": "string", - "examples": { - "oneValue": { - "summary": "E\u00e9n ETag-waarde", - "value": "\"79054025255fb1a26e4bc422aef54eb4\"" - }, - "multipleValues": { - "summary": "Meerdere ETag-waardes", - "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" - } + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ObjectType" } } ], @@ -229,10 +1706,20 @@ "$ref": "#/definitions/ObjectType" }, "headers": { - "ETag": { - "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.", - "type": "string" - }, + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/ValidatieFout" + }, + "headers": { "API-version": { "schema": { "type": "string" @@ -385,45 +1872,10 @@ } }, "definitions": { - "ObjectVersion": { - "type": "object", - "properties": { - "version": { - "title": "Versie", - "description": "Integer version of the OBJECTTYPE", - "type": "integer", - "maximum": 32767, - "minimum": 0 - }, - "publicationDate": { - "title": "Publicationdate", - "description": "Date of Version publication", - "type": "string", - "format": "date" - }, - "status": { - "title": "Status", - "description": "Status of the object type version", - "type": "string", - "enum": [ - "published", - "draft", - "deprecated" - ], - "readOnly": true - }, - "jsonSchema": { - "title": "JSON schema", - "description": "JSON schema for Object validation", - "type": "object" - } - } - }, "ObjectType": { "required": [ "name", - "namePlural", - "versions" + "namePlural" ], "type": "object", "properties": { @@ -532,8 +1984,11 @@ "versions": { "type": "array", "items": { - "$ref": "#/definitions/ObjectVersion" - } + "type": "string", + "format": "uri" + }, + "readOnly": true, + "uniqueItems": true } } }, @@ -663,6 +2118,52 @@ } } } + }, + "ObjectVersion": { + "type": "object", + "properties": { + "url": { + "title": "Url", + "type": "string", + "format": "uri", + "readOnly": true + }, + "version": { + "title": "Versie", + "description": "Integer version of the OBJECTTYPE", + "type": "integer", + "readOnly": true + }, + "objectType": { + "title": "Objecttype", + "type": "string", + "format": "uri", + "readOnly": true + }, + "publicationDate": { + "title": "Publicationdate", + "description": "Date of Version publication", + "type": "string", + "format": "date", + "readOnly": true + }, + "status": { + "title": "Status", + "description": "Status of the object type version", + "type": "string", + "enum": [ + "published", + "draft", + "deprecated" + ], + "readOnly": true + }, + "jsonSchema": { + "title": "JSON schema", + "description": "JSON schema for Object validation", + "type": "object" + } + } } }, "tags": [