Redocly Metadata API

openapi: 3.2.0
info:
  version: '1.0'
  title: Redocly Scout Metadata API
  termsOfService: https://redocly.com/subscription-agreement
  contact:
    name: API Support
    email: team@redocly.com
  license:
    name: Redocly
    url: https://redocly.com/subscription-agreement
  description: Operations related to metadata.
servers:
- url: https://{host}/api
  variables:
    host:
      default: app.cba.au.redocly.com
      description: Server host.
  description: Production main server.
security:
- UserCookie: []
tags:
- name: Metadata
  description: Operations related to metadata.
paths:
  /orgs/{orgId}/projects/{projectId}/scout/metadata/validate:
    post:
      tags:
      - Metadata
      security:
      - ApiKey: []
      summary: Get metadata validation result
      description: Validate api metadata against "metadataSchema" in project's config file.
      operationId: validateMetadata
      parameters:
      - $ref: '#/components/parameters/X-Redocly-Scout-Version'
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/ProjectId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Metadata'
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetadataValidationResult'
        '400':
          $ref: '#/components/responses/BadRequestError'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  parameters:
    ProjectId:
      name: projectId
      description: Project ID.
      required: true
      in: path
      schema:
        type: string
        example: my-project
    OrgId:
      name: orgId
      description: Organization ID.
      required: true
      in: path
      schema:
        type: string
        example: acme-inc
    X-Redocly-Scout-Version:
      name: x-redocly-scout-version
      description: Scout version.
      required: false
      in: header
      schema:
        type: string
        example: 1.0.0
  schemas:
    Problem:
      type: object
      title: Problem
      properties:
        type:
          type: string
          format: uri-reference
          description: 'URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC 9457 (formerly RFC 7807), it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.

            '
          default: about:blank
          example: /some/uri-reference
        title:
          type: string
          description: 'Short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.

            '
          example: some title for the error situation
        status:
          type: integer
          format: int32
          description: 'HTTP status code generated by the origin server for this occurrence of the problem.

            '
          minimum: 100
          exclusiveMaximum: 600
          example: 400
        detail:
          type: string
          description: 'Human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.

            '
          example: some description for the error situation
        instance:
          type: string
          format: uri-reference
          description: 'URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.

            '
          example: /some/uri-reference#specific-occurrence-context
        object:
          type: string
          const: problem
      required:
      - type
      - title
      - status
      - object
    MetadataValidationResult:
      type: object
      properties:
        isValid:
          type: boolean
          example: false
        errors:
          type: array
          items:
            type: object
            properties:
              keyword:
                type: string
                description: Validation keyword.
              instancePath:
                type: string
                description: JSON Pointer to the location in the data instance.
                example: /prop/1/subProp
              schemaPath:
                type: string
                description: JSON Pointer to the location of the failing keyword in the schema.
              params:
                type: object
                description: Additional information about error.
                example:
                  missingProperty: owner
              propertyName:
                type: string
                description: Set for errors in `propertyNames` keyword schema.
              message:
                type: string
                description: Error message.
              schema:
                description: Value of the failing keyword in the schema.
              parentSchema:
                type: object
                description: Schema containing the keyword.
              data:
                description: Data validated by the keyword.
            required:
            - keyword
            - instancePath
            - schemaPath
            - params
            example:
              instancePath: ''
              schemaPath: '#/required'
              keyword: required
              params:
                missingProperty: owner
              message: must have required property 'owner'
          description: Array of metadata validation errors.
      required:
      - isValid
    Metadata:
      type: object
      description: Any object shape.
      example:
        department: IT
  responses:
    BadRequestError:
      description: Bad Request.
      content:
        application/problem+json:
          schema:
            description: Invalid credentials.
            $ref: '#/components/schemas/Problem'
    NotFoundError:
      description: Resource not found.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    UserCookie:
      type: apiKey
      in: cookie
      name: accessToken
      description: Default authentication scheme for interaction between browser and API.
    ApiKey:
      type: http
      scheme: bearer
      description: 'API key is required to access the API.

        You can get your API key from the [BlueHarvest dashboard](https://app.blueharvest.cloud).'
x-pagination: none