openapi: '3.0.3'
info:
  title: Data Gateway API
  contact:
    name: Threedy GmbH
    url: https://www.threedy.io/
    email: contact@threedy.io
  version: '3.1'

servers:
  - url: https://api.threedy.io/3ddata/test/v1
    description: Test Server

externalDocs:
  url: https://www.threedy.io/scalability/anydata
  description: List of available 3D data formats and their MIME types.

paths:
  /:
    head:
      description: Used to authorize resources and simultaneously check whether ETag still matches cached ETag.
      tags:
        - Authorize
      responses:
        '200':
          description: User has access to this resource. Any other response is regarded as being unauthorized. Redirects are not followed.
          headers:
            ETag:
              description: RFC2616 revision control. Used to determine if cached data is current.
              schema:
                type: string
        '403':
          description: Forbidden. User does not have authorization to view this resource.
        '404':
          description: Not Found. Element does not exist or user does not have authorization to know whether this resource exists or not.
    get:
      description: Used to download resources which instant3Dhub can then use to build optimized 3D representations.
      tags:
        - Load
      responses:
        '200':
          description: Success. See the examples below for a full list of possible Content-Types to return.
          headers:
            ETag:
              description: RFC2616 revision control. Used to determine if cached data is current.
              schema:
                type: string
            Content-Disposition:
              description: HTTP header which defines a filename for the content. Will be used as a fallback if Content-Type is not given. The file extension will be used as a hint to select an appropriate loader.
              schema:
                type: string
          content:
            model/3mf:
              example: binary-data
              schema:
                type: string
                format: binary
            model/creoview:
              example: binary-data
              schema:
                type: string
                format: binary
            model/fhs:
              example: binary-data
              schema:
                type: string
                format: binary
            model/gltf-binary:
              example: binary-data
              schema:
                type: string
                format: binary
            model/gltf+json:
              example: json
              schema:
                type: string
                format: json
            model/iges:
              example: binary-data
              schema:
                type: string
                format: binary
            model/iso.step.ap203:
              example: binary-data
              schema:
                type: string
                format: binary
            model/iso.step.ap214:
              example: binary-data
              schema:
                type: string
                format: binary
            model/iso.step.ap242+xml:
              example: xml-data
              schema:
                type: string
                format: xml-data
            model/obj:
              example: binary-data
              schema:
                type: string
                format: binary
            model/rlxml:
              example: xml-data
              schema:
                type: string
                format: xml-data
            model/stl:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.autodesk.3ds:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.autodesk.dxf:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.autodesk.fbx:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.autodesk.inventor:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.autodesk.revit:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.avena.rvm:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.blend:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.collada+xml:
              example: xml-data
              schema:
                type: string
                format: xml-data
            model/vnd.dassault.acis:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.dassault.catia.v4:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.dassault.catia.v5:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.dassault.catia.v6:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.dgn:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.ifc:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.kbl:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.las:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.off:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.parasolid.transmit.binary:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.ply:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.ptc.pro-eng:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.rhino.3dm:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.siemens.nx:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.siemens.openjt:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.siemens.plmxml:
              example: xml-data
              schema:
                type: string
                format: xml-data
            model/vnd.solidedge:
              example: binary-data
              schema:
                type: string
                format: binary
            model/vnd.solidworks:
              example: binary-data
              schema:
                type: string
                format: binary
            model/x3d-vrml:
              example: binary-data
              schema:
                type: string
                format: binary
            model/x3d+fastinfoset:
              example: binary-data
              schema:
                type: string
                format: binary
            model/x3d+xml:
              example: xml-data
              schema:
                type: string
                format: xml-data

        '202':
          description: Accepted but not yet available.
          headers:
            Retry-After: # RFC2616 standard header
              description: RFC2616 14.37 describing either an HTTP-date or an integer number of seconds (in decimal) after the time of the response.
              schema:
                type: string
        '302':
          description: Resource is located elsewhere.
        '403':
          description: Forbidden.
        '404':
          description: Not Found.
        '418':
          description: Consumer must instantiate a 'teapot'.

tags:
  - name: Authorize
  - name: Load