fix: update the api reference from the OpenAPI spec in the /backend folder instead

This commit is contained in:
Emmanuel Oloyede
2023-10-26 04:35:14 +01:00
parent abfc69fc75
commit 01cbd4236d
3 changed files with 925 additions and 170 deletions

View File

@@ -534,40 +534,6 @@ paths:
responses:
'200':
description: OK
/api/v1/sso/redirect/google:
get:
description: ''
parameters:
- name: callback_port
in: query
schema:
type: string
responses:
default:
description: ''
/api/v1/sso/google:
get:
description: ''
responses:
default:
description: ''
/api/v1/sso/redirect/github:
get:
description: ''
parameters:
- name: callback_port
in: query
schema:
type: string
responses:
default:
description: ''
/api/v1/sso/github:
get:
description: ''
responses:
default:
description: ''
/api/v1/sso/redirect/saml2/{ssoIdentifier}:
get:
description: ''
@@ -622,6 +588,45 @@ paths:
responses:
'200':
description: OK
/api/v3/service-token/me/key:
get:
description: ''
responses:
'200':
description: OK
/api/v3/service-token/:
post:
description: ''
responses:
'200':
description: OK
'400':
description: Bad Request
/api/v3/service-token/{serviceTokenDataId}:
patch:
description: ''
parameters:
- name: serviceTokenDataId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
'400':
description: Bad Request
delete:
description: ''
parameters:
- name: serviceTokenDataId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/signup/email/signup:
post:
description: ''
@@ -735,11 +740,6 @@ paths:
responses:
'200':
description: OK
post:
description: ''
responses:
'200':
description: OK
/api/v1/organization/{organizationId}:
get:
description: ''
@@ -1330,6 +1330,78 @@ paths:
responses:
'200':
description: OK
/api/v1/integration-auth/{integrationAuthId}/qovery/orgs:
get:
description: ''
parameters:
- name: integrationAuthId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/integration-auth/{integrationAuthId}/qovery/projects:
get:
description: ''
parameters:
- name: integrationAuthId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/integration-auth/{integrationAuthId}/qovery/environments:
get:
description: ''
parameters:
- name: integrationAuthId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/integration-auth/{integrationAuthId}/qovery/apps:
get:
description: ''
parameters:
- name: integrationAuthId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/integration-auth/{integrationAuthId}/qovery/containers:
get:
description: ''
parameters:
- name: integrationAuthId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/integration-auth/{integrationAuthId}/qovery/jobs:
get:
description: ''
parameters:
- name: integrationAuthId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/integration-auth/{integrationAuthId}/railway/environments:
get:
description: ''
@@ -1518,19 +1590,24 @@ paths:
description: Unauthorized request. For example, 'Folder Permission Denied'
security:
- apiKeyAuth: []
/api/v1/folders/{folderId}:
/api/v1/folders/{folderName}:
patch:
summary: Update a folder by ID
description: >-
Update the name of a folder in a specified workspace and environment by
its ID
parameters:
- name: folderId
- name: folderName
in: path
required: true
schema:
type: string
- name: folderId
description: ID of the folder to be updated
required: true
in: path
schema:
type: string
responses:
'200':
description: OK
@@ -1588,12 +1665,17 @@ paths:
Delete the specified folder from a specified workspace and environment
using its ID
parameters:
- name: folderId
- name: folderName
in: path
required: true
schema:
type: string
- name: folderId
description: ID of the folder to be deleted
required: true
in: path
schema:
type: string
responses:
'200':
description: OK
@@ -2005,6 +2087,157 @@ paths:
responses:
'200':
description: OK
/api/v1/secret-approvals/:
get:
description: ''
responses:
'200':
description: OK
post:
description: ''
responses:
'200':
description: OK
/api/v1/secret-approvals/board:
get:
description: ''
responses:
'200':
description: OK
/api/v1/secret-approvals/{id}:
patch:
description: ''
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
delete:
description: ''
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/sso/redirect/google:
get:
description: ''
parameters:
- name: callback_port
in: query
schema:
type: string
responses:
default:
description: ''
/api/v1/sso/google:
get:
description: ''
responses:
default:
description: ''
/api/v1/sso/redirect/github:
get:
description: ''
parameters:
- name: callback_port
in: query
schema:
type: string
responses:
default:
description: ''
/api/v1/sso/github:
get:
description: ''
responses:
default:
description: ''
/api/v1/sso/redirect/gitlab:
get:
description: ''
parameters:
- name: callback_port
in: query
schema:
type: string
responses:
default:
description: ''
/api/v1/sso/gitlab:
get:
description: ''
responses:
default:
description: ''
/api/v1/secret-approval-requests/:
get:
description: ''
responses:
'200':
description: OK
/api/v1/secret-approval-requests/count:
get:
description: ''
responses:
'200':
description: OK
/api/v1/secret-approval-requests/{id}:
get:
description: ''
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/secret-approval-requests/{id}/merge:
post:
description: ''
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/secret-approval-requests/{id}/review:
post:
description: ''
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v1/secret-approval-requests/{id}/status:
post:
description: ''
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v2/signup/complete-account/signup:
post:
description: ''
@@ -2149,24 +2382,6 @@ paths:
responses:
'200':
description: OK
/api/v2/users/me:
get:
summary: Retrieve the current user on the request
description: Retrieve the current user on the request
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
user:
type: object
$ref: '#/components/schemas/CurrentUser'
description: Current user on request
security:
- apiKeyAuth: []
/api/v2/users/me/mfa:
patch:
description: ''
@@ -2240,6 +2455,29 @@ paths:
responses:
'200':
description: OK
/api/v2/users/me:
get:
summary: Retrieve the current user on the request
description: Retrieve the current user on the request
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
user:
type: object
$ref: '#/components/schemas/CurrentUser'
description: Current user on request
security:
- apiKeyAuth: []
delete:
description: ''
responses:
'200':
description: OK
/api/v2/organizations/{organizationId}/memberships:
get:
summary: Return organization memberships
@@ -2375,6 +2613,24 @@ paths:
responses:
'200':
description: OK
/api/v2/organizations/:
post:
description: ''
responses:
'200':
description: OK
/api/v2/organizations/{organizationId}:
delete:
description: ''
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v2/workspace/{workspaceId}/environments:
post:
summary: Create environment
@@ -3228,6 +3484,22 @@ paths:
responses:
'200':
description: OK
/api/v3/secrets/batch:
post:
description: ''
responses:
'200':
description: OK
patch:
description: ''
responses:
'200':
description: OK
delete:
description: ''
responses:
'200':
description: OK
/api/v3/secrets/{secretName}:
post:
description: ''
@@ -3309,6 +3581,18 @@ paths:
responses:
'200':
description: OK
/api/v3/workspaces/{workspaceId}/service-token:
get:
description: ''
parameters:
- name: workspaceId
in: path
required: true
schema:
type: string
responses:
'200':
description: OK
/api/v3/signup/complete-account/signup:
post:
description: ''
@@ -3785,7 +4069,7 @@ components:
type: http
scheme: bearer
bearerFormat: JWT
description:
description: >-
This security definition uses the HTTP 'bearer' scheme, which allows the
client to authenticate using a JSON Web Token (JWT) that is passed in
the Authorization header of the request.
@@ -3793,7 +4077,7 @@ components:
type: apiKey
in: header
name: X-API-Key
description:
description: >-
This security definition uses an API key, which is passed in the header
of the request as the value of the "X-API-Key" header. The client must
provide a valid key in order to access the API.