mirror of
https://github.com/vitodeploy/vito.git
synced 2025-04-19 09:51:37 +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>
261 lines
6.6 KiB
YAML
261 lines
6.6 KiB
YAML
## Autogenerated by Scribe. DO NOT MODIFY.
|
|
|
|
name: projects
|
|
description: ''
|
|
endpoints:
|
|
-
|
|
httpMethods:
|
|
- GET
|
|
uri: api/projects
|
|
metadata:
|
|
groupName: projects
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: list
|
|
description: 'Get all projects.'
|
|
authenticated: true
|
|
custom: []
|
|
headers:
|
|
Authorization: 'Bearer YOUR-API-KEY'
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: '{"data":[{"id":3,"name":"Amara Jaskolski","created_at":"2025-03-29T20:43:56.000000Z","updated_at":"2025-03-29T20:43:56.000000Z"},{"id":4,"name":"Christy Kohler","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 5v83ePa1dah4bcE6VgfZDk6'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- POST
|
|
uri: api/projects
|
|
metadata:
|
|
groupName: projects
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: create
|
|
description: 'Create a new project.'
|
|
authenticated: true
|
|
custom: []
|
|
headers:
|
|
Authorization: 'Bearer YOUR-API-KEY'
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
name: name
|
|
description: 'The name of the project.'
|
|
required: true
|
|
example: temporibus
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanBodyParameters:
|
|
name: temporibus
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: '{"id":3,"name":"Prof. Enrico Wehner Sr.","created_at":"2025-03-29T20:43:56.000000Z","updated_at":"2025-03-29T20:43:56.000000Z"}'
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer Zk61vE43aagDbc5V68edhPf'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/projects/{id}'
|
|
metadata:
|
|
groupName: projects
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: show
|
|
description: 'Get a project by ID.'
|
|
authenticated: true
|
|
custom: []
|
|
headers:
|
|
Authorization: 'Bearer YOUR-API-KEY'
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
name: id
|
|
description: 'The ID of the project.'
|
|
required: true
|
|
example: 1
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanUrlParameters:
|
|
id: 1
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: '{"id":3,"name":"Zoie Feest","created_at":"2025-03-29T20:43:56.000000Z","updated_at":"2025-03-29T20:43:56.000000Z"}'
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer 6vfDgb435d8cPeV1EZa6hak'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- PUT
|
|
uri: 'api/projects/{id}'
|
|
metadata:
|
|
groupName: projects
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: update
|
|
description: 'Update project.'
|
|
authenticated: true
|
|
custom: []
|
|
headers:
|
|
Authorization: 'Bearer YOUR-API-KEY'
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
name: id
|
|
description: 'The ID of the project.'
|
|
required: true
|
|
example: 1
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanUrlParameters:
|
|
id: 1
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
name: name
|
|
description: 'The name of the project.'
|
|
required: true
|
|
example: sit
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
custom: []
|
|
cleanBodyParameters:
|
|
name: sit
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
status: 200
|
|
content: '{"id":3,"name":"Mr. Jayme Kuhlman DVM","created_at":"2025-03-29T20:43:56.000000Z","updated_at":"2025-03-29T20:43:56.000000Z"}'
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer 6gkaZVh3P5b81cf6ev4EdDa'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|
|
-
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/projects/{project_id}'
|
|
metadata:
|
|
groupName: projects
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: delete
|
|
description: 'Delete project.'
|
|
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: 204
|
|
content: null
|
|
headers: []
|
|
description: ''
|
|
custom: []
|
|
responseFields: []
|
|
auth:
|
|
- headers
|
|
- Authorization
|
|
- 'Bearer bfeg4DZ566cvdP813kVhEaa'
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
custom: []
|