OpenADR Alliance Notifiers API

openapi: 3.2.0
info:
  title: OpenADR 3 Notifiers API
  version: 1.0.0
  description: The OpenADR 3 API supports energy retailer to energy customer Demand Response programs.
  contact:
    email: info@openadr.org
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- description: SwaggerHub API Auto Mocking
  url: https://virtserver.swaggerhub.com/OPENADR3_1/openADR3.1.0/1.0.0
tags:
- name: Notifiers
paths:
  /notifiers:
    get:
      tags:
      - Notifiers
      summary: List all notifier bindings
      operationId: listAllNotifiers
      description: List all notifier bindings supported by the server
      security:
      - oAuth2ClientCredentials:
        - read_all
      - bearerAuth: []
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/notifiersResponse'
components:
  schemas:
    notifiersResponse:
      type: object
      description: Provides details of each notifier binding supported
      required:
      - WEBHOOK
      properties:
        WEBHOOK:
          type: boolean
          description: Currently MUST be true
          example: true
        MQTT:
          $ref: '#/components/schemas/mqttNotifierBindingObject'
    mqttNotifierAuthenticationOauth2BearerToken:
      type: object
      description: MQTT broker OAuth2 Bearer Token authentication details
      required:
      - method
      - username
      properties:
        method:
          type: string
          enum:
          - OAUTH2_BEARER_TOKEN
          description: Specifies OAuth2 bearer token authentication
        username:
          type: string
          description: Either the distinguished string "{clientID}", or any other literal string
    mqttNotifierAuthenticationCertificate:
      type: object
      description: MQTT broker mTLS client certificate authentication details
      required:
      - method
      - caCert
      - clientCert
      - clientKey
      properties:
        method:
          type: string
          enum:
          - CERTIFICATE
          description: Specifies certificate authentication
        caCert:
          type: string
          description: String containing the Certificate Authority certificate
        clientCert:
          type: string
          description: String containing the Client certificate
        clientKey:
          type: string
          description: String containing the client certificate private key
    mqttNotifierAuthenticationAnonymous:
      type: object
      description: MQTT broker anonymous authentication details
      required:
      - method
      properties:
        method:
          type: string
          enum:
          - ANONYMOUS
          description: Specifies anonymous authentication
    mqttNotifierBindingObject:
      type: object
      description: Details of MQTT binding for messaging protocol support
      required:
      - URIS
      - serialization
      - authentication
      properties:
        URIS:
          type: array
          items:
            type: string
            format: uri
            description: URIs for connection to MQTT broker
            example: mqtts://broker.vtn.company.com
        serialization:
          type: string
          description: Currently always JSON, perhaps other formats supported in future
          enum:
          - JSON
        authentication:
          oneOf:
          - $ref: '#/components/schemas/mqttNotifierAuthenticationAnonymous'
          - $ref: '#/components/schemas/mqttNotifierAuthenticationOauth2BearerToken'
          - $ref: '#/components/schemas/mqttNotifierAuthenticationCertificate'
          description: Authentication method supported for connection to MQTT broker
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      description: Client credential flow.
      flows:
        clientCredentials:
          tokenUrl: auth/token
          scopes:
            read_all: BL can read all resources
            read_targets: VENs may only read objects with targets by providing matching targets
            read_ven_objects: VENs may only read objects whose clientID matches their own
            write_programs: Only BL can write to programs
            write_events: Only BL can write to events
            write_reports: only VENs can write to reports
            write_subscriptions: VENs and BL can write to subscriptions
            write_vens: VENS and BL can write to vens and resources
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT