openapi: 3.2.0
info:
  title: Operations Hub Core.file Entity Links API
  version: 0.1.1
  description: ''
servers: []
tags:
- name: core.file-entity-links
paths:
  /api/core/v1/file-entity-links:
    get:
      operationId: list_file_entity_links
      summary: List File Entity Links
      parameters:
      - in: query
        name: sort
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Sort by field (prefix with - for descending)
          title: Sort
        required: false
        description: Sort by field (prefix with - for descending)
      - in: query
        name: file_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by file ID
          title: File Id
        required: false
        description: Filter by file ID
      - in: query
        name: workorder_activity_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by workorder activity ID
          title: Workorder Activity Id
        required: false
        description: Filter by workorder activity ID
      - in: query
        name: workorder_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by workorder ID
          title: Workorder Id
        required: false
        description: Filter by workorder ID
      - in: query
        name: service_order_line_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by service order line ID
          title: Service Order Line Id
        required: false
        description: Filter by service order line ID
      - in: query
        name: service_order_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by service order ID
          title: Service Order Id
        required: false
        description: Filter by service order ID
      - in: query
        name: project_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by project ID
          title: Project Id
        required: false
        description: Filter by project ID
      - in: query
        name: turbine_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by turbine ID
          title: Turbine Id
        required: false
        description: Filter by turbine ID
      - in: query
        name: turbine_component_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by turbine component ID
          title: Turbine Component Id
        required: false
        description: Filter by turbine component ID
      - in: query
        name: anomaly_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by anomaly ID
          title: Anomaly Id
        required: false
        description: Filter by anomaly ID
      - in: query
        name: service_result_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by service result ID
          title: Service Result Id
        required: false
        description: Filter by service result ID
      - in: query
        name: customer_location_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by customer location ID
          title: Customer Location Id
        required: false
        description: Filter by customer location ID
      - in: query
        name: paginate
        schema:
          default: true
          description: Enable pagination (false returns all results)
          title: Paginate
          type: boolean
        required: false
        description: Enable pagination (false returns all results)
      - in: query
        name: page
        schema:
          default: 1
          description: Page number
          minimum: 1
          title: Page
          type: integer
        required: false
        description: Page number
      - in: query
        name: page_size
        schema:
          default: 50
          description: Number of items per page
          maximum: 1000
          minimum: 1
          title: Page Size
          type: integer
        required: false
        description: Number of items per page
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/FileEntityLinkResponse'
                title: Response
                type: array
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: List all items with optional search, sorting, and pagination.
      tags:
      - core.file-entity-links
      security:
      - APIKeyAuth: []
      - CookieAuth: []
    post:
      operationId: create_file_entity_link
      summary: Create File Entity Link
      parameters: []
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileEntityLinkResponse'
      description: Create a new item.
      tags:
      - core.file-entity-links
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileEntityLinkCreate'
        required: true
      security:
      - APIKeyAuth: []
      - CookieAuth: []
  /api/core/v1/file-entity-links/{id}:
    get:
      operationId: get_file_entity_link
      summary: Get File Entity Link
      parameters:
      - in: path
        name: id
        schema:
          title: Id
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileEntityLinkResponse'
      description: Get a single item by ID.
      tags:
      - core.file-entity-links
      security:
      - APIKeyAuth: []
      - CookieAuth: []
    patch:
      operationId: update_file_entity_link
      summary: Update File Entity Link
      parameters:
      - in: path
        name: id
        schema:
          title: Id
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileEntityLinkResponse'
      description: Update an item.
      tags:
      - core.file-entity-links
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileEntityLinkUpdate'
        required: true
      security:
      - APIKeyAuth: []
      - CookieAuth: []
    delete:
      operationId: delete_file_entity_link
      summary: Delete File Entity Link
      parameters:
      - in: path
        name: id
        schema:
          title: Id
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
      description: Soft delete an item.
      tags:
      - core.file-entity-links
      security:
      - APIKeyAuth: []
      - CookieAuth: []
