Add endpoint for reading & updating site deployment script (#562)

* 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>
This commit is contained in:
Dimitar Yanakiev
2025-03-29 22:49:28 +02:00
committed by GitHub
parent 03be2d3ee2
commit 7882d2022c
33 changed files with 4072 additions and 1701 deletions

View File

@ -35,7 +35,7 @@ endpoints:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
@ -43,7 +43,7 @@ endpoints:
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
server_id: 29
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
@ -52,7 +52,7 @@ endpoints:
responses:
-
status: 200
content: '{"data":[{"id":null,"server_id":null,"name":"amalia38","status":"ready","created_at":null,"updated_at":null},{"id":null,"server_id":null,"name":"troy.rippin","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
content: '{"data":[{"id":null,"server_id":null,"name":"joyce53","status":"ready","created_at":null,"updated_at":null},{"id":null,"server_id":null,"name":"eric55","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":"&laquo; Previous","active":false},{"url":"\/?page=1","label":"1","active":true},{"url":null,"label":"Next &raquo;","active":false}],"path":"\/","per_page":25,"to":2,"total":2}}'
headers: []
description: ''
custom: []
@ -60,7 +60,7 @@ endpoints:
auth:
- headers
- Authorization
- 'Bearer Z641ebPacDV6f38kEgdah5v'
- 'Bearer vegcPa1dk6f435E68ZbhaVD'
controller: null
method: null
route: null
@ -97,7 +97,7 @@ endpoints:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
@ -105,7 +105,7 @@ endpoints:
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
server_id: 29
queryParameters: []
cleanQueryParameters: []
bodyParameters:
@ -113,19 +113,41 @@ endpoints:
name: name
description: ''
required: true
example: et
example: debitis
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
charset:
name: charset
description: ''
required: true
example: maxime
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
collation:
name: collation
description: ''
required: true
example: sed
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
name: et
name: debitis
charset: maxime
collation: sed
fileParameters: []
responses:
-
status: 200
content: '{"id":null,"server_id":null,"name":"harvey.haskell","status":"ready","created_at":null,"updated_at":null}'
content: '{"id":null,"server_id":null,"name":"brekke.isabell","status":"ready","created_at":null,"updated_at":null}'
headers: []
description: ''
custom: []
@ -133,7 +155,7 @@ endpoints:
auth:
- headers
- Authorization
- 'Bearer d4gbv56caV3aZ8D1h6kfEPe'
- 'Bearer Vk1fhea8caEg4dvD35PbZ66'
controller: null
method: null
route: null
@ -170,7 +192,7 @@ endpoints:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
@ -180,7 +202,7 @@ endpoints:
name: id
description: 'The ID of the database.'
required: true
example: 19
example: 11
type: integer
enumValues: []
exampleWasSpecified: false
@ -188,8 +210,8 @@ endpoints:
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
id: 19
server_id: 29
id: 11
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
@ -198,7 +220,7 @@ endpoints:
responses:
-
status: 200
content: '{"id":null,"server_id":null,"name":"ruthie.koepp","status":"ready","created_at":null,"updated_at":null}'
content: '{"id":null,"server_id":null,"name":"vandervort.emmalee","status":"ready","created_at":null,"updated_at":null}'
headers: []
description: ''
custom: []
@ -206,7 +228,7 @@ endpoints:
auth:
- headers
- Authorization
- 'Bearer P68VgDcaEZvk63f4b5aed1h'
- 'Bearer av45D6PehEdbZVgc381akf6'
controller: null
method: null
route: null
@ -243,7 +265,7 @@ endpoints:
name: server_id
description: 'The ID of the server.'
required: true
example: 8
example: 29
type: integer
enumValues: []
exampleWasSpecified: false
@ -253,7 +275,7 @@ endpoints:
name: database_id
description: 'The ID of the database.'
required: true
example: 15
example: 5
type: integer
enumValues: []
exampleWasSpecified: false
@ -261,8 +283,8 @@ endpoints:
custom: []
cleanUrlParameters:
project_id: 1
server_id: 8
database_id: 15
server_id: 29
database_id: 5
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
@ -279,7 +301,7 @@ endpoints:
auth:
- headers
- Authorization
- 'Bearer DkPc6d1heEv5a8fb4V63agZ'
- 'Bearer hDa6EdgkP84fcV61baZ3v5e'
controller: null
method: null
route: null