_core.bulk.yaml

openapi: 3.1.0
info:
  title: Schemas of _core.bulk category
  description: Schemas of _core.bulk category
  version: 1.0.0
paths: {}
components:
  schemas:
    OperationContainer:
      type: object
      properties:
        index:
          $ref: '#/components/schemas/IndexOperation'
        create:
          $ref: '#/components/schemas/CreateOperation'
        update:
          $ref: '#/components/schemas/UpdateOperation'
        delete:
          $ref: '#/components/schemas/DeleteOperation'
      minProperties: 1
      maxProperties: 1
    IndexOperation:
      $ref: '#/components/schemas/WriteOperation'
    WriteOperation:
      allOf:
        - $ref: '#/components/schemas/OperationBase'
        - type: object
          properties:
            dynamic_templates:
              description: |-
                A map from the full name of fields to the name of dynamic templates.
                If a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template.
                If a field is already defined in the mapping, then this parameter won't be used.
              type: object
              additionalProperties:
                type: string
            pipeline:
              description: |-
                The pipeline ID for preprocessing documents.
                When the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.
                When a final pipeline is configured, that pipeline will always run, regardless of the value of this parameter.
              type: string
            require_alias:
              description: When `true`, require that all actions target an index alias rather than an index. Default is `false`.
              type: boolean
    OperationBase:
      type: object
      properties:
        _id:
          $ref: '_common.yaml#/components/schemas/Id'
        _index:
          $ref: '_common.yaml#/components/schemas/IndexName'
        routing:
          $ref: '_common.yaml#/components/schemas/Routing'
        if_primary_term:
          type: integer
          format: int64
        if_seq_no:
          $ref: '_common.yaml#/components/schemas/SequenceNumber'
        version:
          $ref: '_common.yaml#/components/schemas/VersionNumber'
        version_type:
          $ref: '_common.yaml#/components/schemas/VersionType'
    CreateOperation:
      $ref: '#/components/schemas/WriteOperation'
    UpdateOperation:
      allOf:
        - $ref: '#/components/schemas/OperationBase'
        - type: object
          properties:
            require_alias:
              description: When `true`, the request's actions must target an index alias.
              type: boolean
            retry_on_conflict:
              type: integer
              format: int32
    DeleteOperation:
      $ref: '#/components/schemas/OperationBase'
    UpdateAction:
      type: object
      properties:
        detect_noop:
          description: |-
            When `false` disables the setting 'result' in the response
            to 'noop' if no change to the document occurred.
          type: boolean
        doc:
          description: A partial update to an existing document.
          type: object
        doc_as_upsert:
          description: When `true`, uses the contents of 'doc' as the value of 'upsert'.
          type: boolean
        script:
          $ref: '_common.yaml#/components/schemas/Script'
        scripted_upsert:
          description: When `true`, executes the script whether or not the document exists.
          type: boolean
        _source:
          $ref: '_core.search.yaml#/components/schemas/SourceConfig'
        upsert:
          description: |-
            If the document does not already exist, the contents of 'upsert' are inserted as a
            new document. If the document exists, the 'script' is executed.
          type: object
    ResponseItem:
      type: object
      properties:
        _type:
          description: The document type.
          type: string
          x-version-removed: '2.0'
        _id:
          description: The document ID associated with the operation.
          type: ['null', string]
        _index:
          description: |-
            The name of the index associated with the operation.
            If the operation targets a data stream, this is the backing index into which the document was written.
          type: string
        status:
          description: HTTP status code returned for the operation.
          type: integer
          format: int32
        error:
          $ref: '_common.yaml#/components/schemas/ErrorCause'
        _primary_term:
          description: The primary term assigned to the document for the operation.
          type: integer
          format: int64
        result:
          description: |-
            Result of the operation.
            Successful values are `created`, `deleted`, and `updated`.
          type: string
        _seq_no:
          $ref: '_common.yaml#/components/schemas/SequenceNumber'
        _shards:
          $ref: '_common.yaml#/components/schemas/ShardStatistics'
        _version:
          $ref: '_common.yaml#/components/schemas/VersionNumber'
        forced_refresh:
          type: boolean
        get:
          $ref: '_common.yaml#/components/schemas/InlineGetDictUserDefined'
      required:
        - _index
        - status