2016-04-09 02:31:13 +02:00
|
|
|
swagger: '2.0'
|
|
|
|
info:
|
|
|
|
title: SEMAPHORE
|
|
|
|
description: Semaphore API
|
2017-02-23 06:12:16 +01:00
|
|
|
version: "2.2.0"
|
2016-04-09 02:31:13 +02:00
|
|
|
|
|
|
|
host: localhost:3000
|
|
|
|
|
2018-04-11 20:05:38 +02:00
|
|
|
consumes:
|
|
|
|
- application/json
|
|
|
|
produces:
|
|
|
|
- application/json
|
|
|
|
- text/plain; charset=utf-8
|
|
|
|
|
2016-04-09 21:45:38 +02:00
|
|
|
tags:
|
|
|
|
- name: authentication
|
|
|
|
description: Authentication, Logout & API Tokens
|
|
|
|
- name: project
|
|
|
|
description: Everything related to a project
|
|
|
|
- name: user
|
|
|
|
description: User-related API
|
|
|
|
|
2016-04-09 02:31:13 +02:00
|
|
|
schemes:
|
|
|
|
- http
|
|
|
|
- https
|
|
|
|
|
|
|
|
basePath: /api
|
|
|
|
|
|
|
|
definitions:
|
2018-04-11 20:05:38 +02:00
|
|
|
|
|
|
|
Pong:
|
|
|
|
type: string
|
|
|
|
x-example: pong
|
|
|
|
|
2016-04-09 02:31:13 +02:00
|
|
|
Login:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
auth:
|
|
|
|
type: string
|
|
|
|
description: Username/Email address
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: user@semaphore.com
|
2016-04-09 02:31:13 +02:00
|
|
|
password:
|
|
|
|
type: string
|
|
|
|
format: password
|
|
|
|
description: Password
|
2018-04-11 20:05:38 +02:00
|
|
|
|
|
|
|
UserRequest:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
name:
|
|
|
|
type: string
|
|
|
|
x-example: Integration Test User
|
2020-10-02 22:10:41 +02:00
|
|
|
example: Integration Test User
|
2018-04-11 20:05:38 +02:00
|
|
|
username:
|
|
|
|
type: string
|
|
|
|
x-example: test-user
|
2020-10-02 22:10:41 +02:00
|
|
|
example: test-user
|
2018-04-11 20:05:38 +02:00
|
|
|
email:
|
|
|
|
type: string
|
|
|
|
x-example: test@ansiblesemaphore.test
|
2020-10-02 22:10:41 +02:00
|
|
|
example: test@ansiblesemaphore.test
|
|
|
|
alert:
|
|
|
|
type: boolean
|
|
|
|
admin:
|
|
|
|
type: boolean
|
|
|
|
|
|
|
|
UserPutRequest:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
name:
|
|
|
|
type: string
|
|
|
|
x-example: Integration Test User2
|
|
|
|
example: Integration Test User2
|
|
|
|
username:
|
|
|
|
type: string
|
|
|
|
x-example: test-user2
|
|
|
|
example: test-user2
|
|
|
|
email:
|
|
|
|
type: string
|
|
|
|
x-example: test2@ansiblesemaphore.test
|
|
|
|
example: test2@ansiblesemaphore.test
|
2018-04-11 20:05:38 +02:00
|
|
|
alert:
|
|
|
|
type: boolean
|
|
|
|
admin:
|
|
|
|
type: boolean
|
2016-04-09 02:31:13 +02:00
|
|
|
User:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
minimum: 1
|
2016-04-09 02:31:13 +02:00
|
|
|
name:
|
|
|
|
type: string
|
|
|
|
username:
|
|
|
|
type: string
|
|
|
|
email:
|
|
|
|
type: string
|
|
|
|
created:
|
|
|
|
type: string
|
2018-04-11 20:05:38 +02:00
|
|
|
pattern: ^\d{4}-(?:0[0-9]{1}|1[0-2]{1})-[0-9]{2}T\d{2}:\d{2}:\d{2}Z$
|
2017-03-13 09:45:25 +01:00
|
|
|
alert:
|
|
|
|
type: boolean
|
2017-07-26 07:55:34 +02:00
|
|
|
admin:
|
|
|
|
type: boolean
|
2018-04-11 20:05:38 +02:00
|
|
|
|
2016-04-09 21:09:57 +02:00
|
|
|
APIToken:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
type: string
|
|
|
|
created:
|
|
|
|
type: string
|
2018-04-11 20:05:38 +02:00
|
|
|
pattern: ^\d{4}-(?:0[0-9]{1}|1[0-2]{1})-[0-9]{2}T\d{2}:\d{2}:\d{2}Z$
|
2016-04-09 21:09:57 +02:00
|
|
|
expired:
|
|
|
|
type: boolean
|
|
|
|
user_id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
minimum: 1
|
|
|
|
|
|
|
|
ProjectRequest:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
name:
|
|
|
|
type: string
|
2021-11-03 11:28:46 +01:00
|
|
|
example: Test
|
2018-04-11 20:05:38 +02:00
|
|
|
alert:
|
|
|
|
type: boolean
|
2016-04-09 21:09:57 +02:00
|
|
|
Project:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
minimum: 1
|
2016-04-09 21:09:57 +02:00
|
|
|
name:
|
|
|
|
type: string
|
2021-11-03 11:28:46 +01:00
|
|
|
example: Test
|
2016-04-09 21:09:57 +02:00
|
|
|
created:
|
|
|
|
type: string
|
2018-04-11 20:05:38 +02:00
|
|
|
pattern: ^\d{4}-(?:0[0-9]{1}|1[0-2]{1})-[0-9]{2}T\d{2}:\d{2}:\d{2}Z$
|
2017-03-13 09:45:25 +01:00
|
|
|
alert:
|
|
|
|
type: boolean
|
2018-04-11 20:05:38 +02:00
|
|
|
|
|
|
|
AccessKeyRequest:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
name:
|
|
|
|
type: string
|
2021-09-01 19:56:44 +02:00
|
|
|
x-example: None
|
|
|
|
example: None
|
2018-04-11 20:05:38 +02:00
|
|
|
type:
|
|
|
|
type: string
|
2021-09-01 19:56:44 +02:00
|
|
|
enum: [none,ssh,login_password]
|
|
|
|
x-example: none
|
2018-04-11 20:05:38 +02:00
|
|
|
project_id:
|
|
|
|
type: integer
|
|
|
|
minimum: 1
|
|
|
|
x-example: 2
|
2021-11-03 11:28:46 +01:00
|
|
|
|
2016-04-09 21:38:14 +02:00
|
|
|
AccessKey:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
type: integer
|
|
|
|
name:
|
|
|
|
type: string
|
2021-11-03 11:28:46 +01:00
|
|
|
example: Test
|
2016-04-09 21:38:14 +02:00
|
|
|
type:
|
|
|
|
type: string
|
2021-09-01 19:56:44 +02:00
|
|
|
enum: [none,ssh,login_password]
|
2016-04-09 21:38:14 +02:00
|
|
|
project_id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
|
|
|
|
EnvironmentRequest:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
name:
|
|
|
|
type: string
|
2021-11-03 11:28:46 +01:00
|
|
|
example: Test
|
2018-04-11 20:05:38 +02:00
|
|
|
project_id:
|
|
|
|
type: integer
|
|
|
|
minimum: 1
|
|
|
|
password:
|
|
|
|
type: string
|
|
|
|
json:
|
|
|
|
type: string
|
2021-11-03 11:28:46 +01:00
|
|
|
example: '{}'
|
|
|
|
|
2016-04-09 21:38:14 +02:00
|
|
|
Environment:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
minimum: 1
|
2016-04-11 12:02:10 +02:00
|
|
|
name:
|
|
|
|
type: string
|
2021-11-03 11:28:46 +01:00
|
|
|
example: Test
|
2016-04-09 21:38:14 +02:00
|
|
|
project_id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
minimum: 1
|
2016-04-09 21:38:14 +02:00
|
|
|
password:
|
|
|
|
type: string
|
|
|
|
json:
|
|
|
|
type: string
|
2021-11-03 11:28:46 +01:00
|
|
|
example: '{}'
|
2018-04-11 20:05:38 +02:00
|
|
|
|
|
|
|
InventoryRequest:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
name:
|
|
|
|
type: string
|
2021-11-03 11:28:46 +01:00
|
|
|
example: Test
|
2018-04-11 20:05:38 +02:00
|
|
|
project_id:
|
|
|
|
type: integer
|
|
|
|
minimum: 1
|
|
|
|
inventory:
|
|
|
|
type: string
|
|
|
|
ssh_key_id:
|
|
|
|
type: integer
|
|
|
|
minimum: 1
|
2021-09-01 21:17:28 +02:00
|
|
|
become_key_id:
|
|
|
|
type: integer
|
|
|
|
minimum: 1
|
2018-04-11 20:05:38 +02:00
|
|
|
type:
|
|
|
|
type: string
|
|
|
|
enum: [static, file]
|
2016-04-09 21:38:14 +02:00
|
|
|
Inventory:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
type: integer
|
2016-04-11 12:02:10 +02:00
|
|
|
name:
|
|
|
|
type: string
|
2021-11-03 11:28:46 +01:00
|
|
|
example: Test
|
2016-04-09 21:38:14 +02:00
|
|
|
project_id:
|
|
|
|
type: integer
|
|
|
|
inventory:
|
|
|
|
type: string
|
|
|
|
ssh_key_id:
|
|
|
|
type: integer
|
2021-09-01 21:17:28 +02:00
|
|
|
become_key_id:
|
|
|
|
type: integer
|
2016-04-09 21:38:14 +02:00
|
|
|
type:
|
|
|
|
type: string
|
2018-04-11 20:05:38 +02:00
|
|
|
enum: [static, file]
|
|
|
|
|
|
|
|
RepositoryRequest:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
name:
|
|
|
|
type: string
|
2021-11-03 11:28:46 +01:00
|
|
|
example: Test
|
2018-04-11 20:05:38 +02:00
|
|
|
project_id:
|
|
|
|
type: integer
|
|
|
|
git_url:
|
|
|
|
type: string
|
|
|
|
ssh_key_id:
|
|
|
|
type: integer
|
2016-04-09 21:38:14 +02:00
|
|
|
Repository:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
type: integer
|
2016-04-11 12:02:10 +02:00
|
|
|
name:
|
|
|
|
type: string
|
2021-11-03 11:28:46 +01:00
|
|
|
example: Test
|
2016-04-09 21:38:14 +02:00
|
|
|
project_id:
|
|
|
|
type: integer
|
|
|
|
git_url:
|
|
|
|
type: string
|
|
|
|
ssh_key_id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
|
2016-04-09 21:38:14 +02:00
|
|
|
Task:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
example: 23
|
2016-04-09 21:38:14 +02:00
|
|
|
template_id:
|
|
|
|
type: integer
|
|
|
|
status:
|
|
|
|
type: string
|
|
|
|
debug:
|
|
|
|
type: boolean
|
|
|
|
playbook:
|
|
|
|
type: string
|
|
|
|
environment:
|
|
|
|
type: string
|
2017-03-12 03:14:19 +01:00
|
|
|
TaskOutput:
|
2016-04-17 20:01:51 +02:00
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
task_id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
example: 23
|
2016-04-17 20:01:51 +02:00
|
|
|
task:
|
|
|
|
type: string
|
|
|
|
time:
|
|
|
|
type: string
|
|
|
|
format: date-time
|
|
|
|
output:
|
|
|
|
type: string
|
2018-04-11 20:05:38 +02:00
|
|
|
|
|
|
|
TemplateRequest:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
project_id:
|
|
|
|
type: integer
|
|
|
|
minimum: 1
|
|
|
|
inventory_id:
|
|
|
|
type: integer
|
|
|
|
minimum: 1
|
|
|
|
repository_id:
|
|
|
|
type: integer
|
|
|
|
minimum: 1
|
|
|
|
environment_id:
|
|
|
|
type: integer
|
|
|
|
minimum: 1
|
2021-10-27 14:40:52 +02:00
|
|
|
view_id:
|
|
|
|
type: integer
|
|
|
|
minimum: 1
|
2018-04-11 20:05:38 +02:00
|
|
|
alias:
|
|
|
|
type: string
|
2021-11-03 10:45:15 +01:00
|
|
|
example: Test
|
2018-04-11 20:05:38 +02:00
|
|
|
playbook:
|
|
|
|
type: string
|
2021-11-03 10:45:15 +01:00
|
|
|
example: test.yml
|
2018-04-11 20:05:38 +02:00
|
|
|
arguments:
|
|
|
|
type: string
|
2021-09-09 18:50:02 +02:00
|
|
|
description:
|
|
|
|
type: string
|
|
|
|
example: Hello, World!
|
2018-04-11 20:05:38 +02:00
|
|
|
override_args:
|
|
|
|
type: boolean
|
2016-04-09 21:38:14 +02:00
|
|
|
Template:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
minimum: 1
|
2016-04-09 21:38:14 +02:00
|
|
|
project_id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
minimum: 1
|
2016-04-09 21:38:14 +02:00
|
|
|
inventory_id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
minimum: 1
|
2016-04-09 21:38:14 +02:00
|
|
|
repository_id:
|
|
|
|
type: integer
|
|
|
|
environment_id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
minimum: 1
|
2021-10-27 14:40:52 +02:00
|
|
|
view_id:
|
|
|
|
type: integer
|
|
|
|
minimum: 1
|
2016-11-15 16:44:41 +01:00
|
|
|
alias:
|
|
|
|
type: string
|
2021-11-03 10:45:15 +01:00
|
|
|
example: Test
|
2016-04-09 21:38:14 +02:00
|
|
|
playbook:
|
|
|
|
type: string
|
2021-11-03 10:45:15 +01:00
|
|
|
example: test.yml
|
2016-04-09 21:38:14 +02:00
|
|
|
arguments:
|
|
|
|
type: string
|
2021-09-09 18:50:02 +02:00
|
|
|
description:
|
|
|
|
type: string
|
|
|
|
example: Hello, World!
|
2016-04-09 21:38:14 +02:00
|
|
|
override_args:
|
|
|
|
type: boolean
|
2018-04-11 20:05:38 +02:00
|
|
|
|
2021-09-06 16:26:35 +02:00
|
|
|
ScheduleRequest:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
type: integer
|
|
|
|
cron_format:
|
|
|
|
type: string
|
2021-09-06 17:45:43 +02:00
|
|
|
x-example: "* * * 1 *"
|
|
|
|
example: "* * * 1 *"
|
2021-09-06 16:26:35 +02:00
|
|
|
project_id:
|
|
|
|
type: integer
|
|
|
|
template_id:
|
|
|
|
type: integer
|
|
|
|
|
|
|
|
Schedule:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
type: integer
|
|
|
|
cron_format:
|
|
|
|
type: string
|
|
|
|
project_id:
|
|
|
|
type: integer
|
|
|
|
template_id:
|
|
|
|
type: integer
|
|
|
|
|
2021-10-27 14:25:51 +02:00
|
|
|
|
2021-10-27 14:40:52 +02:00
|
|
|
ViewRequest:
|
2021-10-27 14:25:51 +02:00
|
|
|
type: object
|
|
|
|
properties:
|
2021-10-27 14:40:52 +02:00
|
|
|
title:
|
2021-10-27 14:25:51 +02:00
|
|
|
type: string
|
2021-10-27 18:22:52 +02:00
|
|
|
example: Test
|
2021-10-27 14:25:51 +02:00
|
|
|
project_id:
|
|
|
|
type: integer
|
|
|
|
minimum: 1
|
2021-10-27 14:40:52 +02:00
|
|
|
position:
|
2021-10-27 14:25:51 +02:00
|
|
|
type: integer
|
|
|
|
minimum: 1
|
2021-10-27 14:40:52 +02:00
|
|
|
View:
|
2021-10-27 14:25:51 +02:00
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
id:
|
|
|
|
type: integer
|
2021-10-27 14:40:52 +02:00
|
|
|
title:
|
2021-10-27 14:25:51 +02:00
|
|
|
type: string
|
|
|
|
project_id:
|
|
|
|
type: integer
|
2021-10-27 14:40:52 +02:00
|
|
|
position:
|
2021-10-27 14:25:51 +02:00
|
|
|
type: integer
|
|
|
|
|
|
|
|
|
2016-04-16 21:42:57 +02:00
|
|
|
Event:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
project_id:
|
|
|
|
type: integer
|
2021-09-01 21:17:28 +02:00
|
|
|
user_id:
|
|
|
|
type: integer
|
2016-04-16 21:42:57 +02:00
|
|
|
object_id:
|
2018-04-11 20:05:38 +02:00
|
|
|
type:
|
|
|
|
- integer
|
|
|
|
- 'null'
|
2016-04-16 21:42:57 +02:00
|
|
|
object_type:
|
2018-04-11 20:05:38 +02:00
|
|
|
type:
|
|
|
|
- string
|
|
|
|
- 'null'
|
2016-04-16 21:42:57 +02:00
|
|
|
description:
|
|
|
|
type: string
|
2018-04-11 20:05:38 +02:00
|
|
|
|
2016-05-17 17:52:25 +02:00
|
|
|
InfoType:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
version:
|
|
|
|
type: string
|
|
|
|
updateBody:
|
|
|
|
type: string
|
|
|
|
update:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
tag_name:
|
|
|
|
type: string
|
2016-04-09 02:31:13 +02:00
|
|
|
|
2018-04-11 20:05:38 +02:00
|
|
|
securityDefinitions:
|
|
|
|
cookie:
|
|
|
|
type: apiKey
|
|
|
|
name: Cookie
|
|
|
|
in: header
|
|
|
|
bearer:
|
|
|
|
type: apiKey
|
|
|
|
name: Authorization
|
|
|
|
in: header
|
|
|
|
|
|
|
|
security:
|
|
|
|
- bearer: []
|
|
|
|
- cookie: []
|
2016-04-09 21:09:57 +02:00
|
|
|
|
|
|
|
parameters:
|
|
|
|
project_id:
|
|
|
|
name: project_id
|
|
|
|
description: Project ID
|
|
|
|
in: path
|
|
|
|
type: integer
|
|
|
|
required: true
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: 1
|
2016-04-09 21:09:57 +02:00
|
|
|
user_id:
|
|
|
|
name: user_id
|
|
|
|
description: User ID
|
|
|
|
in: path
|
|
|
|
type: integer
|
|
|
|
required: true
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: 2
|
2016-04-09 21:38:14 +02:00
|
|
|
key_id:
|
|
|
|
name: key_id
|
|
|
|
description: key ID
|
|
|
|
in: path
|
|
|
|
type: integer
|
|
|
|
required: true
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: 3
|
2016-04-09 21:38:14 +02:00
|
|
|
repository_id:
|
|
|
|
name: repository_id
|
|
|
|
description: repository ID
|
|
|
|
in: path
|
|
|
|
type: integer
|
|
|
|
required: true
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: 4
|
2016-04-09 21:38:14 +02:00
|
|
|
inventory_id:
|
|
|
|
name: inventory_id
|
|
|
|
description: inventory ID
|
|
|
|
in: path
|
|
|
|
type: integer
|
|
|
|
required: true
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: 5
|
2016-04-09 21:38:14 +02:00
|
|
|
environment_id:
|
|
|
|
name: environment_id
|
|
|
|
description: environment ID
|
|
|
|
in: path
|
|
|
|
type: integer
|
|
|
|
required: true
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: 6
|
2016-04-09 21:38:14 +02:00
|
|
|
template_id:
|
|
|
|
name: template_id
|
|
|
|
description: template ID
|
|
|
|
in: path
|
|
|
|
type: integer
|
|
|
|
required: true
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: 7
|
2016-04-17 20:01:51 +02:00
|
|
|
task_id:
|
|
|
|
name: task_id
|
|
|
|
description: task ID
|
|
|
|
in: path
|
|
|
|
type: integer
|
|
|
|
required: true
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: 8
|
2021-09-09 20:56:15 +02:00
|
|
|
schedule_id:
|
|
|
|
name: schedule_id
|
|
|
|
description: schedule ID
|
|
|
|
in: path
|
|
|
|
type: integer
|
|
|
|
required: true
|
|
|
|
x-example: 9
|
2021-10-27 18:22:52 +02:00
|
|
|
view_id:
|
|
|
|
name: view_id
|
|
|
|
description: view ID
|
|
|
|
in: path
|
|
|
|
type: integer
|
|
|
|
required: true
|
|
|
|
x-example: 10
|
2016-04-09 02:31:13 +02:00
|
|
|
paths:
|
|
|
|
/ping:
|
|
|
|
get:
|
|
|
|
summary: PING test
|
2018-04-11 20:05:38 +02:00
|
|
|
produces:
|
|
|
|
- text/plain
|
|
|
|
security: [] # No security
|
2016-04-09 02:31:13 +02:00
|
|
|
responses:
|
|
|
|
200:
|
2016-04-09 02:46:29 +02:00
|
|
|
description: Successful "PONG" reply
|
2016-04-09 02:31:13 +02:00
|
|
|
schema:
|
2018-04-11 20:05:38 +02:00
|
|
|
$ref: "#/definitions/Pong"
|
|
|
|
headers:
|
|
|
|
content-type:
|
|
|
|
type: string
|
|
|
|
x-example: text/plain; charset=utf-8
|
2016-04-09 21:09:57 +02:00
|
|
|
|
|
|
|
/ws:
|
|
|
|
get:
|
|
|
|
summary: Websocket handler
|
|
|
|
schemes:
|
|
|
|
- ws
|
|
|
|
- wss
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: OK
|
2018-10-22 09:19:33 +02:00
|
|
|
401:
|
2018-04-11 20:05:38 +02:00
|
|
|
description: not authenticated
|
|
|
|
|
2016-05-17 17:18:26 +02:00
|
|
|
/info:
|
|
|
|
get:
|
|
|
|
summary: Fetches information about semaphore
|
|
|
|
description: you must be authenticated to use this
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: ok
|
|
|
|
schema:
|
2016-05-17 17:52:25 +02:00
|
|
|
$ref: "#/definitions/InfoType"
|
|
|
|
|
2016-04-09 21:09:57 +02:00
|
|
|
# Authentication
|
2016-04-09 02:31:13 +02:00
|
|
|
/auth/login:
|
|
|
|
post:
|
2016-04-09 21:09:57 +02:00
|
|
|
tags:
|
|
|
|
- authentication
|
2016-04-09 02:31:13 +02:00
|
|
|
summary: Performs Login
|
2021-10-27 14:40:52 +02:00
|
|
|
description: Upon success you will be logged in
|
2018-04-11 20:05:38 +02:00
|
|
|
security: [] # No security
|
2016-04-09 02:31:13 +02:00
|
|
|
parameters:
|
|
|
|
- name: Login Body
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: '#/definitions/Login'
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: You are logged in
|
|
|
|
400:
|
|
|
|
description: something in body is missing / is invalid
|
2018-04-11 20:05:38 +02:00
|
|
|
|
2016-04-09 02:31:13 +02:00
|
|
|
/auth/logout:
|
|
|
|
post:
|
2016-04-09 21:09:57 +02:00
|
|
|
tags:
|
|
|
|
- authentication
|
2016-04-09 02:31:13 +02:00
|
|
|
summary: Destroys current session
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: Your session was successfully nuked
|
2016-04-09 21:09:57 +02:00
|
|
|
|
2018-04-11 20:05:38 +02:00
|
|
|
# User Tokens
|
2020-10-01 10:01:04 +02:00
|
|
|
/user/:
|
2016-04-09 02:31:13 +02:00
|
|
|
get:
|
2016-04-09 21:09:57 +02:00
|
|
|
tags:
|
|
|
|
- user
|
2016-04-09 02:31:13 +02:00
|
|
|
summary: Fetch logged in user
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: User
|
|
|
|
schema:
|
2016-04-09 21:09:57 +02:00
|
|
|
$ref: "#/definitions/User"
|
|
|
|
|
|
|
|
/user/tokens:
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- authentication
|
|
|
|
- user
|
|
|
|
summary: Fetch API tokens for user
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: API Tokens
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: "#/definitions/APIToken"
|
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- authentication
|
|
|
|
- user
|
|
|
|
summary: Create an API token
|
|
|
|
responses:
|
|
|
|
201:
|
|
|
|
description: API Token
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/APIToken"
|
2018-04-11 20:05:38 +02:00
|
|
|
|
2016-04-09 21:09:57 +02:00
|
|
|
/user/tokens/{api_token_id}:
|
|
|
|
parameters:
|
|
|
|
- name: api_token_id
|
|
|
|
in: path
|
|
|
|
type: string
|
|
|
|
required: true
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: "kwofd61g93-yuqvex8efmhjkgnbxlo8mp1tin6spyhu="
|
2016-04-09 21:09:57 +02:00
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- authentication
|
|
|
|
- user
|
|
|
|
summary: Expires API token
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: Expired API Token
|
|
|
|
|
2018-04-11 20:05:38 +02:00
|
|
|
# User Profiles
|
|
|
|
/users:
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- user
|
|
|
|
summary: Fetches all users
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: Users
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: "#/definitions/User"
|
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- user
|
|
|
|
summary: Creates a user
|
|
|
|
consumes:
|
|
|
|
- application/json
|
|
|
|
parameters:
|
|
|
|
- name: User
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/UserRequest"
|
|
|
|
responses:
|
|
|
|
400:
|
|
|
|
description: User creation failed
|
|
|
|
201:
|
|
|
|
description: User created
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/User"
|
|
|
|
|
2020-10-01 10:01:04 +02:00
|
|
|
/users/{user_id}/:
|
2018-04-11 20:05:38 +02:00
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/user_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- user
|
|
|
|
summary: Fetches a user profile
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: User profile
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/User"
|
|
|
|
put:
|
|
|
|
tags:
|
|
|
|
- user
|
|
|
|
summary: Updates user details
|
|
|
|
consumes:
|
|
|
|
- application/json
|
|
|
|
parameters:
|
|
|
|
- name: User
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
2020-10-02 22:10:41 +02:00
|
|
|
$ref: "#/definitions/UserPutRequest"
|
2018-04-11 20:05:38 +02:00
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: User Updated
|
|
|
|
|
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- user
|
|
|
|
summary: Deletes user
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: User deleted
|
|
|
|
|
|
|
|
/users/{user_id}/password:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/user_id"
|
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- user
|
|
|
|
summary: Updates user password
|
|
|
|
consumes:
|
|
|
|
- application/json
|
|
|
|
parameters:
|
|
|
|
- name: Password
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
password:
|
|
|
|
type: string
|
|
|
|
format: password
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: Password updated
|
|
|
|
|
2016-04-09 21:09:57 +02:00
|
|
|
# Projects
|
|
|
|
/projects:
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- projects
|
|
|
|
summary: Get projects
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: List of projects
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: "#/definitions/Project"
|
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- projects
|
|
|
|
summary: Create a new project
|
2018-04-11 20:05:38 +02:00
|
|
|
consumes:
|
|
|
|
- application/json
|
2016-04-09 21:09:57 +02:00
|
|
|
parameters:
|
|
|
|
- name: Project
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
2018-04-11 20:05:38 +02:00
|
|
|
$ref: '#/definitions/ProjectRequest'
|
2016-04-09 21:09:57 +02:00
|
|
|
responses:
|
2017-07-26 11:06:59 +02:00
|
|
|
201:
|
2016-04-09 21:09:57 +02:00
|
|
|
description: Created project
|
2018-04-11 20:05:38 +02:00
|
|
|
|
2016-04-16 21:42:57 +02:00
|
|
|
/events:
|
|
|
|
get:
|
|
|
|
summary: Get Events related to Semaphore and projects you are part of
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: Array of events in chronological order
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Event'
|
2017-07-25 06:50:45 +02:00
|
|
|
/events/last:
|
|
|
|
get:
|
|
|
|
summary: Get last 200 Events related to Semaphore and projects you are part of
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: Array of events in chronological order
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Event'
|
2016-04-16 21:42:57 +02:00
|
|
|
|
2020-10-01 10:01:04 +02:00
|
|
|
/project/{project_id}/:
|
2016-04-09 21:09:57 +02:00
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Fetch project
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: Project
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/Project"
|
2016-06-17 22:16:46 +02:00
|
|
|
put:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Update project
|
|
|
|
parameters:
|
|
|
|
- name: Project
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
name:
|
|
|
|
type: string
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: Project saved
|
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Delete project
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: Project deleted
|
2016-04-09 21:09:57 +02:00
|
|
|
|
2016-04-16 21:42:57 +02:00
|
|
|
/project/{project_id}/events:
|
|
|
|
parameters:
|
|
|
|
- $ref: '#/parameters/project_id'
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get Events related to this project
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: Array of events in chronological order
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Event'
|
|
|
|
|
2016-04-09 21:09:57 +02:00
|
|
|
# User management
|
|
|
|
/project/{project_id}/users:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get users linked to project
|
2017-03-16 16:59:33 +01:00
|
|
|
parameters:
|
|
|
|
- name: sort
|
|
|
|
in: query
|
|
|
|
required: true
|
|
|
|
type: string
|
2018-04-11 20:05:38 +02:00
|
|
|
enum: [name, username, email, admin]
|
2017-03-16 16:59:33 +01:00
|
|
|
description: sorting name
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: email
|
2017-03-16 16:59:33 +01:00
|
|
|
- name: order
|
|
|
|
in: query
|
|
|
|
required: true
|
|
|
|
type: string
|
2018-04-11 20:05:38 +02:00
|
|
|
enum: [asc, desc]
|
2017-03-16 16:59:33 +01:00
|
|
|
description: ordering manner
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: desc
|
2016-04-09 21:09:57 +02:00
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: Users
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: "#/definitions/User"
|
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Link user to project
|
|
|
|
parameters:
|
|
|
|
- name: User
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
user_id:
|
|
|
|
type: integer
|
2018-04-11 20:05:38 +02:00
|
|
|
minimum: 2
|
2016-04-09 21:09:57 +02:00
|
|
|
admin:
|
|
|
|
type: boolean
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: User added
|
|
|
|
/project/{project_id}/users/{user_id}:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
- $ref: "#/parameters/user_id"
|
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Removes user from project
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: User removed
|
|
|
|
/project/{project_id}/users/{user_id}/admin:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
- $ref: "#/parameters/user_id"
|
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Makes user admin
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: User made administrator
|
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Revoke admin privileges
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: User admin privileges revoked
|
2016-04-09 21:38:14 +02:00
|
|
|
|
|
|
|
# project access keys
|
|
|
|
/project/{project_id}/keys:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get access keys linked to project
|
2016-04-11 12:02:10 +02:00
|
|
|
parameters:
|
2018-04-11 20:05:38 +02:00
|
|
|
# TODO - the space in this parameter name results in a dredd warning
|
2016-04-11 12:02:10 +02:00
|
|
|
- name: Key type
|
|
|
|
in: query
|
|
|
|
required: false
|
|
|
|
type: string
|
2021-09-01 19:56:44 +02:00
|
|
|
enum: [none,ssh,login_password]
|
2016-04-11 12:02:10 +02:00
|
|
|
description: Filter by key type
|
2021-09-01 19:56:44 +02:00
|
|
|
x-example: none
|
2017-03-16 16:59:33 +01:00
|
|
|
- name: sort
|
|
|
|
in: query
|
|
|
|
required: true
|
|
|
|
type: string
|
2018-04-11 20:05:38 +02:00
|
|
|
enum: [name, type]
|
2017-03-16 16:59:33 +01:00
|
|
|
description: sorting name
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: type
|
2017-03-16 16:59:33 +01:00
|
|
|
- name: order
|
|
|
|
in: query
|
|
|
|
required: true
|
|
|
|
type: string
|
2018-04-11 20:05:38 +02:00
|
|
|
enum: [asc, desc]
|
2017-03-16 16:59:33 +01:00
|
|
|
description: ordering manner
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: asc
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: Access Keys
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: "#/definitions/AccessKey"
|
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Add access key
|
|
|
|
parameters:
|
|
|
|
- name: Access Key
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
2018-04-11 20:05:38 +02:00
|
|
|
$ref: "#/definitions/AccessKeyRequest"
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: Access Key created
|
|
|
|
400:
|
|
|
|
description: Bad type
|
|
|
|
/project/{project_id}/keys/{key_id}:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
- $ref: "#/parameters/key_id"
|
|
|
|
put:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Updates access key
|
|
|
|
parameters:
|
|
|
|
- name: Access Key
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
2018-04-11 20:05:38 +02:00
|
|
|
$ref: "#/definitions/AccessKeyRequest"
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: Key updated
|
|
|
|
400:
|
|
|
|
description: Bad type
|
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Removes access key
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: access key removed
|
|
|
|
|
|
|
|
# project repositories
|
|
|
|
/project/{project_id}/repositories:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get repositories
|
2017-03-16 16:59:33 +01:00
|
|
|
parameters:
|
|
|
|
- name: sort
|
|
|
|
in: query
|
|
|
|
required: true
|
|
|
|
type: string
|
2018-04-11 20:05:38 +02:00
|
|
|
enum: [name, git_url, ssh_key]
|
2017-03-16 16:59:33 +01:00
|
|
|
description: sorting name
|
|
|
|
- name: order
|
|
|
|
in: query
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
format: asc/desc
|
2018-04-11 20:05:38 +02:00
|
|
|
enum: [asc, desc]
|
2017-03-16 16:59:33 +01:00
|
|
|
description: ordering manner
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: repositories
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: "#/definitions/Repository"
|
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Add repository
|
|
|
|
parameters:
|
|
|
|
- name: Repository
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
2018-04-11 20:05:38 +02:00
|
|
|
$ref: "#/definitions/RepositoryRequest"
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: Repository created
|
|
|
|
/project/{project_id}/repositories/{repository_id}:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
- $ref: "#/parameters/repository_id"
|
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Removes repository
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: repository removed
|
|
|
|
|
|
|
|
# project inventory
|
|
|
|
/project/{project_id}/inventory:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get inventory
|
2017-03-16 16:59:33 +01:00
|
|
|
parameters:
|
|
|
|
- name: sort
|
|
|
|
in: query
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
description: sorting name
|
2018-04-11 20:05:38 +02:00
|
|
|
enum: [name, type]
|
2017-03-16 16:59:33 +01:00
|
|
|
- name: order
|
|
|
|
in: query
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
description: ordering manner
|
2018-04-11 20:05:38 +02:00
|
|
|
enum: [asc, desc]
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: inventory
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: "#/definitions/Inventory"
|
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: create inventory
|
|
|
|
parameters:
|
|
|
|
- name: Inventory
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
2018-04-11 20:05:38 +02:00
|
|
|
$ref: "#/definitions/InventoryRequest"
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
2017-03-11 07:00:13 +01:00
|
|
|
201:
|
2016-04-09 21:38:14 +02:00
|
|
|
description: inventory created
|
2017-03-10 15:56:23 +01:00
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/Inventory"
|
2016-04-09 21:38:14 +02:00
|
|
|
/project/{project_id}/inventory/{inventory_id}:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
- $ref: "#/parameters/inventory_id"
|
|
|
|
put:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Updates inventory
|
|
|
|
parameters:
|
|
|
|
- name: Inventory
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
2018-04-11 20:05:38 +02:00
|
|
|
$ref: "#/definitions/InventoryRequest"
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: Inventory updated
|
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Removes inventory
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: inventory removed
|
|
|
|
|
|
|
|
# project environment
|
|
|
|
/project/{project_id}/environment:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get environment
|
2017-03-16 16:59:33 +01:00
|
|
|
parameters:
|
|
|
|
- name: sort
|
|
|
|
in: query
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
format: name
|
|
|
|
description: sorting name
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: 'db-deploy'
|
2017-03-16 16:59:33 +01:00
|
|
|
- name: order
|
|
|
|
in: query
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
format: asc/desc
|
|
|
|
description: ordering manner
|
2018-04-11 20:05:38 +02:00
|
|
|
x-example: desc
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: environment
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: "#/definitions/Environment"
|
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Add environment
|
|
|
|
parameters:
|
|
|
|
- name: environment
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
2018-04-11 20:05:38 +02:00
|
|
|
$ref: "#/definitions/EnvironmentRequest"
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: Environment created
|
|
|
|
/project/{project_id}/environment/{environment_id}:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
- $ref: "#/parameters/environment_id"
|
2016-04-13 18:09:44 +02:00
|
|
|
put:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Update environment
|
|
|
|
parameters:
|
|
|
|
- name: environment
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
2018-04-11 20:05:38 +02:00
|
|
|
$ref: "#/definitions/EnvironmentRequest"
|
2016-04-13 18:09:44 +02:00
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: Environment Updated
|
2016-04-09 21:38:14 +02:00
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Removes environment
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: environment removed
|
|
|
|
|
|
|
|
# project templates
|
2016-12-22 08:51:25 +01:00
|
|
|
/project/{project_id}/templates:
|
2016-04-09 21:38:14 +02:00
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get template
|
2017-03-16 16:59:33 +01:00
|
|
|
parameters:
|
|
|
|
- name: sort
|
|
|
|
in: query
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
description: sorting name
|
2018-04-11 20:05:38 +02:00
|
|
|
enum: [alias, playbook, ssh_key, inventory, environment, repository]
|
2017-03-16 16:59:33 +01:00
|
|
|
- name: order
|
|
|
|
in: query
|
|
|
|
required: true
|
|
|
|
type: string
|
|
|
|
description: ordering manner
|
2018-04-11 20:05:38 +02:00
|
|
|
enum: [asc, desc]
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: template
|
|
|
|
schema:
|
2020-11-05 13:45:31 +01:00
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: "#/definitions/Template"
|
2016-04-09 21:38:14 +02:00
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: create template
|
|
|
|
parameters:
|
|
|
|
- name: template
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
2018-04-11 20:05:38 +02:00
|
|
|
$ref: "#/definitions/TemplateRequest"
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
2016-04-16 21:42:57 +02:00
|
|
|
201:
|
2016-04-09 21:38:14 +02:00
|
|
|
description: template created
|
2016-04-16 21:42:57 +02:00
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/Template"
|
2016-12-22 08:51:25 +01:00
|
|
|
/project/{project_id}/templates/{template_id}:
|
2016-04-09 21:38:14 +02:00
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
- $ref: "#/parameters/template_id"
|
2020-10-05 00:29:02 +02:00
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
2020-11-05 13:45:31 +01:00
|
|
|
summary: Get template
|
2020-10-05 00:29:02 +02:00
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: template object
|
|
|
|
schema:
|
2020-11-05 13:45:31 +01:00
|
|
|
$ref: "#/definitions/Template"
|
2016-04-09 21:38:14 +02:00
|
|
|
put:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Updates template
|
|
|
|
parameters:
|
|
|
|
- name: template
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
2018-04-11 20:05:38 +02:00
|
|
|
$ref: "#/definitions/TemplateRequest"
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: template updated
|
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Removes template
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: template removed
|
|
|
|
|
2021-09-06 16:26:35 +02:00
|
|
|
|
|
|
|
# project schedules
|
2021-09-09 20:56:15 +02:00
|
|
|
/project/{project_id}/schedules/{schedule_id}:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
- $ref: "#/parameters/schedule_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- schedule
|
|
|
|
summary: Get schedule
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: Schedule
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/Schedule"
|
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- schedule
|
|
|
|
summary: Deletes schedule
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: schedule deleted
|
|
|
|
put:
|
|
|
|
tags:
|
|
|
|
- schedule
|
|
|
|
summary: Updates schedule
|
|
|
|
parameters:
|
|
|
|
- name: schedule
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/ScheduleRequest"
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: schedule updated
|
|
|
|
|
2021-09-06 16:26:35 +02:00
|
|
|
/project/{project_id}/schedules:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- schedule
|
|
|
|
summary: create schedule
|
|
|
|
parameters:
|
|
|
|
- name: schedule
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/ScheduleRequest"
|
|
|
|
responses:
|
|
|
|
201:
|
|
|
|
description: schedule created
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/Schedule"
|
|
|
|
|
2021-10-27 14:40:52 +02:00
|
|
|
# project views
|
|
|
|
/project/{project_id}/views:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get view
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: view
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: "#/definitions/View"
|
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: create view
|
|
|
|
parameters:
|
|
|
|
- name: view
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/ViewRequest"
|
|
|
|
responses:
|
|
|
|
201:
|
|
|
|
description: view created
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/View"
|
|
|
|
/project/{project_id}/views/{view_id}:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
- $ref: "#/parameters/view_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get view
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: view object
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/View"
|
|
|
|
put:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Updates view
|
|
|
|
parameters:
|
|
|
|
- name: view
|
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/ViewRequest"
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: view updated
|
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Removes view
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: view removed
|
|
|
|
|
|
|
|
|
2021-09-06 16:26:35 +02:00
|
|
|
|
2016-04-09 21:38:14 +02:00
|
|
|
# tasks
|
|
|
|
/project/{project_id}/tasks:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
2017-07-25 06:50:45 +02:00
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get Tasks related to current project
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: Array of tasks in chronological order
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Task'
|
2016-04-09 21:38:14 +02:00
|
|
|
post:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Starts a job
|
|
|
|
parameters:
|
2016-12-21 11:33:08 +01:00
|
|
|
- name: task
|
2016-04-09 21:38:14 +02:00
|
|
|
in: body
|
|
|
|
required: true
|
|
|
|
schema:
|
2016-12-21 11:33:08 +01:00
|
|
|
type: object
|
|
|
|
properties:
|
|
|
|
template_id:
|
|
|
|
type: integer
|
|
|
|
debug:
|
|
|
|
type: boolean
|
|
|
|
dry_run:
|
|
|
|
type: boolean
|
|
|
|
playbook:
|
|
|
|
type: string
|
|
|
|
environment:
|
|
|
|
type: string
|
2016-04-09 21:38:14 +02:00
|
|
|
responses:
|
|
|
|
201:
|
|
|
|
description: Task queued
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/Task"
|
2017-07-25 06:50:45 +02:00
|
|
|
/project/{project_id}/tasks/last:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get last 200 Tasks related to current project
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: Array of tasks in chronological order
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: '#/definitions/Task'
|
2017-05-18 14:29:57 +02:00
|
|
|
/project/{project_id}/tasks/{task_id}:
|
|
|
|
parameters:
|
|
|
|
- $ref: "#/parameters/project_id"
|
|
|
|
- $ref: "#/parameters/task_id"
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get a single task
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: Task
|
|
|
|
schema:
|
|
|
|
$ref: "#/definitions/Task"
|
2018-04-11 20:05:38 +02:00
|
|
|
delete:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Deletes task (including output)
|
|
|
|
responses:
|
|
|
|
204:
|
|
|
|
description: task deleted
|
2016-04-17 20:01:51 +02:00
|
|
|
/project/{project_id}/tasks/{task_id}/output:
|
|
|
|
parameters:
|
|
|
|
- $ref: '#/parameters/project_id'
|
|
|
|
- $ref: '#/parameters/task_id'
|
|
|
|
get:
|
|
|
|
tags:
|
|
|
|
- project
|
|
|
|
summary: Get task output
|
|
|
|
responses:
|
|
|
|
200:
|
|
|
|
description: output
|
|
|
|
schema:
|
|
|
|
type: array
|
|
|
|
items:
|
|
|
|
$ref: "#/definitions/TaskOutput"
|