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

[Workflow] Update Swagger REST API doc #1940

Merged
merged 1 commit into from
Nov 21, 2024
Merged

[Workflow] Update Swagger REST API doc #1940

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
6 changes: 3 additions & 3 deletions src/api/rest/docs/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14139,9 +14139,9 @@ const docTemplate = `{
"example": "My K8sCluster"
},
"id": {
"description": "Id is unique identifier for the object",
"description": "Id is unique identifier for the object, same as Name",
"type": "string",
"example": "aws-ap-southeast-1"
"example": "k8scluster-01"
},
"label": {
"description": "Label is for describing the object by keywords",
Expand All @@ -14153,7 +14153,7 @@ const docTemplate = `{
"name": {
"description": "Name is human-readable string to represent the object",
"type": "string",
"example": "aws-ap-southeast-1"
"example": "k8scluster-01"
},
"resourceType": {
"description": "ResourceType is the type of the resource",
Expand Down
6 changes: 3 additions & 3 deletions src/api/rest/docs/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14132,9 +14132,9 @@
"example": "My K8sCluster"
},
"id": {
"description": "Id is unique identifier for the object",
"description": "Id is unique identifier for the object, same as Name",
"type": "string",
"example": "aws-ap-southeast-1"
"example": "k8scluster-01"
},
"label": {
"description": "Label is for describing the object by keywords",
Expand All @@ -14146,7 +14146,7 @@
"name": {
"description": "Name is human-readable string to represent the object",
"type": "string",
"example": "aws-ap-southeast-1"
"example": "k8scluster-01"
},
"resourceType": {
"description": "ResourceType is the type of the resource",
Expand Down
6 changes: 3 additions & 3 deletions src/api/rest/docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10594,8 +10594,8 @@ components:
example: My K8sCluster
id:
type: string
description: Id is unique identifier for the object
example: aws-ap-southeast-1
description: "Id is unique identifier for the object, same as Name"
example: k8scluster-01
label:
type: object
additionalProperties:
Expand All @@ -10604,7 +10604,7 @@ components:
name:
type: string
description: Name is human-readable string to represent the object
example: aws-ap-southeast-1
example: k8scluster-01
resourceType:
type: string
description: ResourceType is the type of the resource
Expand Down