openapi: 3.0.1
info:
  title: Integrations API
  description: >-
    Provides endpoints that allow access to information and actions related to platform integrations to 3rd party services such as Fitbit
  version: v1
servers:
  - url: 'https://api.{env}.{tenant}.lenushealth.dev/samples/v1'
    variables:
      env:
        default: test
        enum:
          - test
          - sbx
      tenant:
        default: ggc
        enum:
          - ggc
        description: 'Available tenants'
paths:
  '/{id}':
    get:
      summary: Retrieves the status of a specified integration provider for the authenticated user
      description: Will return basic information about an integration in the context of the authenticated user (via token).
      operationId: retrieve-integration-by-id-v1
      security: 
        - bearer: []
      parameters:
        - name: id
          in: path
          description: identifier for an integration
          required: true
          schema:
            type: string
            example: fitbit
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/integrationProviderSchemaV1'
        '401':
          description: 'The `access_token` is not valid, this maybe due to expiration or invalid audience of issuer'
        '404':
          description: Either the requested integration information is not available to the authenticated user
  /:
    get:
      summary: Retrieve status for all integration providers available to the authenticated user
      description: Will return basic information about all integrations in the context of the authenticated user (via token).
      operationId: retrieve-integrations-v1
      security: 
        - bearer: []      
      responses:
        '200':
          description: Returns an array of integrations available based on the authorisation token supplied
          content:
            application/json:
              schema:
                type: array
                items: 
                  $ref: '#/components/schemas/integrationProviderSchemaV1'
              example:
                - name: fitbit
                  connected: true
                  connectUri: https://lenusplatform.example/connect/fitbit
        '401':
          description: 'The `access_token` is not valid, this maybe due to expiration or invalid audience of issuer'
components: 
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
  schemas:
    integrationProviderSchemaV1:
      type: object
      properties:
        name:
          type: string
          description: The friendly name of the integration provider
          example: Fitbit
        connected:
          type: boolean
          description: Whether the authenticated user currently has an active platform connection to the specific integration provider
        connectUri:
          description: By redirecting your user to this URI the connect workflow for the integration provider will be initiated
          type: string
          format: uri