OneRail Uploads API

openapi: 3.2.0
info:
  version: 1.0.0
  title: OneRail Operation Dashboard Uploads API
  description: Defines Operations Dashboard APIs
  license:
    name: UNLICENSED
    url: ''
servers:
- url: /
  description: Default relative server URL
security:
- bearer: []
tags:
- name: Uploads
paths:
  /v1/file:
    post:
      x-exegesis-controller: File
      summary: Uploads a new file
      operationId: createFile
      tags:
      - Uploads
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              description: Set if image should be securely stored and the binary data to upload
              required:
              - secure
              properties:
                secure:
                  type: boolean
                  description: If the image should be stored securely
                  default: true
                fileData:
                  type: string
                  format: binary
                  description: binary image upload
      responses:
        '200':
          description: Successful response. Returns URL to the file
          content:
            application/json:
              schema:
                properties:
                  URL:
                    type: string
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
  /v1/assets:
    parameters:
    - name: url
      in: query
      description: image URL
      required: true
      schema:
        type: string
    get:
      x-exegesis-controller: File
      summary: Display image stored in Azure storage account
      operationId: viewImage
      security: []
      tags:
      - Uploads
      responses:
        '302':
          description: Success. Redirected to image blob with access token
          headers:
            Location:
              schema:
                type: string
        default:
          $ref: '#/paths/~1v1~1routes/get/responses/404'
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: 'Standard JWT bearer token used for authenticated OmniPoint users

        and internal service-to-service calls. Clients send `Authorization: Bearer <jwt>`

        and the token is validated using the shared Core access token secret.

        '
    ApiKey:
      type: apiKey
      in: header
      name: X-ONERAIL-API-KEY
      description: 'Shared secret key used for machine-to-machine integrations. Must be sent

        together with `X-ONERAIL-APP-ID` and is validated against the stored ApiAuth

        record for that application.

        '
    AppId:
      type: apiKey
      in: header
      name: X-ONERAIL-APP-ID
      description: 'Application identifier (UUID) that pairs with `X-ONERAIL-API-KEY` for

        machine-to-machine integrations. Both headers are required for ApiKey-based

        authentication.

        '
    OAuth:
      type: oauth2
      description: 'OAuth 2.0 access token validated by the Operations service (e.g. Okta-backed

        integrations). Clients obtain tokens from their own IdP outside of this API

        and call endpoints with `Authorization: OAuth <access_token>`. The

        `authorizationUrl` and `tokenUrl` values below are placeholders only to

        satisfy the OpenAPI schema; this service does not call them directly and the

        real IdP URLs are configured via environment and introspection logic in code.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://dummy-unused-url.com
          tokenUrl: https://dummy-unused-url.com
          scopes: {}