v4

latestOpenAPI 3.1.0Redoclyraw.githubusercontent.com2026-06-05101533.8 KB
Metadata

Get metadata validation result

Validate api metadata against "metadataSchema" in project's config file.

post/orgs/{orgId}/projects/{projectId}/scout/metadata/validate

Path parameters

orgIdstring required
Example:acme-inc

Organization ID.

projectIdstring required
Example:my-project

Project ID.

Headers

x-redocly-scout-versionstring
Example:1.0.0

Scout version.

Request body

Metadata required

Any object shape.

Example request

{
  "department": "IT"
}

Response

OK.

isValidboolean required

Example response

{
  "errors": [
    {
      "instancePath": "",
      "schemaPath": "#/required",
      "keyword": "required",
      "params": {
        "missingProperty": "owner"
      },
      "message": "must have required property 'owner'"
    }
  ]
}