openapi: 3.0.3
info:
  title: validation
  version: 0.0.1
components:
  schemas:
    OrgBmlValidationV0ModelsFieldValidationResponse:
      description: A response object for field validation errors.
      type: object
      required:
      - status
      - message
      - errors
      properties:
        status:
          description: The response status.
          type: integer
          format: int32
          minimum: 100
          maximum: 599
        message:
          description: The response message.
          type: string
          maxLength: 512
          minLength: 1
        errors:
          description: A set of field validation errors.
          type: array
          maxItems: 32
          items:
            $ref: '#/components/schemas/OrgBmlValidationV0ModelsFieldValidationError'
    OrgBmlValidationV0ModelsFieldValidationError:
      description: Error description object for a single field.
      type: object
      required:
      - path
      - message
      properties:
        path:
          description: The object path of the field.
          example: /searches/search.query
          type: string
          maxLength: 256
          minLength: 1
        message:
          description: A user friendly error message.
          example: Query parameter 'query' exceeds parameter maximum length of 512
            characters.
          type: string
          maxLength: 512
          minLength: 1
    OrgBmlValidationV0ModelsFieldValidationErrorEntry:
      description: A single validation error description.
      type: object
      required:
      - message
      - errors
      properties:
        message:
          description: A user friendly error message.
          example: Query parameter 'query' exceeds parameter maximum length of 512
            characters.
          type: string
          maxLength: 512
          minLength: 1
        errors:
          $ref: '#/components/schemas/OrgBmlValidationV0EnumsFieldValidationErrorType'
          description: A field validation type.
          example: isNull
    OrgBmlValidationV0ModelsConflictResourceExistsResponse:
      description: A response object for field 409 conflict errors resulting from
        trying to create a resource that already exists.
      type: object
      required:
      - status
      - message
      properties:
        status:
          description: The response status.
          type: integer
          format: int32
          minimum: 100
          maximum: 599
        message:
          description: The response message.
          type: string
          maxLength: 512
          minLength: 1
    OrgBmlValidationV0EnumsFieldValidationErrorType:
      description: Error types for field validation.
      type: string
      enum:
      - isNull
      - isEmpty
      - minimumLength
      - maximumLength
      - pattern
      - syntax