Affinda Deprecated End Points API

openapi: 3.0.3
info:
  title: Affinda Annotations Add x-hidden to endpoints Deprecated End Points API
  version: 3.0.0
  description: Affinda Annotations API — subset of the Affinda v3 Document Processing API.
servers:
- url: https://{region}.affinda.com
  description: 'Select the correct server for your instance: api (AUS/Global), api.us1 (US), or api.eu1 (EU).'
  variables:
    region:
      default: api
      description: The instance region. Use 'api' for AUS/Global, 'api.us1' for US, or 'api.eu1' for EU. You can find your region in the Affinda web app URL.
      enum:
      - api
      - api.eu1
      - api.us1
      x-ms-parameter-location: client
security:
- ApiKeyAuth: []
tags:
- name: Deprecated End Points
  description: 'Deprecated endpoints that are maintained for backward compatibility.


    These endpoints include Data Point, Collection, and Users functionality that has been superseded by newer APIs.

    '
paths:
  /v3/collections:
    get:
      tags:
      - Deprecated End Points
      summary: Get list of all collections
      operationId: getAllCollections
      description: Returns your collections.
      deprecated: true
      parameters:
      - in: query
        name: workspace
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
        description: Filter by workspace.
      responses:
        '200':
          description: All matching collections.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Collection'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    post:
      tags:
      - Deprecated End Points
      summary: Create a collection
      operationId: createCollection
      description: Create a collection
      deprecated: true
      responses:
        '201':
          description: Successfully created a collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collection'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CollectionCreate'
  /v3/collections/{identifier}:
    get:
      tags:
      - Deprecated End Points
      summary: Get specific collection
      operationId: getCollection
      description: Return a specific collection.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: Collection's identifier
        schema:
          $ref: '#/components/schemas/properties-identifier'
      responses:
        '200':
          description: Successfully retrieved collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collection'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    patch:
      tags:
      - Deprecated End Points
      summary: Update a collection
      operationId: updateCollection
      description: Update data of a collection.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: Collection's identifier
        schema:
          $ref: '#/components/schemas/properties-identifier'
      requestBody:
        description: Collection data to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CollectionUpdate'
      responses:
        '200':
          description: Successfully updated collection data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Collection'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    delete:
      tags:
      - Deprecated End Points
      summary: Delete a collection
      operationId: deleteCollection
      description: Deletes the specified collection from the database.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: Collection's identifier
        schema:
          $ref: '#/components/schemas/properties-identifier'
      responses:
        '204':
          $ref: '#/components/responses/204NoContent'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
  /v3/collections/{identifier}/create_data_field:
    post:
      tags:
      - Deprecated End Points
      summary: Create data field for a collection along with a new data point.
      operationId: createDataFieldForCollection
      description: Create data field for a collection along with a new data point.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: Collection's identifier
        schema:
          $ref: '#/components/schemas/properties-identifier'
      requestBody:
        description: The data field and data point to be created.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataFieldCreate'
      responses:
        '200':
          description: Successfully created data field and data point.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataField'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
  /v3/collections/{identifier}/fields/{datapoint_identifier}:
    get:
      tags:
      - Deprecated End Points
      summary: Get data field for a collection assosciated with a data point.
      operationId: getDataFieldForCollection
      description: Get a data field for a collection assosciated with a data point
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: Collection's identifier
        schema:
          $ref: '#/components/schemas/properties-identifier'
      - in: path
        required: true
        name: datapoint_identifier
        description: Datapoint's identifier
        schema:
          $ref: '#/components/schemas/DataPoint_properties-identifier'
      responses:
        '200':
          description: Successfully retrieved data field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionField'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    patch:
      tags:
      - Deprecated End Points
      summary: Update data field for a collection assosciated with a data point.
      operationId: updateDataFieldForCollection
      description: Update data field for a collection assosciated with a data point
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: Collection's identifier
        schema:
          $ref: '#/components/schemas/properties-identifier'
      - in: path
        required: true
        name: datapoint_identifier
        description: Datapoint's identifier
        schema:
          $ref: '#/components/schemas/DataPoint_properties-identifier'
      requestBody:
        description: Data field properties to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CollectionField'
      responses:
        '200':
          description: Successfully updated data field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionField'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
  /v3/collections/{identifier}/usage:
    get:
      tags:
      - Deprecated End Points
      summary: Get usage by collection
      operationId: getUsageByCollection
      description: 'Return monthly credits consumption of a collection.

        Deprecated: use `GET /v3/usage?organization={id}&document_type={id}` instead. The new endpoint returns a unified daily series and uses the modern "document type" terminology.'
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: Collection's identifier
        schema:
          $ref: '#/components/schemas/properties-identifier'
      - in: query
        required: false
        name: start
        description: 'Start date of the period to retrieve. Format: YYYY-MM'
        schema:
          type: string
          example: 2023-07
      - in: query
        required: false
        name: end
        description: 'End date of the period to retrieve. Format: YYYY-MM'
        schema:
          type: string
          example: 2023-10
      responses:
        '200':
          description: Monthly credits consumption of a collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageByCollectionResponse'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
  /v3/data_points:
    get:
      tags:
      - Deprecated End Points
      summary: Get list of all data points
      operationId: getAllDataPoints
      description: Returns your custom data points as well as Affinda's off-the-shelf data points.
      deprecated: true
      parameters:
      - $ref: '#/components/parameters/offsetParam'
      - $ref: '#/components/parameters/limitParam'
      - in: query
        name: organization
        schema:
          $ref: '#/components/schemas/Organization_properties-identifier'
        description: Filter by organization.
      - in: query
        name: include_public
        schema:
          type: boolean
        description: Allows you to include public data points in the response when you're filtering by organization.
      - in: query
        name: extractor
        schema:
          $ref: '#/components/schemas/Extractor_properties-identifier'
        description: Filter by extractor.
      - in: query
        name: slug
        schema:
          type: string
        description: Filter by slug.
      - in: query
        name: description
        schema:
          type: string
        description: Filter by description.
      - in: query
        name: annotation_content_type
        schema:
          type: string
        description: Filter by annotation content type, e.g. text, integer, float, date, etc.
      - in: query
        name: identifier
        schema:
          type: array
          items:
            $ref: '#/components/schemas/DataPoint_properties-identifier'
        description: Filter by specific identifiers.
      responses:
        '200':
          description: All matching data points.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataPoint'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    post:
      tags:
      - Deprecated End Points
      summary: Create a data point
      operationId: createDataPoint
      description: Create a custom data point.
      deprecated: true
      responses:
        '201':
          description: Successfully created a data point.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPoint'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataPointCreate'
  /v3/data_points/{identifier}:
    get:
      tags:
      - Deprecated End Points
      summary: Get specific data point
      operationId: getDataPoint
      description: Return a specific data point.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: Data point's identifier
        schema:
          $ref: '#/components/schemas/DataPoint_properties-identifier'
      responses:
        '200':
          description: Successfully retrieved data point.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPoint'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    patch:
      tags:
      - Deprecated End Points
      summary: Update a data point
      operationId: updateDataPoint
      description: Update data of a data point.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: DataPoint's identifier
        schema:
          $ref: '#/components/schemas/DataPoint_properties-identifier'
      requestBody:
        description: Data point to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataPointUpdate'
      responses:
        '200':
          description: Successfully updated data point.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPoint'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    delete:
      tags:
      - Deprecated End Points
      summary: Delete a data point
      operationId: deleteDataPoint
      description: Deletes the specified data point from the database.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: DataPoint's identifier
        schema:
          $ref: '#/components/schemas/DataPoint_properties-identifier'
      responses:
        '204':
          $ref: '#/components/responses/204NoContent'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
  /v3/data_point_choices:
    get:
      tags:
      - Deprecated End Points
      summary: Get list of data point choices
      description: Returns available choices for a specific enum data point.
      operationId: getDataPointChoices
      deprecated: true
      parameters:
      - $ref: '#/components/parameters/offsetParam'
      - $ref: '#/components/parameters/limitParam'
      - in: query
        name: data_point
        schema:
          $ref: '#/components/schemas/DataPoint_properties-identifier'
        description: The data point to get choices for.
        required: true
      - in: query
        name: collection
        schema:
          $ref: '#/components/schemas/properties-identifier'
        description: The collection to get choices for.
        required: true
      - in: query
        name: search
        schema:
          type: string
        description: Filter choices by searching for a substring.
      responses:
        '200':
          description: All matching data point choices.
          content:
            application/json:
              schema:
                type: object
                required:
                - results
                - count
                allOf:
                - $ref: '#/components/schemas/PaginatedResponse'
                - type: object
                  properties:
                    results:
                      type: array
                      items:
                        $ref: '#/components/schemas/DataPointChoice'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    post:
      tags:
      - Deprecated End Points
      summary: Create a data point choice
      operationId: createDataPointChoice
      description: Create a custom data point choice.
      deprecated: true
      responses:
        '201':
          description: Successfully created a data point choice.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointChoice'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataPointChoiceCreate'
  /v3/data_point_choices/{id}:
    get:
      tags:
      - Deprecated End Points
      summary: Get specific data point choice
      operationId: getDataPointChoice
      description: Return a specific data point choice.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: id
        description: Data point choice's ID
        schema:
          $ref: '#/components/schemas/DataPointChoice_properties-id'
      responses:
        '200':
          description: Successfully retrieved data point choice.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointChoice'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    patch:
      tags:
      - Deprecated End Points
      summary: Update a data point choice
      operationId: updateDataPointChoice
      description: Update data of a data point choice.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: id
        description: Data point choice's ID
        schema:
          $ref: '#/components/schemas/DataPointChoice_properties-id'
      requestBody:
        description: Data point choice to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataPointChoiceUpdate'
      responses:
        '200':
          description: Successfully updated data point choice.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointChoice'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    delete:
      tags:
      - Deprecated End Points
      summary: Delete a data point choice
      operationId: deleteDataPointChoice
      description: Deletes the specified data point choice from the database.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: id
        description: Data point choice's ID
        schema:
          $ref: '#/components/schemas/DataPointChoice_properties-id'
      responses:
        '204':
          $ref: '#/components/responses/204NoContent'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
  /v3/data_point_choices/replace:
    post:
      tags:
      - Deprecated End Points
      summary: Replace choices of a data point
      description: Replace choices of a data point. Existing choices and incoming choices are matched base on their `value`. New `value` will be created, existing `value` will be updated, and `value` not in incoming choices will be deleted.
      operationId: replaceDataPointChoices
      deprecated: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataPointChoiceReplaceRequest'
      responses:
        '200':
          description: Successfully replaced choices of a data point.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataPointChoiceReplaceResponse'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
  /v3/api_users:
    get:
      x-hidden: true
      tags:
      - Deprecated End Points
      summary: Get list of all API users
      operationId: getAllApiUsers
      description: Returns your API users.
      parameters:
      - in: query
        name: organization
        required: false
        schema:
          $ref: '#/components/schemas/Organization_properties-identifier'
        description: Filter by organization.
      responses:
        '200':
          description: All matching API users.
          content:
            application/json:
              schema:
                type: object
                required:
                - results
                - count
                allOf:
                - $ref: '#/components/schemas/PaginatedResponse'
                - type: object
                  properties:
                    results:
                      type: array
                      items:
                        $ref: '#/components/schemas/ApiUserWithoutKey'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    post:
      x-hidden: true
      tags:
      - Deprecated End Points
      summary: Create an API user
      operationId: createApiUser
      description: Create an API user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiUserCreate'
      responses:
        '201':
          description: 'Successfully created an API user.

            The API key is shown once in this response and will not be shown again in subsequent retrieval requests."

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUserWithKey'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
  /v3/api_users/{id}:
    get:
      x-hidden: true
      tags:
      - Deprecated End Points
      summary: Get specific API user
      operationId: getApiUser
      description: Return a specific API user.
      parameters:
      - in: path
        required: true
        name: id
        description: API user's ID
        schema:
          $ref: '#/components/schemas/properties-id'
      responses:
        '200':
          description: Successfully retrieved API user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUserWithoutKey'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    patch:
      x-hidden: true
      tags:
      - Deprecated End Points
      summary: Update an API user
      operationId: updateApiUser
      description: Update data of an API user.
      parameters:
      - in: path
        required: true
        name: id
        description: API user's ID
        schema:
          $ref: '#/components/schemas/properties-id'
      requestBody:
        description: API user to update
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiUserUpdate'
      responses:
        '200':
          description: Successfully updated API user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUserWithoutKey'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    delete:
      x-hidden: true
      tags:
      - Deprecated End Points
      summary: Delete an API user
      operationId: deleteApiUser
      description: Deletes the specified API user from the database.
      parameters:
      - in: path
        required: true
        name: id
        description: API user's ID
        schema:
          $ref: '#/components/schemas/properties-id'
      responses:
        '204':
          $ref: '#/components/responses/204NoContent'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
  /v3/api_users/{id}/regenerate_api_key:
    post:
      x-hidden: true
      tags:
      - Deprecated End Points
      summary: Regenerate API key for an API user
      operationId: regenerateApiKeyForApiUser
      description: Regenerate API key for an API user.
      parameters:
      - in: path
        required: true
        name: id
        description: API user's ID
        schema:
          $ref: '#/components/schemas/properties-id'
      responses:
        '200':
          description: Successfully generated new API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUserWithKey'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
  /v3/mappings:
    post:
      tags:
      - Deprecated End Points
      summary: Create a mapping
      operationId: createMapping
      description: Create a custom mapping.
      deprecated: true
      responses:
        '201':
          description: Successfully created a mapping.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Mapping'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MappingCreate'
    get:
      tags:
      - Deprecated End Points
      summary: List mappings
      operationId: listMappings
      deprecated: true
      parameters:
      - $ref: '#/components/parameters/offsetParam'
      - $ref: '#/components/parameters/limitParam'
      - in: query
        required: true
        name: mapping_data_source
        description: Data source's identifier
        schema:
          $ref: '#/components/schemas/Mapping_properties-identifier'
      description: Returns the list of all custom data mappings.
      responses:
        '200':
          description: Will return matching mappings
          x-summary: Will return matching mappings
          content:
            application/json:
              schema:
                type: object
                required:
                - results
                - count
                allOf:
                - $ref: '#/components/schemas/PaginatedResponse'
                - type: object
                  properties:
                    results:
                      type: array
                      items:
                        $ref: '#/components/schemas/Mapping'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
  /v3/mappings/{identifier}:
    get:
      tags:
      - Deprecated End Points
      summary: Get specific mapping
      operationId: getMapping
      description: Return a specific mapping.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: Mapping's identifier
        schema:
          $ref: '#/components/schemas/Mapping_properties-identifier'
      responses:
        '200':
          description: Successfully retrieved mapping.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Mapping'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    delete:
      tags:
      - Deprecated End Points
      summary: Delete specific mapping
      operationId: deleteMapping
      description: Delete the specified mapping from the database.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: Mapping's identifier
        schema:
          $ref: '#/components/schemas/Mapping_properties-identifier'
      responses:
        '204':
          $ref: '#/components/responses/204NoContent'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
    patch:
      tags:
      - Deprecated End Points
      summary: Update specific mapping
      operationId: updateMapping
      description: Updates a specific mapping.
      deprecated: true
      parameters:
      - in: path
        required: true
        name: identifier
        description: Mapping's identifier
        schema:
          $ref: '#/components/schemas/Mapping_properties-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MappingUpdate'
      responses:
        '200':
          description: Successfully retrieved mapping.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Mapping'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        default:
          $ref: '#/components/responses/DefaultError'
components:
  schemas:
    properties-enableAutoValidationThreshold:
      type: boolean
      nullable: true
      description: If true, the autoValidationThreshold enable auto validation from the threshold from this field if specified, else from the collection
    allowOpenai:
      type: boolean
      default: false
      description: Whether to allow OpenAI API to be used to assist in creating a model for this collection.
    disableConfirmationIfValidationRulesFail:
      type: boolean
      default: false
      description: If True, users cannot validate documents with missing mandatory fields, or failing validation rul

# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/affinda/refs/heads/main/openapi/affinda-deprecated-end-points-api-openapi.yml