From 1b0eee6e671002fcccfdc28b733fccb3d74957f4 Mon Sep 17 00:00:00 2001 From: robinvandermolen Date: Thu, 31 Oct 2024 15:20:55 +0100 Subject: [PATCH] :package: [#4796] Updated OAS --- src/openapi.yaml | 67 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) diff --git a/src/openapi.yaml b/src/openapi.yaml index f7dbb3086b..2426997674 100644 --- a/src/openapi.yaml +++ b/src/openapi.yaml @@ -4235,6 +4235,62 @@ paths: $ref: '#/components/headers/X-Is-Form-Designer' Content-Language: $ref: '#/components/headers/Content-Language' + /api/v2/registration/plugins/zgw-api/products: + get: + operationId: registration_plugins_zgw_api_products_list + description: |- + Fetch and serialize a list of objects. + + Alternative to :class:`rest_framework.mixins.ListModelMixin` for non-database + backed collections of objects. + summary: List the available products bound to a case type within a catalogue + (ZGW APIs) + parameters: + - in: query + name: case_type_identification + schema: + type: string + minLength: 1 + description: Filter case types against this identification. + required: true + - in: query + name: catalogue_url + schema: + type: string + format: uri + title: catalogus URL + minLength: 1 + description: Filter case types against this catalogue URL. + required: true + - in: query + name: zgw_api_group + schema: + type: integer + description: The primary key of the ZGW API group to use. The informatieobjecttypen + from the Catalogi API in this group will be returned. + required: true + tags: + - registration + security: + - cookieAuth: [] + responses: + '200': + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/CaseTypeProduct' + description: '' + headers: + X-Session-Expires-In: + $ref: '#/components/headers/X-Session-Expires-In' + X-CSRFToken: + $ref: '#/components/headers/X-CSRFToken' + X-Is-Form-Designer: + $ref: '#/components/headers/X-Is-Form-Designer' + Content-Language: + $ref: '#/components/headers/Content-Language' /api/v2/service-fetch-configurations: get: operationId: service_fetch_configurations_list @@ -7042,6 +7098,17 @@ components: - description - identification - isPublished + CaseTypeProduct: + type: object + properties: + uri: + type: string + description: 'The uri of a product bound to a case type. ' + description: + type: string + description: 'The description of a product bound to a case type. ' + required: + - uri Catalogue: type: object properties: