Redocly Scout (1.0)

Download OpenAPI description
openapi.json
openapi.yaml
Overview
API Support team@redocly.com
License Redocly
 Terms of Service
Languages
Servers
Mock server
https://redocly.com/_mock/docs/realm/scout/api/openapi/
Production main server.
https://{host}/api/

Remotes

Operations related to remotes.

Operations

Metadata

Operations related to metadata.

Operations

Get metadata validation result

Request

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

Path
orgIdstringrequired

Organization ID.

Example: acme-inc
projectIdstringrequired

Project ID.

Example: my-project
Headers
x-redocly-scout-versionstring

Scout version.

Example: 1.0.0
Bodyapplication/json
object(Metadata)

Any object shape.

curl -i -X POST \
  https://redocly.com/_mock/docs/realm/scout/api/openapi/orgs/acme-inc/projects/my-project/scout/metadata/validate \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-redocly-scout-version: 1.0.0' \
  -d '{
    "department": "IT"
  }'

Responses

OK.

Bodyapplication/json
isValidbooleanrequired
Example: false
errorsArray of objects

Array of metadata validation errors.

Example: [{"instancePath":"","schemaPath":"#/required","keyword":"required","params":{"missingProperty":"owner"},"message":"must have required property 'owner'"}]
Response
application/json
{
  "isValid": false,
  "errors": [
    { … }
  ]
}

Todos

Operations related to todos.

Operations

Tasks

Operations related to tasks.

Operations

Status

Operations related to status.

Operations