Application Research Products API

openapi: 3.2.0
info:
  title: Application Research Open Resource Discovery (ORD) Products 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: Products
  description: Product operations
paths:
  /products:
    get:
      tags:
      - Products
      summary: Application Research List all Products
      description: Retrieves a list of all Products across all ORD Documents
      operationId: listProducts
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/OffsetParam'
      - $ref: '#/components/parameters/VendorFilterParam'
      responses:
        '200':
          description: Successfully retrieved list of Products
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductList'
              examples:
                productList:
                  $ref: '#/components/examples/ProductListExample'
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /products/{ordId}:
    get:
      tags:
      - Products
      summary: Application Research Get a Product by ORD ID
      description: Retrieves a specific Product by its ORD ID
      operationId: getProduct
      parameters:
      - $ref: '#/components/parameters/ProductOrdIdParam'
      responses:
        '200':
          description: Successfully retrieved Product
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Product'
              examples:
                product:
                  $ref: '#/components/examples/ProductExample'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    ProductOrdIdParam:
      name: ordId
      in: path
      required: true
      description: ORD ID of the Product
      schema:
        type: string
        pattern: ^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\-]+):()$
      example: 'sap:product:IoTPlatform:'
    VendorFilterParam:
      name: vendor
      in: query
      description: Filter by vendor ORD ID
      schema:
        type: string
      example: 'sap:vendor:SAP:'
    LimitParam:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    OffsetParam:
      name: offset
      in: query
      description: Number of items to skip
      schema:
        type: integer
        minimum: 0
        default: 0
  examples:
    ProductExample:
      summary: SAP IoT Platform Product
      value:
        ordId: 'sap:product:IoTPlatform:'
        title: SAP IoT Platform
        shortDescription: Enterprise IoT platform for industrial applications
        description: SAP IoT Platform provides connectivity, data ingestion, device management, and analytics capabilities for industrial IoT scenarios.
        vendor: 'sap:vendor:SAP:'
    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
    ProductListExample:
      summary: List of Products
      value:
        items:
        - ordId: 'sap:product:IoTPlatform:'
          title: SAP IoT Platform
          shortDescription: Enterprise IoT platform for industrial applications
          vendor: 'sap:vendor:SAP:'
        - ordId: 'sap:product:SuccessFactors:'
          title: SAP SuccessFactors
          shortDescription: Cloud-based human capital management suite
          vendor: 'sap:vendor:SAP:'
        totalCount: 2
        limit: 20
        offset: 0
  schemas:
    Tag:
      type: string
      pattern: ^[a-zA-Z0-9-_.\/ ]*$
      minLength: 1
    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
    ProductList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Product'
        totalCount:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
    Labels:
      type: object
      title: Labels
      additionalProperties:
        type: array
        items:
          type: string
          minLength: 1
    Product:
      type: object
      title: Product
      description: A commercial product or service
      required:
      - ordId
      - title
      - shortDescription
      - vendor
      properties:
        ordId:
          type: string
          pattern: ^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\-]+):()$
          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
        vendor:
          type: string
          pattern: ^([a-z0-9]+(?:[.][a-z0-9]+)*):(vendor):([a-zA-Z0-9._\-]+):()$
          maxLength: 256
        parent:
          type: string
          pattern: ^([a-z0-9]+(?:[.][a-z0-9]+)*):(product):([a-zA-Z0-9._\-]+):()$
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
        labels:
          $ref: '#/components/schemas/Labels'
        documentationLabels:
          $ref: '#/components/schemas/DocumentationLabels'
  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