Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions platform/api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ x-tagGroups:
- Deployments
- Scoped Variables
- Services/Discovery
- Services/Gateway
- Services/Load Balancer
- Services/Scheduler
- Services/VPN
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion platform/paths/environments/services/discovery/tasks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ post:

responses:
202:
description: Returns a Job Descriptor.
description: Returns a job descriptor.
content:
application/json:
schema:
Expand Down
52 changes: 52 additions & 0 deletions platform/paths/environments/services/gateway/tasks.yml
Original file line number Diff line number Diff line change
@@ -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
Loading