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>
271 lines
6.9 KiB
YAML
271 lines
6.9 KiB
YAML
name: redirects
|
|
description: ''
|
|
endpoints:
|
|
-
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects'
|
|
metadata:
|
|
groupName: redirects
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: index
|
|
description: 'Get all redirects.'
|
|
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: []
|
|
site_id:
|
|
name: site_id
|
|
description: 'The ID of the site.'
|
|
required: true
|
|
example: 44
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanUrlParameters:
|
|
project_id: 1
|
|
server_id: 29
|
|
site_id: 44
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: '{"data":[{"id":null,"site_id":null,"mode":301,"from":"eaque","to":"http:\/\/www.windler.info\/delectus-facilis-assumenda-consequatur-impedit-hic-dolorem-non-dolore.html","status":"ready","created_at":null,"updated_at":null},{"id":null,"site_id":null,"mode":308,"from":"neque","to":"http:\/\/raynor.biz\/velit-a-tempore-quas-explicabo-doloremque","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 4fD5a38caEk1vZPdbVh66ge'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- POST
|
|
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects'
|
|
metadata:
|
|
groupName: redirects
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: create
|
|
description: 'Create a new redirect.'
|
|
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: []
|
|
site_id:
|
|
name: site_id
|
|
description: 'The ID of the site.'
|
|
required: true
|
|
example: 44
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanUrlParameters:
|
|
project_id: 1
|
|
server_id: 29
|
|
site_id: 44
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
from:
|
|
name: from
|
|
description: ''
|
|
required: true
|
|
example: qui
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
to:
|
|
name: to
|
|
description: ''
|
|
required: true
|
|
example: voluptatum
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
mode:
|
|
name: mode
|
|
description: ''
|
|
required: true
|
|
example: 302
|
|
type: string
|
|
enumValues:
|
|
- 301
|
|
- 302
|
|
- 307
|
|
- 308
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanBodyParameters:
|
|
from: qui
|
|
to: voluptatum
|
|
mode: 302
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: null
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer haPda6v1be64V8gcf3Dk5EZ'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/projects/{project_id}/servers/{server_id}/sites/{site_id}/redirects/{redirect_id}'
|
|
metadata:
|
|
groupName: redirects
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: delete
|
|
description: 'Delete a redirect.'
|
|
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: []
|
|
site_id:
|
|
name: site_id
|
|
description: 'The ID of the site.'
|
|
required: true
|
|
example: 44
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
redirect_id:
|
|
name: redirect_id
|
|
description: 'The ID of the redirect.'
|
|
required: true
|
|
example: 9
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanUrlParameters:
|
|
project_id: 1
|
|
server_id: 29
|
|
site_id: 44
|
|
redirect_id: 9
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 204
|
|
content: null
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer DVP8ve46k3dfhga5Z61bcEa'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|