mirror of
https://github.com/vitodeploy/vito.git
synced 2025-04-23 19:52:20 +00:00
2a670146d8
* feat(api): Add endpoint for triggering site deployment
- Add POST /api/projects/{project}/servers/{server}/sites/{site}/deploy endpoint
- Add feature tests
* fix merge issue and generate api docs
* fix merge
---------
Co-authored-by: Saeed Vaziry <61919774+saeedvaziry@users.noreply.github.com>
Co-authored-by: Saeed Vaziry <mr.saeedvaziry@gmail.com>
309 lines
7.8 KiB
YAML
309 lines
7.8 KiB
YAML
## Autogenerated by Scribe. DO NOT MODIFY.
|
|
|
|
name: databases
|
|
description: ''
|
|
endpoints:
|
|
-
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/projects/{project_id}/servers/{server_id}/databases'
|
|
metadata:
|
|
groupName: databases
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: list
|
|
description: 'Get all databases.'
|
|
authenticated: true
|
|
custom: []
|
|
headers:
|
|
Authorization: 'Bearer YOUR-API-KEY'
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
project_id:
|
|
name: project_id
|
|
description: 'The ID of the project.'
|
|
required: true
|
|
example: 1
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
server_id:
|
|
name: server_id
|
|
description: 'The ID of the server.'
|
|
required: true
|
|
example: 29
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanUrlParameters:
|
|
project_id: 1
|
|
server_id: 29
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: '{"data":[{"id":null,"server_id":null,"name":"conn.bridget","status":"ready","created_at":null,"updated_at":null},{"id":null,"server_id":null,"name":"aiden47","status":"ready","created_at":null,"updated_at":null}],"links":{"first":"\/?page=1","last":"\/?page=1","prev":null,"next":null},"meta":{"current_page":1,"from":1,"last_page":1,"links":[{"url":null,"label":"« Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next »","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer 5vVfe3hcg1akP6Z8ba64dDE'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- POST
|
|
uri: 'api/projects/{project_id}/servers/{server_id}/databases'
|
|
metadata:
|
|
groupName: databases
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: create
|
|
description: 'Create a new database.'
|
|
authenticated: true
|
|
custom: []
|
|
headers:
|
|
Authorization: 'Bearer YOUR-API-KEY'
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
project_id:
|
|
name: project_id
|
|
description: 'The ID of the project.'
|
|
required: true
|
|
example: 1
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
server_id:
|
|
name: server_id
|
|
description: 'The ID of the server.'
|
|
required: true
|
|
example: 29
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanUrlParameters:
|
|
project_id: 1
|
|
server_id: 29
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
name: name
|
|
description: ''
|
|
required: true
|
|
example: vel
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
charset:
|
|
name: charset
|
|
description: ''
|
|
required: true
|
|
example: qui
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
collation:
|
|
name: collation
|
|
description: ''
|
|
required: true
|
|
example: autem
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanBodyParameters:
|
|
name: vel
|
|
charset: qui
|
|
collation: autem
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: '{"id":null,"server_id":null,"name":"rodolfo.bradtke","status":"ready","created_at":null,"updated_at":null}'
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer 3gf6ahcav1kb546DZeE8PdV'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/projects/{project_id}/servers/{server_id}/databases/{id}'
|
|
metadata:
|
|
groupName: databases
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: show
|
|
description: 'Get a database by ID.'
|
|
authenticated: true
|
|
custom: []
|
|
headers:
|
|
Authorization: 'Bearer YOUR-API-KEY'
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
project_id:
|
|
name: project_id
|
|
description: 'The ID of the project.'
|
|
required: true
|
|
example: 1
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
server_id:
|
|
name: server_id
|
|
description: 'The ID of the server.'
|
|
required: true
|
|
example: 29
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
id:
|
|
name: id
|
|
description: 'The ID of the database.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanUrlParameters:
|
|
project_id: 1
|
|
server_id: 29
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: '{"id":null,"server_id":null,"name":"rhane","status":"ready","created_at":null,"updated_at":null}'
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer VEvk3dP685Zahcf6a41bgDe'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/projects/{project_id}/servers/{server_id}/databases/{database_id}'
|
|
metadata:
|
|
groupName: databases
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: delete
|
|
description: 'Delete database.'
|
|
authenticated: true
|
|
custom: []
|
|
headers:
|
|
Authorization: 'Bearer YOUR-API-KEY'
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
project_id:
|
|
name: project_id
|
|
description: 'The ID of the project.'
|
|
required: true
|
|
example: 1
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
server_id:
|
|
name: server_id
|
|
description: 'The ID of the server.'
|
|
required: true
|
|
example: 29
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
database_id:
|
|
name: database_id
|
|
description: 'The ID of the database.'
|
|
required: true
|
|
example: 5
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanUrlParameters:
|
|
project_id: 1
|
|
server_id: 29
|
|
database_id: 5
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 204
|
|
content: null
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer dPZ8bga4DEh6V16ce35avfk'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|