Validate Project Files

ValidateFiles validates the project files using deno check without deploying. It processes the files to build a Docker image and runs validation checks to ensure the TypeScript code is valid before deployment.

PUT /o/{organisation_id}/projects/{project_id}/validate

Validate Project Files

cURL

curl --request PUT \
  --url https://platform.versori.com/api/v2/o/{organisation_id}/projects/{project_id}/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "files": [
    {
      "filename": "<string>",
      "content": "<string>"
    }
  ],
  "labels": {}
}
'

200

{
  "project_id": "<string>",
  "environment": "<string>",
  "validation": {
    "duration": "<string>",
    "error": "<string>",
    "success": true,
    "output": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

bearerTokencookie

Authorization · string · header · required

Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.

Path Parameters

organisation_id · string<ulid> · required

project_id · string<ulid> · required

Body

application/json

files · object[] · required

The files associated with the project.

Show child attributes

labels · object · required

The labels associated with the project. Labels are stored as key-value pairs. Only string-string values are allowed

Response

200

application/json

OK

ValidationResult represents the response from project validation using deno check.

project_id · string · required

The project ID that was validated.

environment · string · required

The environment name where validation was performed.

validation · object · required

ValidationStatus represents the detailed status of project validation using deno check.

Show child attributes