openapi: 3.2.0
info:
  title: Folio Instance Authority Links Statistics API
  version: v1.0
  description: 'Operations tagged instance-authority-links-statistics across 2 of this provider''s published API definitions: folio-mod-entities-links-openapi.json, folio-mod-entities-links-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://localhost:8081
tags:
- name: instance-authority-links-statistics
paths:
  /links/stats/authority:
    get:
      description: Retrieve authority updates (related to links) statistics
      operationId: getAuthorityLinksStats
      parameters:
      - description: Start date to seek from
        explode: true
        in: query
        name: fromDate
        required: false
        schema:
          format: date-time
          type: string
        style: form
      - description: End date to seek from
        explode: true
        in: query
        name: toDate
        required: false
        schema:
          format: date-time
          type: string
        style: form
      - description: Action to filter by
        explode: true
        in: query
        name: action
        required: false
        schema:
          $ref: '#/components/schemas/linkAction'
        style: form
      - description: Max number of items in collection
        explode: true
        in: query
        name: limit
        required: false
        schema:
          default: 100
          minimum: 1
          type: integer
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/authorityStatsDtoCollection'
          description: The authority updates statistics collection
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors'
          description: Validation errors.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors'
          description: Internal server error.
      tags:
      - instance-authority-links-statistics
      summary: Get authority links stats
      x-summary-source: derived
    servers:
    - url: https://localhost:8081
  /links/stats/instance:
    get:
      description: Retrieve linked bib update statistics
      operationId: getLinkedBibUpdateStats
      parameters:
      - description: Start date to seek from
        explode: true
        in: query
        name: fromDate
        required: false
        schema:
          format: date-time
          type: string
        style: form
      - description: End date to seek to
        explode: true
        in: query
        name: toDate
        required: false
        schema:
          format: date-time
          type: string
        style: form
      - description: Status to filter by
        explode: true
        in: query
        name: status
        required: false
        schema:
          $ref: '#/components/schemas/linkStatus'
        style: form
      - description: Max number of items in collection
        explode: true
        in: query
        name: limit
        required: false
        schema:
          default: 100
          minimum: 1
          type: integer
        style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bibStatsDtoCollection'
          description: The linked bib update statistics collection
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors'
          description: Validation errors.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors'
          description: Internal server error.
      tags:
      - instance-authority-links-statistics
      summary: Get linked bib update stats
      x-summary-source: derived
    servers:
    - url: https://localhost:8081
components:
  schemas:
    authorityControlMetadata:
      description: Meta data for authority control
      example:
        startedAt: '2000-01-23T04:56:07.000+00:00'
        startedByUserId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        startedByUserFirstName: startedByUserFirstName
        startedByUserLastName: startedByUserLastName
      properties:
        startedAt:
          description: Date-time when authority update was registered
          format: date-time
          type: string
        startedByUserId:
          description: User's ID that triggers record
          format: uuid
          type: string
        startedByUserFirstName:
          description: User's first name that triggers record
          type: string
        startedByUserLastName:
          description: User's last name that triggers record
          type: string
      type: object
    linkStatus:
      description: Link status
      enum:
      - ACTUAL
      - ERROR
      - NEW
      type: string
    linkAction:
      description: Type of change
      enum:
      - DELETE
      - UPDATE_NATURAL_ID
      - UPDATE_HEADING
      type: string
    authorityStatsDtoCollection:
      description: Collection of authority changes statistic. Shared and local when consortium member; shared when consortium central
      example:
        stats:
        - id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          authorityId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          action: DELETE
          naturalIdOld: naturalIdOld
          naturalIdNew: naturalIdNew
          headingOld: headingOld
          headingNew: headingNew
          headingTypeOld: headingTypeOld
          headingTypeNew: headingTypeNew
          sourceFileOld: sourceFileOld
          sourceFileNew: sourceFileNew
          metadata:
            startedAt: '2000-01-23T04:56:07.000+00:00'
            startedByUserId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            startedByUserFirstName: startedByUserFirstName
            startedByUserLastName: startedByUserLastName
        - id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          authorityId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          action: DELETE
          naturalIdOld: naturalIdOld
          naturalIdNew: naturalIdNew
          headingOld: headingOld
          headingNew: headingNew
          headingTypeOld: headingTypeOld
          headingTypeNew: headingTypeNew
          sourceFileOld: sourceFileOld
          sourceFileNew: sourceFileNew
          metadata:
            startedAt: '2000-01-23T04:56:07.000+00:00'
            startedByUserId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
            startedByUserFirstName: startedByUserFirstName
            startedByUserLastName: startedByUserLastName
        next: '2000-01-23T04:56:07.000+00:00'
      properties:
        stats:
          description: Authority changes statistic
          items:
            $ref: '#/components/schemas/authorityStatsDto'
          type: array
        next:
          description: Next response item date to seek by
          format: date-time
          type: string
      type: object
    error_parameters_inner:
      properties:
        key:
          description: Parameter key
          type: string
        value:
          description: Parameter value
          type: string
      type: object
    error:
      description: Error object
      properties:
        message:
          description: Error message
          type: string
        type:
          description: Error type
          type: string
        code:
          description: Error code
          type: string
        parameters:
          description: Error parameters
          items:
            $ref: '#/components/schemas/error_parameters_inner'
          type: array
      type: object
    bibStatsDto:
      description: Linked bib statistics
      example:
        instanceId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        instanceTitle: instanceTitle
        bibRecordTag: bibRecordTag
        authorityNaturalId: authorityNaturalId
        updatedAt: '2000-01-23T04:56:07.000+00:00'
        errorCause: errorCause
      properties:
        instanceId:
          description: Linked instance id, UUID
          format: uuid
          type: string
        instanceTitle:
          description: Instance title
          type: string
        bibRecordTag:
          description: Bib record tag
          type: string
        authorityNaturalId:
          description: Linked authority natural id
          type: string
        updatedAt:
          description: Link last updated at
          format: date-time
          type: string
        errorCause:
          description: Cause of error for updating linked bib
          type: string
      type: object
    errors:
      description: Errors response
      example:
        Error:
          value:
            errors:
            - message: may not be null
              type: 1
              code: -1
              parameters:
              - key: moduleTo
                value: null
      properties:
        errors:
          description: List of errors
          items:
            $ref: '#/components/schemas/error'
          type: array
      type: object
    bibStatsDtoCollection:
      description: Collection of changes statistic. For local bibs when consortium member; shared when consortium central
      example:
        stats:
        - instanceId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          instanceTitle: instanceTitle
          bibRecordTag: bibRecordTag
          authorityNaturalId: authorityNaturalId
          updatedAt: '2000-01-23T04:56:07.000+00:00'
          errorCause: errorCause
        - instanceId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          instanceTitle: instanceTitle
          bibRecordTag: bibRecordTag
          authorityNaturalId: authorityNaturalId
          updatedAt: '2000-01-23T04:56:07.000+00:00'
          errorCause: errorCause
        next: '2000-01-23T04:56:07.000+00:00'
      properties:
        stats:
          description: Changes statistic
          items:
            $ref: '#/components/schemas/bibStatsDto'
          type: array
        next:
          description: Next response item date to seek by
          format: date-time
          type: string
      type: object
    authorityStatsDto:
      description: Describe changes to authority that are related to links
      example:
        id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        authorityId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        action: DELETE
        naturalIdOld: naturalIdOld
        naturalIdNew: naturalIdNew
        headingOld: headingOld
        headingNew: headingNew
        headingTypeOld: headingTypeOld
        headingTypeNew: headingTypeNew
        sourceFileOld: sourceFileOld
        sourceFileNew: sourceFileNew
        metadata:
          startedAt: '2000-01-23T04:56:07.000+00:00'
          startedByUserId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          startedByUserFirstName: startedByUserFirstName
          startedByUserLastName: startedByUserLastName
      properties:
        id:
          description: Stat ID
          format: uuid
          type: string
        authorityId:
          description: Authority ID
          format: uuid
          type: string
        action:
          $ref: '#/components/schemas/linkAction'
        naturalIdOld:
          description: Old natural ID
          type: string
        naturalIdNew:
          description: New natural ID
          type: string
        headingOld:
          description: Old heading
          type: string
        headingNew:
          description: New heading
          type: string
        headingTypeOld:
          description: Old heading type
          type: string
        headingTypeNew:
          description: New heading type
          type: string
        sourceFileOld:
          description: Old source file ID
          type: string
        sourceFileNew:
          description: New source file ID
          type: string
        metadata:
          $ref: '#/components/schemas/authorityControlMetadata'
      type: object
x-refined-from:
- folio-mod-entities-links-openapi.json
- folio-mod-entities-links-openapi.yml