mirror of
https://github.com/vitodeploy/vito.git
synced 2025-04-23 11:42:19 +00:00
7882d2022c
* feat(api): Add endpoint for updating site deployment script
- Add PUT /api/projects/{project}/servers/{server}/sites/{site}/deployment-script endpoint
- Add feature tests for successful and failed updates
* added reading deployment script as well
* generate docs
---------
Co-authored-by: Saeed Vaziry <mr.saeedvaziry@gmail.com>
373 lines
9.8 KiB
YAML
373 lines
9.8 KiB
YAML
## Autogenerated by Scribe. DO NOT MODIFY.
|
|
|
|
name: storage-providers
|
|
description: ''
|
|
endpoints:
|
|
-
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/projects/{project_id}/storage-providers'
|
|
metadata:
|
|
groupName: storage-providers
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: list
|
|
description: ''
|
|
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: []
|
|
cleanUrlParameters:
|
|
project_id: 1
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: '{"data":[{"id":5,"project_id":null,"global":true,"name":"sit","provider":"ftp","created_at":"2025-03-29T20:43:56.000000Z","updated_at":"2025-03-29T20:43:56.000000Z"},{"id":6,"project_id":null,"global":true,"name":"repudiandae","provider":"local","created_at":"2025-03-29T20:43:56.000000Z","updated_at":"2025-03-29T20:43:56.000000Z"}],"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 EbkDP1Z3aVav8g6ef6dc5h4'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- POST
|
|
uri: 'api/projects/{project_id}/storage-providers'
|
|
metadata:
|
|
groupName: storage-providers
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: create
|
|
description: ''
|
|
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: []
|
|
cleanUrlParameters:
|
|
project_id: 1
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
provider:
|
|
name: provider
|
|
description: 'The provider (aws, linode, hetzner, digitalocean, vultr, ...)'
|
|
required: true
|
|
example: est
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
name:
|
|
name: name
|
|
description: 'The name of the storage provider.'
|
|
required: true
|
|
example: id
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
token:
|
|
name: token
|
|
description: 'The token if provider requires api token'
|
|
required: true
|
|
example: repellendus
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
key:
|
|
name: key
|
|
description: 'The key if provider requires key'
|
|
required: true
|
|
example: ducimus
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
secret:
|
|
name: secret
|
|
description: 'The secret if provider requires key'
|
|
required: true
|
|
example: possimus
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanBodyParameters:
|
|
provider: est
|
|
name: id
|
|
token: repellendus
|
|
key: ducimus
|
|
secret: possimus
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: '{"id":5,"project_id":null,"global":true,"name":"sequi","provider":"dropbox","created_at":"2025-03-29T20:43:56.000000Z","updated_at":"2025-03-29T20:43:56.000000Z"}'
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer 45kVPD6ec6hvga83bfa1dEZ'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}'
|
|
metadata:
|
|
groupName: storage-providers
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: show
|
|
description: ''
|
|
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: []
|
|
storageProvider_id:
|
|
name: storageProvider_id
|
|
description: 'The ID of the storageProvider.'
|
|
required: true
|
|
example: 3
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanUrlParameters:
|
|
project_id: 1
|
|
storageProvider_id: 3
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: '{"id":5,"project_id":null,"global":true,"name":"alias","provider":"ftp","created_at":"2025-03-29T20:43:56.000000Z","updated_at":"2025-03-29T20:43:56.000000Z"}'
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer ahb6gDd8fv3P1ak6cEe4V5Z'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- PUT
|
|
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}'
|
|
metadata:
|
|
groupName: storage-providers
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: update
|
|
description: ''
|
|
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: []
|
|
storageProvider_id:
|
|
name: storageProvider_id
|
|
description: 'The ID of the storageProvider.'
|
|
required: true
|
|
example: 3
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanUrlParameters:
|
|
project_id: 1
|
|
storageProvider_id: 3
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
name: name
|
|
description: 'The name of the storage provider.'
|
|
required: true
|
|
example: ullam
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
global:
|
|
name: global
|
|
description: 'Accessible in all projects'
|
|
required: true
|
|
example: true
|
|
type: string
|
|
enumValues:
|
|
- true
|
|
- false
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanBodyParameters:
|
|
name: ullam
|
|
global: true
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: '{"id":5,"project_id":null,"global":true,"name":"at","provider":"ftp","created_at":"2025-03-29T20:43:56.000000Z","updated_at":"2025-03-29T20:43:56.000000Z"}'
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer a8Vgfvh5abkd616eDZ43cPE'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/projects/{project_id}/storage-providers/{storageProvider_id}'
|
|
metadata:
|
|
groupName: storage-providers
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: delete
|
|
description: ''
|
|
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: []
|
|
storageProvider_id:
|
|
name: storageProvider_id
|
|
description: 'The ID of the storageProvider.'
|
|
required: true
|
|
example: 3
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanUrlParameters:
|
|
project_id: 1
|
|
storageProvider_id: 3
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 204
|
|
content: null
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer kDheaPEvb61Va564dZc8f3g'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|