Validate manifest

POST

/manifests/validate

const url = 'https://shoehorn.example.com/api/v1/manifests/validate';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"content":"example","format":"shoehorn"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://shoehorn.example.com/api/v1/manifests/validate \
  --header 'Content-Type: application/json' \
  --data '{ "content": "example", "format": "shoehorn" }'

Validates a manifest YAML against the schema without creating it.

Request Body^required

application/json

object

content

required

YAML manifest content

string

format

string

default: shoehorn

Allowed values: shoehorn backstage

Responses

200

Validation results

application/json

object

valid

boolean

errors

Array<object>

object

field

string

message

string

Example ^generated

{
  "valid": true,
  "errors": [
    {
      "field": "example",
      "message": "example"
    }
  ]
}

Validate manifest

Request Body required

Responses

200

Example generated

Request Body^required

Example ^generated