Validation & Schema

Validate your nexlayer.yaml configuration files before deployment and integrate schema validation into your IDE.

POST/validate

Validate Configuration

Validate a nexlayer.yaml configuration file to check for errors before deploying. This helps catch configuration issues early.

Example Request

curl -X POST "https://app.nexlayer.io/validate" \
  -H "Content-Type: application/json" \
  -d '{
    "application": {
      "name": "my-app",
      "pods": [...]
    }
  }'

Response (200 OK)

{
  "message": "Nexlayer YAML file is valid."
}

Error Response (400)

{
  "valid": false,
  "errors": [
    "Missing required field: application.name",
    "Invalid pod configuration: image is required"
  ]
}

GET/schema

Get JSON Schema

Get the complete JSON schema for nexlayer.yaml files. Useful for IDE integration and building custom validation tools.

Example Request

curl -X GET "https://app.nexlayer.io/schema"

Response (200 OK)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "required": ["application"],
  "properties": {
    "application": {
      "type": "object",
      "required": ["name", "pods"],
      "properties": {
        "name": {
          "type": "string",
          "description": "Application name"
        },
        "pods": {
          "type": "array",
          "description": "Pod configurations"
        }
      }
    }
  }
}

VS Code Integration

Configure VS Code to validate your nexlayer.yaml files automatically:

1Install the YAML extension from the VS Code marketplace
2Add the following to your .vscode/settings.json:

.vscode/settings.json

{
  "yaml.schemas": {
    "https://app.nexlayer.io/schema": "nexlayer.yaml"
  }
}

POST/feedback

Send Feedback

Send feedback to the Nexlayer team. Use this to report bugs, request features, or share general feedback.

Parameters

Name	Type	Required	Description
`sessionID`	string	Required	Your session ID
`text`	string	Required	Feedback content

Example Request

curl -X POST "https://app.nexlayer.io/feedback" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionID": "B9wNA4eSNdy6P",
    "text": "Great service! Would love to see more deployment options."
  }'

Response (200 OK)

"OK"