Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RHCLOUD-35506: Update openapi spec with new params #252

Merged
merged 1 commit into from
Oct 1, 2024
Merged

RHCLOUD-35506: Update openapi spec with new params #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions cmd/spec/parameters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions cmd/spec/path.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down
42 changes: 42 additions & 0 deletions spec/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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": {
Expand Down Expand Up @@ -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"
},
Expand Down
30 changes: 30 additions & 0 deletions spec/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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'
Expand Down