Skip to content

Commit 6c2717a

Browse files
galer7galer7
committed
Update openapi spec
1 parent 3ac52af commit 6c2717a

File tree

1 file changed

+250
-0
lines changed

1 file changed

+250
-0
lines changed

‎openapi.yaml

Lines changed: 250 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3932,6 +3932,256 @@ paths:
39323932
security:
39333933
-
39343934
bearerAuth: []
3935+
'/services/{uuid}/envs':
3936+
get:
3937+
tags:
3938+
- Services
3939+
summary: 'List Envs'
3940+
description: 'List all envs by service UUID.'
3941+
operationId: list-envs-by-service-uuid
3942+
parameters:
3943+
-
3944+
name: uuid
3945+
in: path
3946+
description: 'UUID of the service.'
3947+
required: true
3948+
schema:
3949+
type: string
3950+
format: uuid
3951+
responses:
3952+
'200':
3953+
description: 'All environment variables by service UUID.'
3954+
content:
3955+
application/json:
3956+
schema:
3957+
type: array
3958+
items:
3959+
$ref: '#/components/schemas/EnvironmentVariable'
3960+
'401':
3961+
$ref: '#/components/responses/401'
3962+
'400':
3963+
$ref: '#/components/responses/400'
3964+
'404':
3965+
$ref: '#/components/responses/404'
3966+
security:
3967+
-
3968+
bearerAuth: []
3969+
post:
3970+
tags:
3971+
- Services
3972+
summary: 'Create Env'
3973+
description: 'Create env by service UUID.'
3974+
operationId: create-env-by-service-uuid
3975+
parameters:
3976+
-
3977+
name: uuid
3978+
in: path
3979+
description: 'UUID of the service.'
3980+
required: true
3981+
schema:
3982+
type: string
3983+
format: uuid
3984+
requestBody:
3985+
description: 'Env created.'
3986+
required: true
3987+
content:
3988+
application/json:
3989+
schema:
3990+
properties:
3991+
key:
3992+
type: string
3993+
description: 'The key of the environment variable.'
3994+
value:
3995+
type: string
3996+
description: 'The value of the environment variable.'
3997+
is_preview:
3998+
type: boolean
3999+
description: 'The flag to indicate if the environment variable is used in preview deployments.'
4000+
is_build_time:
4001+
type: boolean
4002+
description: 'The flag to indicate if the environment variable is used in build time.'
4003+
is_literal:
4004+
type: boolean
4005+
description: 'The flag to indicate if the environment variable is a literal, nothing espaced.'
4006+
is_multiline:
4007+
type: boolean
4008+
description: 'The flag to indicate if the environment variable is multiline.'
4009+
is_shown_once:
4010+
type: boolean
4011+
description: "The flag to indicate if the environment variable's value is shown on the UI."
4012+
type: object
4013+
responses:
4014+
'201':
4015+
description: 'Environment variable created.'
4016+
content:
4017+
application/json:
4018+
schema:
4019+
properties:
4020+
uuid: { type: string, example: nc0k04gk8g0cgsk440g0koko }
4021+
type: object
4022+
'401':
4023+
$ref: '#/components/responses/401'
4024+
'400':
4025+
$ref: '#/components/responses/400'
4026+
'404':
4027+
$ref: '#/components/responses/404'
4028+
security:
4029+
-
4030+
bearerAuth: []
4031+
patch:
4032+
tags:
4033+
- Services
4034+
summary: 'Update Env'
4035+
description: 'Update env by service UUID.'
4036+
operationId: update-env-by-service-uuid
4037+
parameters:
4038+
-
4039+
name: uuid
4040+
in: path
4041+
description: 'UUID of the service.'
4042+
required: true
4043+
schema:
4044+
type: string
4045+
format: uuid
4046+
requestBody:
4047+
description: 'Env updated.'
4048+
required: true
4049+
content:
4050+
application/json:
4051+
schema:
4052+
required:
4053+
- key
4054+
- value
4055+
properties:
4056+
key:
4057+
type: string
4058+
description: 'The key of the environment variable.'
4059+
value:
4060+
type: string
4061+
description: 'The value of the environment variable.'
4062+
is_preview:
4063+
type: boolean
4064+
description: 'The flag to indicate if the environment variable is used in preview deployments.'
4065+
is_build_time:
4066+
type: boolean
4067+
description: 'The flag to indicate if the environment variable is used in build time.'
4068+
is_literal:
4069+
type: boolean
4070+
description: 'The flag to indicate if the environment variable is a literal, nothing espaced.'
4071+
is_multiline:
4072+
type: boolean
4073+
description: 'The flag to indicate if the environment variable is multiline.'
4074+
is_shown_once:
4075+
type: boolean
4076+
description: "The flag to indicate if the environment variable's value is shown on the UI."
4077+
type: object
4078+
responses:
4079+
'201':
4080+
description: 'Environment variable updated.'
4081+
content:
4082+
application/json:
4083+
schema:
4084+
properties:
4085+
message: { type: string, example: 'Environment variable updated.' }
4086+
type: object
4087+
'401':
4088+
$ref: '#/components/responses/401'
4089+
'400':
4090+
$ref: '#/components/responses/400'
4091+
'404':
4092+
$ref: '#/components/responses/404'
4093+
security:
4094+
-
4095+
bearerAuth: []
4096+
'/services/{uuid}/envs/bulk':
4097+
patch:
4098+
tags:
4099+
- Services
4100+
summary: 'Update Envs (Bulk)'
4101+
description: 'Update multiple envs by service UUID.'
4102+
operationId: update-envs-by-service-uuid
4103+
parameters:
4104+
-
4105+
name: uuid
4106+
in: path
4107+
description: 'UUID of the service.'
4108+
required: true
4109+
schema:
4110+
type: string
4111+
format: uuid
4112+
requestBody:
4113+
description: 'Bulk envs updated.'
4114+
required: true
4115+
content:
4116+
application/json:
4117+
schema:
4118+
required:
4119+
- data
4120+
properties:
4121+
data:
4122+
type: array
4123+
items: { properties: { key: { type: string, description: 'The key of the environment variable.' }, value: { type: string, description: 'The value of the environment variable.' }, is_preview: { type: boolean, description: 'The flag to indicate if the environment variable is used in preview deployments.' }, is_build_time: { type: boolean, description: 'The flag to indicate if the environment variable is used in build time.' }, is_literal: { type: boolean, description: 'The flag to indicate if the environment variable is a literal, nothing espaced.' }, is_multiline: { type: boolean, description: 'The flag to indicate if the environment variable is multiline.' }, is_shown_once: { type: boolean, description: "The flag to indicate if the environment variable's value is shown on the UI." } }, type: object }
4124+
type: object
4125+
responses:
4126+
'201':
4127+
description: 'Environment variables updated.'
4128+
content:
4129+
application/json:
4130+
schema:
4131+
properties:
4132+
message: { type: string, example: 'Environment variables updated.' }
4133+
type: object
4134+
'401':
4135+
$ref: '#/components/responses/401'
4136+
'400':
4137+
$ref: '#/components/responses/400'
4138+
'404':
4139+
$ref: '#/components/responses/404'
4140+
security:
4141+
-
4142+
bearerAuth: []
4143+
'/services/{uuid}/envs/{env_uuid}':
4144+
delete:
4145+
tags:
4146+
- Services
4147+
summary: 'Delete Env'
4148+
description: 'Delete env by UUID.'
4149+
operationId: delete-env-by-service-uuid
4150+
parameters:
4151+
-
4152+
name: uuid
4153+
in: path
4154+
description: 'UUID of the service.'
4155+
required: true
4156+
schema:
4157+
type: string
4158+
format: uuid
4159+
-
4160+
name: env_uuid
4161+
in: path
4162+
description: 'UUID of the environment variable.'
4163+
required: true
4164+
schema:
4165+
type: string
4166+
format: uuid
4167+
responses:
4168+
'200':
4169+
description: 'Environment variable deleted.'
4170+
content:
4171+
application/json:
4172+
schema:
4173+
properties:
4174+
message: { type: string, example: 'Environment variable deleted.' }
4175+
type: object
4176+
'401':
4177+
$ref: '#/components/responses/401'
4178+
'400':
4179+
$ref: '#/components/responses/400'
4180+
'404':
4181+
$ref: '#/components/responses/404'
4182+
security:
4183+
-
4184+
bearerAuth: []
39354185
/teams:
39364186
get:
39374187
tags:

0 commit comments

Comments
 (0)