diff --git a/src/openapi/products/products-crud-v2.2.yaml b/src/openapi/products/products-crud-v2.2.yaml index 0f69225..3daa4ec 100644 --- a/src/openapi/products/products-crud-v2.2.yaml +++ b/src/openapi/products/products-crud-v2.2.yaml @@ -1,13 +1,13 @@ openapi: 3.0.1 info: - title: ABTProducts (based on domainmodel v2.2) + title: ABTProducts description: >- CRUD APIs for HTM products (based on the new domainmodel v2.2). Internal use only; external touchpoints can get read-only, filtered access via the HTM Service Engine, using a different endpoint. - version: '2.2' + version: '1.0' servers: - - url: https://api.integratielaag.nl/abt/products/2.2 + - url: https://api.integratielaag.nl/abt/products/1.0 tags: - name: ABTProducts CRUD description: >- @@ -20,13 +20,23 @@ paths: - ABTProducts CRUD summary: Get a list of all defined HTM products description: |- - Get a list of all HTM products, without any filters. Only a few details - are returned per product - use the `GET /products/{productId}` endpoint + Get a list of all HTM products that refer to a given parentProductId (or without parent, if not specified), without any other filters. \ + Only a few details are returned per product - use the `GET /products/{productId}` endpoint to get more details. \ In the examples, it can be seen that (when a touchpoint HTTP header is present) only products that have active sellingPeriods for touchpoints within the same retailer as the calling retailer are returned. \ Touchpoint 1 and 2 belong to retailer 1; touchpoint 3 and 4 belong to retailer 2. + parameters: + - name: parentProductId + in: query + required: false + description: |- + Only return products that refer to the given parentProductId. \ + Returns parent-products (i.e. products with parentProductId = null) if left empty. + schema: + type: integer + example: 1 responses: '200': description: OK