From 38591c2e3a6cf845bedb3b1e7d1a036e802c76ca Mon Sep 17 00:00:00 2001 From: Adam Jetmar Date: Tue, 1 Oct 2024 13:54:46 +0200 Subject: [PATCH] Update OpenAPI spec with new params --- cmd/spec/parameters.yaml | 27 ++++++++++++++++++++++++++ cmd/spec/path.yaml | 3 +++ spec/openapi.json | 42 ++++++++++++++++++++++++++++++++++++++++ spec/openapi.yaml | 30 ++++++++++++++++++++++++++++ 4 files changed, 102 insertions(+) diff --git a/cmd/spec/parameters.yaml b/cmd/spec/parameters.yaml index d2787a54..4967f870 100644 --- a/cmd/spec/parameters.yaml +++ b/cmd/spec/parameters.yaml @@ -1,5 +1,32 @@ # It is necessary to have the initial indetation! queryParams: + ProductFamilies: + name: product-families + description: If set, content is associated with a specific CRC product families + in: query + required: false + schema: + type: string + explode: true + style: form + Content: + name: content + description: If set, content is associated with a specific CRC content + in: query + required: false + schema: + type: string + explode: true + style: form + UseCase: + name: use-case + description: If set, content is associated with a specific CRC use case + in: query + required: false + schema: + type: string + explode: true + style: form Bundle: name: bundle description: If set, content is associated with a specific CRC bundle diff --git a/cmd/spec/path.yaml b/cmd/spec/path.yaml index 112ca88c..8c350223 100644 --- a/cmd/spec/path.yaml +++ b/cmd/spec/path.yaml @@ -21,6 +21,9 @@ paths: items: $ref: '#/components/schemas/v1.Quickstart' parameters: + - $ref: '#/components/schemas/queryParams/ProductFamilies' + - $ref: '#/components/schemas/queryParams/Content' + - $ref: '#/components/schemas/queryParams/UseCase' - $ref: '#/components/schemas/queryParams/Bundle' - $ref: '#/components/schemas/queryParams/Application' - $ref: '#/components/schemas/queryParams/Limit' diff --git a/spec/openapi.json b/spec/openapi.json index 93bc52e7..f0c06603 100644 --- a/spec/openapi.json +++ b/spec/openapi.json @@ -49,6 +49,17 @@ }, "style": "form" }, + "Content": { + "description": "If set, content is associated with a specific CRC content", + "explode": true, + "in": "query", + "name": "content", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, "Id": { "description": "identifier", "in": "path", @@ -91,6 +102,17 @@ }, "style": "form" }, + "ProductFamilies": { + "description": "If set, content is associated with a specific CRC product families", + "explode": true, + "in": "query", + "name": "product-families", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, "TopicName": { "description": "identifier", "in": "path", @@ -99,6 +121,17 @@ "schema": { "type": "string" } + }, + "UseCase": { + "description": "If set, content is associated with a specific CRC use case", + "explode": true, + "in": "query", + "name": "use-case", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" } }, "v1.FavoriteQuickstart": { @@ -506,6 +539,15 @@ "/quickstarts": { "get": { "parameters": [ + { + "$ref": "#/components/schemas/queryParams/ProductFamilies" + }, + { + "$ref": "#/components/schemas/queryParams/Content" + }, + { + "$ref": "#/components/schemas/queryParams/UseCase" + }, { "$ref": "#/components/schemas/queryParams/Bundle" }, diff --git a/spec/openapi.yaml b/spec/openapi.yaml index 1ee1292c..fa25dd6a 100644 --- a/spec/openapi.yaml +++ b/spec/openapi.yaml @@ -163,6 +163,33 @@ components: type: object # It is necessary to have the initial indetation! queryParams: + ProductFamilies: + name: product-families + description: If set, content is associated with a specific CRC product families + in: query + required: false + schema: + type: string + explode: true + style: form + Content: + name: content + description: If set, content is associated with a specific CRC content + in: query + required: false + schema: + type: string + explode: true + style: form + UseCase: + name: use-case + description: If set, content is associated with a specific CRC use case + in: query + required: false + schema: + type: string + explode: true + style: form Bundle: name: bundle description: If set, content is associated with a specific CRC bundle @@ -252,6 +279,9 @@ paths: items: $ref: '#/components/schemas/v1.Quickstart' parameters: + - $ref: '#/components/schemas/queryParams/ProductFamilies' + - $ref: '#/components/schemas/queryParams/Content' + - $ref: '#/components/schemas/queryParams/UseCase' - $ref: '#/components/schemas/queryParams/Bundle' - $ref: '#/components/schemas/queryParams/Application' - $ref: '#/components/schemas/queryParams/Limit'