-
Notifications
You must be signed in to change notification settings - Fork 30
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated API from documentation release
- Loading branch information
Auto Mation
committed
Dec 18, 2023
1 parent
70d15e1
commit 8f05884
Showing
8 changed files
with
148 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
api-specs/frontend-api/examples/build-upload-metadata-payload.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| { | ||
| "branch": "main", | ||
| "revision": "a594ac3df6506a04e041de2b2d7ca5bf813fd602", | ||
| "versionNumber": "2023.07.18.13.28", | ||
| "nodeJsVersion": 18, | ||
| "buildSuccessful": true, | ||
| "buildTime": "2023-11-21T08:14:31.830Z", | ||
| "buildDuration": 300, | ||
| "buildLog": "Build started...\nDependencies installed...\nBuild completed successfully!", | ||
| "deploy": true | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "message": "Upload successful.", | ||
| "status": "success" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| #%RAML 1.0 ResourceType | ||
|
|
||
| post: | ||
| description: Uploads your backend builds from your custom CI environment to the Studio. | ||
| body: | ||
| multipart/form-data: | ||
| type: BuildUpload | ||
| responses: | ||
| 200: | ||
| body: | ||
| application/json: | ||
| type: object | ||
| example: !include ../examples/build-upload-success.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| #%RAML 1.0 DataType | ||
| (package): Common | ||
| displayName: BuildMetadata | ||
| type: object | ||
| properties: | ||
| branch: | ||
| type: string | ||
| description: Name of the Git branch to deploy. | ||
| revision: | ||
| type: string | ||
| description: Full commit ID hash of the current HEAD. | ||
| versionNumber: | ||
| type: string | ||
| description: Current time represented in the format `YYYY.MM.DD.HH.mm`. This value should be unique and sortable. | ||
| nodeJsVersion: | ||
| type: integer | ||
| description: Node.js version for the [Extension runner](/../frontend-getting-started/development-concepts#extension-runner). | ||
| default: 18 | ||
| required: false | ||
| buildSuccessful: | ||
| type: boolean | ||
| description: | | ||
| If `true`, the build is marked as successful and [displayed in the Studio](/../frontend-studio/using-deployment-in-the-studio). | ||
| buildTime: | ||
| type: string | ||
| description: Date and time of the build in the [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339) format. For example, `2023-11-21T08:14:31.830Z`. | ||
| buildDuration: | ||
| type: integer | ||
| description: Build duration in seconds. | ||
| buildLog: | ||
| type: string | ||
| description: CI execution logs. | ||
| deploy: | ||
| type: boolean | ||
| description: | | ||
| If `true`, the build is automatically deployed to the staging environment, if `buildSuccessful` is `true`. | ||
| default: false | ||
| required: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| #%RAML 1.0 DataType | ||
| (package): Common | ||
| displayName: BuildUpload | ||
| type: object | ||
| properties: | ||
| metadata: | ||
| description: Metadata about the build. | ||
| type: BuildMetadata | ||
| required: true | ||
| example: !include ../examples/build-upload-metadata-payload.json | ||
| extension: | ||
| description: Javascript bundle containing all code of the backend extensions. | ||
| type: file | ||
| required: true | ||
| fileTypes: ['*.js'] | ||
| extension_map: | ||
| description: Map for the build file. When provided, exceptions will be logged with readable stack traces. | ||
| type: file | ||
| required: false | ||
| fileTypes: ['*.js.map'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| #%RAML 1.0 DataType | ||
| (package): Common | ||
| displayName: BuildUploadResult | ||
| type: object | ||
| properties: | ||
| status: | ||
| type: string | ||
| description: Status of the build. | ||
| enum: | ||
| - success | ||
| - failure | ||
| message: | ||
| type: string | ||
| description: Description of the upload result. |