Skip to content

chore: update api docs #3382

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

Open
banjoh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: update api docs #3382

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
3,288 changes: 3,283 additions & 5 deletions api/docs/docs.go
View file
Open in desktop

Large diffs are not rendered by default.

3,288 changes: 3,283 additions & 5 deletions api/docs/swagger.json
View file
Open in desktop

Large diffs are not rendered by default.

130 changes: 110 additions & 20 deletions api/docs/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,11 @@ components:
- ECInstall
- DataTransfer
- Completed
- Discovery
- Preparation
- ECInstall
- DataTransfer
- Completed
example: Discovery
type: string
x-enum-varnames:
Expand All @@ -230,6 +235,10 @@ components:
- InProgress
- Completed
- Failed
- NotStarted
- InProgress
- Completed
- Failed
example: InProgress
type: string
x-enum-varnames:
Expand Down Expand Up @@ -416,6 +425,10 @@ components:
- Running
- Succeeded
- Failed
- Pending
- Running
- Succeeded
- Failed
example: Succeeded
type: string
x-enum-varnames:
Expand Down Expand Up @@ -449,6 +462,8 @@ components:
enum:
- copy
- move
- copy
- move
example: copy
type: string
x-enum-varnames:
Expand Down Expand Up @@ -659,7 +674,6 @@ components:
type: object
securitySchemes:
bearerauth:
bearerFormat: JWT
scheme: bearer
type: http
externalDocs:
Expand Down Expand Up @@ -687,7 +701,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.AuthRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.AuthRequest'
description: Auth Request
summary: request
description: Auth Request
required: true
responses:
Expand Down Expand Up @@ -788,7 +806,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.TemplateAppConfigRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.TemplateAppConfigRequest'
description: Template App Config Request
summary: request
description: Template App Config Request
required: true
responses:
Expand Down Expand Up @@ -838,7 +860,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.PatchAppConfigValuesRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.PatchAppConfigValuesRequest'
description: Patch App Config Values Request
summary: request
description: Patch App Config Values Request
required: true
responses:
Expand Down Expand Up @@ -867,7 +893,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.InstallAppRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.InstallAppRequest'
description: Install App Request
summary: request
description: Install App Request
required: true
responses:
Expand Down Expand Up @@ -971,7 +1001,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.KubernetesInstallationConfig'
oneOf:
- type: object
- $ref: '#/components/schemas/types.KubernetesInstallationConfig'
description: Installation config
summary: installationConfig
description: Installation config
required: true
responses:
Expand Down Expand Up @@ -1061,7 +1095,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.TemplateAppConfigRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.TemplateAppConfigRequest'
description: Template App Config Request
summary: request
description: Template App Config Request
required: true
responses:
Expand Down Expand Up @@ -1111,7 +1149,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.PatchAppConfigValuesRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.PatchAppConfigValuesRequest'
description: Patch App Config Values Request
summary: request
description: Patch App Config Values Request
required: true
responses:
Expand Down Expand Up @@ -1162,7 +1204,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.UpgradeAppRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.UpgradeAppRequest'
description: Upgrade App Request
summary: request
description: Upgrade App Request
required: true
responses:
Expand Down Expand Up @@ -1281,7 +1327,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.TemplateAppConfigRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.TemplateAppConfigRequest'
description: Template App Config Request
summary: request
description: Template App Config Request
required: true
responses:
Expand Down Expand Up @@ -1331,7 +1381,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.PatchAppConfigValuesRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.PatchAppConfigValuesRequest'
description: Patch App Config Values Request
summary: request
description: Patch App Config Values Request
required: true
responses:
Expand Down Expand Up @@ -1360,7 +1414,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.InstallAppRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.InstallAppRequest'
description: Install App Request
summary: request
description: Install App Request
required: true
responses:
Expand Down Expand Up @@ -1412,7 +1470,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.PostInstallRunHostPreflightsRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.PostInstallRunHostPreflightsRequest'
description: Post Install Run Host Preflights Request
summary: request
description: Post Install Run Host Preflights Request
required: true
responses:
Expand Down Expand Up @@ -1452,7 +1514,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.LinuxInfraSetupRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.LinuxInfraSetupRequest'
description: Infra Setup Request
summary: request
description: Infra Setup Request
required: true
responses:
Expand Down Expand Up @@ -1507,7 +1573,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.LinuxInstallationConfig'
oneOf:
- type: object
- $ref: '#/components/schemas/types.LinuxInstallationConfig'
description: Installation config
summary: installationConfig
description: Installation config
required: true
responses:
Expand Down Expand Up @@ -1570,7 +1640,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.StartKURLMigrationRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.StartKURLMigrationRequest'
description: Start kURL Migration Request
summary: request
description: Start kURL Migration Request
required: true
responses:
Expand Down Expand Up @@ -1716,7 +1790,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.TemplateAppConfigRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.TemplateAppConfigRequest'
description: Template App Config Request
summary: request
description: Template App Config Request
required: true
responses:
Expand Down Expand Up @@ -1766,7 +1844,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.PatchAppConfigValuesRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.PatchAppConfigValuesRequest'
description: Patch App Config Values Request
summary: request
description: Patch App Config Values Request
required: true
responses:
Expand Down Expand Up @@ -1817,7 +1899,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.UpgradeAppRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.UpgradeAppRequest'
description: Upgrade App Request
summary: request
description: Upgrade App Request
required: true
responses:
Expand Down Expand Up @@ -1925,7 +2011,11 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/types.LinuxInfraUpgradeRequest'
oneOf:
- type: object
- $ref: '#/components/schemas/types.LinuxInfraUpgradeRequest'
description: Infra Upgrade Request
summary: request
description: Infra Upgrade Request
required: true
responses:
Expand Down
Loading