openapi.yaml

openapi: 3.1.0

info:
  title: Foxglove API
  version: "1"
  x-logo:
    url: https://foxglove.dev/images/logo-icon-round.png
  description: |
    Api documentation for foxglove services.

servers:
  - url: http://api.foxglove.dev/v1
    description: Production

security:
  - Session: []

paths:

  /devices/{id}:
    parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
        description: Device Id

    get:
      tags: [Devices]
      summary: Get a device

      security:
        - Session: ["org_member"]
        - ApiKey: ["devices.list"]

      responses:
        "200":
          description: Success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Device"

components:
  securitySchemes:
    Session:
      type: apiKey
      in: cookie
      name: fox.session

    ApiKey:
      type: http
      scheme: bearer

  schemas:
    Device:
      type: object
      properties:
        id:
          type: string
          description: Opaque identifier
        name:
          type: string
          description: Organization-chosen device name
      required:
        - id
        - name