components:
  schemas:
    FileEntityLinkResponse:
      additionalProperties: false
      description: Schema for FileEntityLink response.
      properties:
        updated_at:
          description: Last update timestamp
          format: date-time
          title: Updated At
          type: string
        id:
          description: Record ID
          title: Id
          type: integer
        file_id:
          description: File ID
          title: File Id
          type: integer
        workorder_activity_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Workorder activity ID
          title: Workorder Activity Id
        workorder_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Workorder ID
          title: Workorder Id
        service_order_line_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Service order line ID
          title: Service Order Line Id
        service_order_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Service order ID
          title: Service Order Id
        project_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Project ID
          title: Project Id
        turbine_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine ID
          title: Turbine Id
        turbine_component_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine component ID
          title: Turbine Component Id
        anomaly_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Anomaly ID
          title: Anomaly Id
        service_result_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Service result ID
          title: Service Result Id
        customer_location_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Customer location ID
          title: Customer Location Id
        additional_information:
          anyOf:
          - type: object
          - type: 'null'
          description: Additional information as JSON
          title: Additional Information
      required:
      - updated_at
      - id
      - file_id
      title: FileEntityLinkResponse
      type: object
    Error:
      additionalProperties: false
      description: Error response schema.
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          title: Message
          type: string
      required:
      - code
      - message
      title: Error
      type: object
    FileEntityLinkCreate:
      additionalProperties: false
      description: Schema for creating a FileEntityLink.
      properties:
        file_id:
          description: File ID
          title: File Id
          type: integer
        workorder_activity_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Workorder activity ID
          title: Workorder Activity Id
        workorder_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Workorder ID
          title: Workorder Id
        service_order_line_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Service order line ID
          title: Service Order Line Id
        service_order_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Service order ID
          title: Service Order Id
        project_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Project ID
          title: Project Id
        turbine_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine ID
          title: Turbine Id
        turbine_component_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine component ID
          title: Turbine Component Id
        anomaly_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Anomaly ID
          title: Anomaly Id
        service_result_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Service result ID
          title: Service Result Id
        customer_location_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Customer location ID
          title: Customer Location Id
        additional_information:
          anyOf:
          - type: object
          - type: 'null'
          description: Additional information as JSON
          title: Additional Information
      required:
      - file_id
      title: FileEntityLinkCreate
      type: object
    Success:
      additionalProperties: false
      description: 'Schema returned for successful operations.


        The `success` field is always ``true`` in this schema. Failed operations are

        represented by the :class:`Error` schema instead, so a ``false`` value does

        not occur in practice. The field is included for consistency across responses

        and to make the contract explicit for clients.'
      properties:
        success:
          default: true
          description: Always true for this schema. Errors are represented by a separate Error schema, so false is never returned.
          title: Success
          type: boolean
      title: Success
      type: object
    FileEntityLinkUpdate:
      additionalProperties: false
      description: Schema for updating a FileEntityLink.
      properties:
        workorder_activity_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Workorder activity ID
          title: Workorder Activity Id
        workorder_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Workorder ID
          title: Workorder Id
        service_order_line_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Service order line ID
          title: Service Order Line Id
        service_order_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Service order ID
          title: Service Order Id
        project_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Project ID
          title: Project Id
        turbine_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine ID
          title: Turbine Id
        turbine_component_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine component ID
          title: Turbine Component Id
        anomaly_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Anomaly ID
          title: Anomaly Id
        service_result_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Service result ID
          title: Service Result Id
        customer_location_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Customer location ID
          title: Customer Location Id
        additional_information:
          anyOf:
          - type: object
          - type: 'null'
          description: Additional information as JSON
          title: Additional Information
      title: FileEntityLinkUpdate
      type: object
    ErrorCode:
      description: Error codes for API errors.
      enum:
      - validation
      - server
      - auth
      - unknown
      - external
      - generic
      title: ErrorCode
      type: string
  securitySchemes:
    APIKeyAuth:
      type: http
      scheme: bearer
    CookieAuth:
      type: apiKey
      in: cookie
      name: opshub_prod_sessionid
    AuthBearer:
      type: http
      scheme: bearer