openapi: 3.2.0
info:
  title: Relay External REST Attachments API
  version: 1.1.0
  description: REST API for programmatic access to Relay CRM resources.
servers:
- url: https://your-domain.com/api/v1
  description: Production
security:
- bearerAuth: []
tags:
- name: Attachments
paths:
  /attachments:
    get:
      summary: List attachments
      tags:
      - Attachments
      parameters:
      - name: limit
        in: query
        description: Max results to return (default 50, max 100).
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: cursor
        in: query
        description: Cursor for pagination (ISO date string).
        schema:
          type: string
      - name: offset
        in: query
        description: Optional offset for pagination (not used by all endpoints).
        schema:
          type: integer
          minimum: 0
      - name: ticket_id
        in: query
        schema:
          type: string
          format: uuid
      - name: conversation_id
        in: query
        schema:
          type: string
          format: uuid
      responses:
        '501':
          description: Not implemented (endpoint retired)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: true
      description: 'Deprecated and not available: every method returns 501 NOT_IMPLEMENTED. Upload attachments from the Relay dashboard or mobile app; attachment metadata is returned with ticket conversations.'
      operationId: getAttachments
      x-operation-id-source: derived
    post:
      summary: Create attachment metadata
      tags:
      - Attachments
      responses:
        '501':
          description: Not implemented (endpoint retired)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: true
      description: 'Deprecated and not available: every method returns 501 NOT_IMPLEMENTED. Upload attachments from the Relay dashboard or mobile app; attachment metadata is returned with ticket conversations.'
      operationId: postAttachments
      x-operation-id-source: derived
  /attachments/{id}:
    get:
      summary: Get attachment
      tags:
      - Attachments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '501':
          description: Not implemented (endpoint retired)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: true
      description: 'Deprecated and not available: every method returns 501 NOT_IMPLEMENTED. Upload attachments from the Relay dashboard or mobile app; attachment metadata is returned with ticket conversations.'
      operationId: getAttachmentsById
      x-operation-id-source: derived
    delete:
      summary: Delete attachment
      tags:
      - Attachments
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '501':
          description: Not implemented (endpoint retired)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      deprecated: true
      description: 'Deprecated and not available: every method returns 501 NOT_IMPLEMENTED. Upload attachments from the Relay dashboard or mobile app; attachment metadata is returned with ticket conversations.'
      operationId: deleteAttachmentsById
      x-operation-id-source: derived
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          required:
          - code
          - message
      required:
      - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key