diff --git a/platform/api.yml b/platform/api.yml index 3f55308e..540b5374 100644 --- a/platform/api.yml +++ b/platform/api.yml @@ -99,6 +99,7 @@ x-tagGroups: - Deployments - Scoped Variables - Services/Discovery + - Services/Gateway - Services/Load Balancer - Services/Scheduler - Services/VPN @@ -198,6 +199,8 @@ tags: - name: Scoped Variables description: Endpoints related to managing an environment's scoped variables. - name: Services/Discovery + description: Endpoints related to managing an environment's gateway service. + - name: Services/Gateway description: Endpoints related to managing an environment's discovery service. - name: Services/Load Balancer description: Endpoints related to managing an environment's load balancer service. @@ -456,6 +459,10 @@ paths: "/v1/environments/{environmentId}/services/discovery/tasks": $ref: "./paths/environments/services/discovery/tasks.yml" + ## Services/Gateway + "/v1/environments/{environmentId}/services/gateway/tasks": + $ref: "./paths/environments/services/gateway/tasks.yml" + ## Services/Load Balancer "/v1/environments/{environmentId}/services/lb": $ref: "./paths/environments/services/loadbalancer/loadbalancer.yml" diff --git a/platform/paths/environments/services/discovery/tasks.yml b/platform/paths/environments/services/discovery/tasks.yml index 33a448b0..14d82f3c 100644 --- a/platform/paths/environments/services/discovery/tasks.yml +++ b/platform/paths/environments/services/discovery/tasks.yml @@ -46,7 +46,7 @@ post: responses: 202: - description: Returns a Job Descriptor. + description: Returns a job descriptor. content: application/json: schema: diff --git a/platform/paths/environments/services/gateway/tasks.yml b/platform/paths/environments/services/gateway/tasks.yml new file mode 100644 index 00000000..2632dfd0 --- /dev/null +++ b/platform/paths/environments/services/gateway/tasks.yml @@ -0,0 +1,52 @@ +post: + operationId: "createGatewayServiceJob" + summary: Create Gateway Service Job + description: Creates a task that will update the gateway service's configuration. + tags: + - Services/Gateway + parameters: + - name: environmentId + description: The ID of the environment where this gateway service resides. + in: path + required: true + schema: + type: string + requestBody: + description: Parameters for reconfiguring a gateway service. + content: + application/json: + schema: + type: object + required: + - action + - contents + properties: + action: + type: string + enum: + - reconfigure + description: The name of the action to perform. + contents: + type: object + properties: + auto_update: + type: + - boolean + - "null" + description: A boolean where `true` represents the desire to automatically update the environment gateway service. + + responses: + 202: + description: Returns a job descriptor. + content: + application/json: + schema: + title: "TaskResponse" + type: object + required: + - data + properties: + data: + $ref: ../../../../../components/schemas/jobs/JobDescriptor.yml + default: + $ref: ../../../../../components/responses/errors/DefaultError.yml