ARCNM Datasets API

openapi: 3.2.0
info:
  title: Arcnm Io Datasets API
  version: 0.1.0
  description: 'Operations tagged datasets across 2 of this provider''s published API definitions: openapi-public.json, arcnm-io-openapi.yml. Each path carries the servers of the definition it was published in.'
security:
- ApiKeyAuth: []
- OAuth2PasswordBearer: []
tags:
- name: Datasets
paths:
  /api/v1/parts/{part_id}/revisions/{revision_id}/datasets:
    get:
      tags:
      - Datasets
      summary: List Datasets
      description: 'List the files attached to a part revision, such as its STEP model and drawings,

        with each file''s name, type, role and whether it is the primary file.'
      operationId: datasets-list_datasets
      security:
      - ApiKeyAuth: []
      - OAuth2PasswordBearer: []
      parameters:
      - name: part_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Part Id
      - name: revision_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Revision Id
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Org-Slug
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Org-Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PartRevisionDatasetPublic'
                title: Response Datasets-List Datasets
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Datasets
      summary: Attach Dataset
      description: 'Attach an existing DataSource row to a revision.


        For a fresh file upload from a multipart client, the revision''s

        ``datasets/upload`` route creates the DataSource and the link in one

        call. A client that can only send JSON — every

        MCP client — uploads with ``POST /uploads/presign``, sends the file the

        way its `method` says, calls ``POST /uploads/confirm`` and attaches the

        result here, with the file''s ``role``. The upload is checked after

        confirm answers: until it is confirmed this answers 409 with

        `details.reason` `upload_pending` and `Retry-After` (also as

        `details.retry_after_s`) — ask again then. An upload that was refused,

        could not be checked or was cancelled answers 409 `upload_rejected`,

        `upload_failed` or `upload_cancelled`, which waiting does not change.'
      operationId: datasets-attach_dataset
      security:
      - ApiKeyAuth: []
      - OAuth2PasswordBearer: []
      parameters:
      - name: part_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Part Id
      - name: revision_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Revision Id
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Org-Slug
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Org-Slug
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetAttach'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartRevisionDatasetPublic'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/parts/{part_id}/revisions/{revision_id}/datasets/upload:
    post:
      tags:
      - Datasets
      summary: Upload Dataset
      description: 'Upload a file directly onto a revision, in one shot.


        Stores the file and links it to the revision. No calculation is

        enqueued — use ``/calculations/upload`` for the

        calculate-on-upload flow.'
      operationId: datasets-upload_dataset
      security:
      - ApiKeyAuth: []
      - OAuth2PasswordBearer: []
      parameters:
      - name: part_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Part Id
      - name: revision_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Revision Id
      - name: role
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/DatasetRole'
          description: Role of the file on the revision (e.g. cad_3d for a 3D model, drawing_2d for a 2D drawing).
          default: cad_3d
        description: Role of the file on the revision (e.g. cad_3d for a 3D model, drawing_2d for a 2D drawing).
      - name: is_primary
        in: query
        required: false
        schema:
          type: boolean
          description: Whether this dataset becomes the primary one for its role on the revision.
          default: true
          title: Is Primary
        description: Whether this dataset becomes the primary one for its role on the revision.
      - name: sheet_gauge_mm
        in: query
        required: false
        schema:
          anyOf:
          - type: number
            maximum: 1000
            exclusiveMinimum: 0
          - type: 'null'
          description: Sheet thickness in millimetres — required when a cad_3d upload is a DXF flat pattern (a 2D cutting file carries no thickness).
          title: Sheet Gauge Mm
        description: Sheet thickness in millimetres — required when a cad_3d upload is a DXF flat pattern (a 2D cutting file carries no thickness).
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Org-Slug
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Org-Slug
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_datasets-upload_dataset'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartRevisionDatasetPublic'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/parts/{part_id}/revisions/{revision_id}/datasets/{dataset_link_id}:
    patch:
      tags:
      - Datasets
      summary: Update Dataset
      description: 'Edit a dataset link.


        Currently supports two fields:

        - ``filename``: rename the underlying ``DataSource``.

        - ``is_primary``: promote/demote within the parent revision. The

        "exactly one primary" invariant is maintained server-side: when

        promoting, every other link on the same revision is demoted in

        the same transaction so concurrent primaries can''t co-exist.'
      operationId: datasets-update_dataset
      security:
      - ApiKeyAuth: []
      - OAuth2PasswordBearer: []
      parameters:
      - name: part_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Part Id
      - name: revision_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Revision Id
      - name: dataset_link_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Dataset Link Id
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Org-Slug
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Org-Slug
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PartRevisionDatasetUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartRevisionDatasetPublic'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Datasets
      summary: Detach Dataset
      description: 'Detach a file from a part revision. Only the link is removed; the uploaded file

        itself is not deleted.'
      operationId: datasets-detach_dataset
      security:
      - ApiKeyAuth: []
      - OAuth2PasswordBearer: []
      parameters:
      - name: part_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Part Id
      - name: revision_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Revision Id
      - name: dataset_link_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Dataset Link Id
      - name: X-API-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Api-Key
      - name: X-Org-Slug
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Org-Slug
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetachMessage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    DatasetAttach:
      properties:
        data_source_id:
          type: string
          format: uuid
          title: Data Source Id
          description: Identifier of the uploaded data source to attach to the revision.
        role:
          $ref: '#/components/schemas/DatasetRole'
          description: Role of the file on the revision (e.g. cad_3d for a 3D CAD model, drawing_2d for a 2D drawing).
          default: other
        is_primary:
          type: boolean
          title: Is Primary
          description: Whether this dataset is the primary one for the revision.
          default: false
        attributes:
          additionalProperties: true
          type: object
          title: Attributes
          description: Free-form metadata for the attachment, as a JSON object.
          default: {}
      additionalProperties: false
      type: object
      required:
      - data_source_id
      title: DatasetAttach
    DatasetRole:
      type: string
      enum:
      - cad_3d
      - drawing_2d
      - mesh
      - rfq_text
      - other
      title: DatasetRole
      description: 'What a file is to a part revision''s analysis: a 3D model, a 2D

        drawing, a mesh, request-for-quote text, or other. A file of role

        ''other'' is kept but not used to price the part.'
    PartRevisionDatasetPublic:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Unique identifier of the uploaded file attached to the revision.
        part_revision_id:
          type: string
          format: uuid
          title: Part Revision Id
          description: ID of the revision this file is attached to.
        data_source_id:
          type: string
          format: uuid
          title: Data Source Id
          description: ID of the underlying stored file this attachment points to.
        role:
          type: string
          title: Role
          description: The file's role on the revision (e.g. 3D CAD, 2D drawing, spec).
        is_primary:
          type: boolean
          title: Is Primary
          description: Whether this is the primary CAD file used for analysis on the revision.
        is_active:
          type: boolean
          title: Is Active
          description: Whether this is the current file; superseded re-uploads are marked inactive.
          default: true
        attributes:
          additionalProperties: true
          type: object
          title: Attributes
          description: Free-form key/value metadata for the file attachment.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Timestamp when the file was attached (UTC, ISO 8601).
        filename:
          anyOf:
          - type: string
          - type: 'null'
          title: Filename
          description: Original filename of the uploaded file.
        content_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Type
          description: MIME type of the uploaded file (e.g. application/pdf).
        size_bytes:
          anyOf:
          - type: integer
          - type: 'null'
          title: Size Bytes
          description: Size of the uploaded file in bytes.
      type: object
      required:
      - id
      - part_revision_id
      - data_source_id
      - role
      - is_primary
      - created_at
      title: PartRevisionDatasetPublic
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PartRevisionDatasetUpdate:
      properties:
        filename:
          anyOf:
          - type: string
          - type: 'null'
          title: Filename
          description: New original filename for the uploaded file.
        is_primary:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Primary
          description: Set true to make this the primary CAD file for analysis on the revision.
      additionalProperties: false
      type: object
      title: PartRevisionDatasetUpdate
      description: 'PATCH body for editing a dataset link.


        All fields optional — the route applies whichever the caller sends.

        Setting ``is_primary=True`` is exclusive within the parent revision:

        the route demotes any other primary on the same revision so the

        "exactly one primary" invariant holds without race-prone client

        coordination.'
    DetachMessage:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable confirmation that the dataset was detached.
      type: object
      required:
      - message
      title: DetachMessage
      description: '``{"message": "..."}`` envelope for the detach endpoint.'
    Body_datasets-upload_dataset:
      properties:
        file:
          type: string
          contentMediaType: application/octet-stream
          title: File
          description: The CAD model or drawing file to attach to the revision.
      type: object
      required:
      - file
      title: Body_datasets-upload_dataset
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/v1/sessions/login
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'Server-to-server API key in the ``X-API-Key`` header, e.g. ``ak_live_…``. See the Authentication guide. Do not send it as ``Authorization: Bearer`` — that header is reserved for session / MCP JWTs.'
x-refined-from:
- openapi-public.json
- arcnm-io-openapi.yml