Application Research Consumption Bundles API

openapi: 3.2.0
info:
  title: Application Research Open Resource Discovery (ORD) Consumption Bundles API
  version: 1.12.0
  description: "The Open Resource Discovery (ORD) API provides access to ORD Documents which serve as wrappers \nfor ORD resources and taxonomy. This API enables discovery and management of API resources, \nevent resources, data products, entity types, capabilities, and integration dependencies.\n\nORD enables machine-readable self-description of systems and their capabilities, supporting\nautomated discovery, integration, and governance of enterprise APIs and services.\n"
  contact:
    name: ORD Specification Team
    url: https://open-resource-discovery.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://api.example.com/ord/v1
  description: Production server
- url: https://sandbox.example.com/ord/v1
  description: Sandbox server
security:
- oauth2:
  - ord:read
- bearerAuth: []
tags:
- name: Consumption Bundles
  description: Consumption Bundle operations
paths:
  /consumption-bundles:
    get:
      tags:
      - Consumption Bundles
      summary: Application Research List all Consumption Bundles
      description: Retrieves a list of all Consumption Bundles across all ORD Documents
      operationId: listConsumptionBundles
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/OffsetParam'
      - $ref: '#/components/parameters/VisibilityFilterParam'
      responses:
        '200':
          description: Successfully retrieved list of Consumption Bundles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumptionBundleList'
              examples:
                consumptionBundleList:
                  $ref: '#/components/examples/ConsumptionBundleListExample'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /consumption-bundles/{ordId}:
    get:
      tags:
      - Consumption Bundles
      summary: Application Research Get a Consumption Bundle by ORD ID
      description: Retrieves a specific Consumption Bundle by its ORD ID
      operationId: getConsumptionBundle
      parameters:
      - $ref: '#/components/parameters/ConsumptionBundleOrdIdParam'
      responses:
        '200':
          description: Successfully retrieved Consumption Bundle
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumptionBundle'
              examples:
                consumptionBundle:
                  $ref: '#/components/examples/ConsumptionBundleExample'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ConsumptionBundle:
      type: object
      title: Consumption Bundle
      description: Groups APIs and Events that can be consumed with the same credentials
      required:
      - ordId
      - title
      properties:
        ordId:
          type: string
          pattern: ^([a-z0-9]+(?:[.][a-z0-9]+)*):(consumptionBundle):([a-zA-Z0-9._\-]+):(v0|v[1-9][0-9]*)$
          maxLength: 255
        localId:
          type: string
          maxLength: 255
        correlationIds:
          type: array
          items:
            $ref: '#/components/schemas/CorrelationId'
        title:
          type: string
          minLength: 1
          maxLength: 255
        shortDescription:
          type: string
          minLength: 1
          maxLength: 255
        description:
          type: string
          minLength: 1
        version:
          $ref: '#/components/schemas/SemVer'
        lastUpdate:
          type: string
          format: date-time
        visibility:
          $ref: '#/components/schemas/Visibility'
        credentialExchangeStrategies:
          type: array
          items:
            $ref: '#/components/schemas/CredentialExchangeStrategy'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        labels:
          $ref: '#/components/schemas/Labels'
        documentationLabels:
          $ref: '#/components/schemas/DocumentationLabels'
    Visibility:
      type: string
      enum:
      - public
      - internal
      - private
    ConsumptionBundleList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ConsumptionBundle'
        totalCount:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
    SpecificationId:
      type: string
      pattern: ^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\-]+):(v0|v[1-9][0-9]*)$
      maxLength: 255
      description: Valid Specification ID
    Link:
      type: object
      title: Link
      required:
      - title
      - url
      properties:
        title:
          type: string
          minLength: 1
        url:
          type: string
          format: uri
        description:
          type: string
          minLength: 1
    Tag:
      type: string
      pattern: ^[a-zA-Z0-9-_.\/ ]*$
      minLength: 1
    CredentialExchangeStrategy:
      type: object
      title: Credential Exchange Strategy
      description: Specifies how credentials can be obtained
      required:
      - type
      properties:
        type:
          type: string
        customType:
          $ref: '#/components/schemas/SpecificationId'
        customDescription:
          type: string
          minLength: 1
        callbackUrl:
          type: string
          format: uri
    CorrelationId:
      type: string
      pattern: ^([a-z0-9]+(?:[.][a-z0-9]+)*):([a-zA-Z0-9._\-\/]+):([a-zA-Z0-9._\-\/]+)$
      maxLength: 255
      description: Correlation ID for referencing related data
    DocumentationLabels:
      type: object
      title: Documentation Labels
      additionalProperties:
        type: array
        items:
          type: string
          minLength: 1
    Error:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Error code
        message:
          type: string
          description: Human-readable error message
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        requestId:
          type: string
          description: Request ID for troubleshooting
    Labels:
      type: object
      title: Labels
      additionalProperties:
        type: array
        items:
          type: string
          minLength: 1
    SemVer:
      type: string
      pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
      description: Semantic Version string following SemVer 2.0.0
  parameters:
    ConsumptionBundleOrdIdParam:
      name: ordId
      in: path
      required: true
      description: ORD ID of the Consumption Bundle
      schema:
        type: string
        pattern: ^([a-z0-9]+(?:[.][a-z0-9]+)*):(consumptionBundle):([a-zA-Z0-9._\-]+):(v0|v[1-9][0-9]*)$
      example: sap.iot:consumptionBundle:PlatformAPIs:v1
    LimitParam:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    VisibilityFilterParam:
      name: visibility
      in: query
      description: Filter by visibility level
      schema:
        type: string
        enum:
        - public
        - internal
        - private
    OffsetParam:
      name: offset
      in: query
      description: Number of items to skip
      schema:
        type: integer
        minimum: 0
        default: 0
  examples:
    ConsumptionBundleListExample:
      summary: List of Consumption Bundles
      value:
        items:
        - ordId: sap.iot:consumptionBundle:PlatformAPIs:v1
          title: IoT Platform API Bundle
          shortDescription: Standard API access bundle
          visibility: public
        - ordId: sap.iot:consumptionBundle:HighVolumeIngestion:v1
          title: High Volume Ingestion Bundle
          shortDescription: Optimized for high-throughput data ingestion
          visibility: internal
        totalCount: 2
        limit: 20
        offset: 0
    InternalServerErrorExample:
      summary: Internal Server Error
      value:
        code: INTERNAL_SERVER_ERROR
        message: An unexpected error occurred. Please try again later.
        requestId: req-12345-abcde
    NotFoundErrorExample:
      summary: Not Found Error
      value:
        code: NOT_FOUND
        message: The requested resource was not found
        requestId: req-12345-abcde
    BadRequestErrorExample:
      summary: Bad Request Error
      value:
        code: BAD_REQUEST
        message: Invalid request parameters
        details:
        - field: ordId
          message: ORD ID must match the required pattern
        requestId: req-12345-abcde
    ConsumptionBundleExample:
      summary: IoT Platform API Bundle
      value:
        ordId: sap.iot:consumptionBundle:PlatformAPIs:v1
        title: IoT Platform API Bundle
        shortDescription: Standard API access bundle
        description: OAuth 2.0 protected access to all IoT Platform APIs with standard rate limits.
        version: 1.0.0
        credentialExchangeStrategies:
        - type: custom
          customType: sap.iot:oauth2-jwt:v1
          customDescription: OAuth 2.0 with JWT bearer tokens for IoT Platform access
        visibility: public
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            notFound:
              $ref: '#/components/examples/NotFoundErrorExample'
    BadRequest:
      description: Bad request - invalid input parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            badRequest:
              $ref: '#/components/examples/BadRequestErrorExample'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            serverError:
              $ref: '#/components/examples/InternalServerErrorExample'
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication
      flows:
        clientCredentials:
          tokenUrl: /oauth/token
          scopes:
            ord:read: Read access to ORD resources
            ord:write: Write access to ORD resources
            ord:admin: Administrative access to ORD resources
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT