document-1.json

{
  "$schema": "https://open-resource-discovery.github.io/specification/spec-v1/interfaces/Document.schema.json",
  "openResourceDiscovery": "1.9",
  "description": "Example based on ORD Reference App",
  "policyLevels": ["sap:core:v1"],
  "products": [
    {
      "ordId": "sap.foo:product:ord-reference-app:",
      "title": "ORD Reference App",
      "vendor": "sap:vendor:SAP:",
      "shortDescription": "Open Resource Discovery Reference Application"
    }
  ],
  "packages": [
    {
      "ordId": "sap.foo:package:ord-reference-app:v0",
      "title": "Open Resource Discovery Reference Application",
      "shortDescription": "This is a reference application for the Open Resource Discovery standard",
      "description": "This reference application demonstrates how Open Resource Discovery (ORD) can be implemented, demonstrating different resources and discovery aspects",
      "version": "0.3.0",
      "policyLevels": ["sap:core:v1"],
      "partOfProducts": ["sap.foo:product:ord-reference-app:"],
      "vendor": "sap:vendor:SAP:",
      "tags": ["reference application"],
      "labels": {
        "customLabel": ["labels are more flexible than tags as you can define your own keys"]
      },
      "documentationLabels": {
        "Some Aspect": ["Markdown Documentation [with links](#)", "With multiple values"]
      }
    }
  ],
  "consumptionBundles": [
    {
      "ordId": "sap.foo:consumptionBundle:noAuth:v1",
      "title": "Unprotected resources",
      "shortDescription": "Bundle of unprotected resources",
      "description": "This Consumption Bundle contains all resources of the reference app which are unprotected and do not require authentication",
      "version": "1.0.0",
      "lastUpdate": "2022-12-19T15:47:04+00:00"
    }
  ],
  "apiResources": [
    {
      "ordId": "sap.foo:apiResource:astronomy:v1",
      "title": "Astronomy API",
      "shortDescription": "The API allows you to discover...",
      "description": "A longer description of this API with **markdown** \n## headers\n etc...",
      "version": "1.0.3",
      "lastUpdate": "2022-12-19T15:47:04+00:00",
      "visibility": "public",
      "releaseStatus": "active",
      "systemInstanceAware": false,
      "policyLevels": ["sap.foo:custom:v1"],
      "partOfPackage": "sap.foo:package:ord-reference-app:v1",
      "partOfConsumptionBundles": [
        {
          "ordId": "sap.foo:consumptionBundle:noAuth:v1"
        }
      ],
      "partOfGroups": ["sap.foo:groupTypeAbc:sap.foo:groupAssignmentValue"],
      "apiProtocol": "rest",
      "apiResourceLinks": [
        {
          "type": "api-documentation",
          "url": "/swagger-ui.html?urls.primaryName=Astronomy%20V1%20API"
        }
      ],
      "resourceDefinitions": [
        {
          "type": "openapi-v3",
          "mediaType": "application/json",
          "url": "/ord/metadata/astronomy-v1.oas3.json",
          "accessStrategies": [
            {
              "type": "open"
            }
          ]
        }
      ],
      "entryPoints": ["/astronomy/v1"],
      "extensible": {
        "supported": "no"
      }
    }
  ],
  "eventResources": [
    {
      "ordId": "sap.foo:eventResource:ExampleEventResource:v1",
      "title": "Event Example",
      "shortDescription": "Simple Event Example",
      "description": "Example long description",
      "version": "1.2.1",
      "lastUpdate": "2022-12-19T15:47:04+00:00",
      "releaseStatus": "beta",
      "partOfPackage": "sap.foo:package:SomePackage:v1",
      "visibility": "public",
      "resourceDefinitions": [
        {
          "type": "asyncapi-v2",
          "mediaType": "application/json",
          "url": "/some/path/asyncApi2.json",
          "accessStrategies": [
            {
              "type": "open"
            }
          ]
        }
      ],
      "extensible": {
        "supported": "no"
      }
    },
    {
      "ordId": "sap.foo:eventResource:BillingDocumentEvents:v1",
      "title": "Billing Document Events",
      "shortDescription": "Informs a remote system about created, changed, and canceled billing documents",
      "description": "Billing document is an umbrella term for invoices, credit memos, debit memos, pro forma invoices, and their respective cancellation documents. The following events are available for billing document:\n      Billing document canceled\n      Billing document changed\n      Billing Document created",
      "version": "1.0.0",
      "lastUpdate": "2022-12-19T15:47:04+00:00",
      "releaseStatus": "active",
      "partOfPackage": "sap.foo:package:SomePackage:v1",
      "visibility": "public",
      "resourceDefinitions": [
        {
          "type": "asyncapi-v2",
          "mediaType": "application/json",
          "url": "/api/eventCatalog.json",
          "accessStrategies": [
            {
              "type": "open"
            }
          ]
        }
      ],
      "extensible": {
        "supported": "no"
      }
    }
  ],
  "capabilities": [
    {
      "ordId": "sap.foo.bar:capability:mdi:v1",
      "title": "Master Data Integration Capability",
      "type": "sap.mdo:mdi-capability:v1",
      "shortDescription": "Short description of capability",
      "description": "Optional, longer description",
      "version": "1.0.0",
      "lastUpdate": "2023-01-26T15:47:04+00:00",
      "releaseStatus": "active",
      "visibility": "public",
      "partOfPackage": "sap.foo.bar:package:SomePackage:v1",
      "definitions": [
        {
          "type": "sap.mdo:mdi-capability-definition:v1",
          "mediaType": "application/json",
          "url": "/capabilities/foo.bar.json",
          "accessStrategies": [
            {
              "type": "open"
            }
          ]
        }
      ]
    }
  ],
  "groups": [
    {
      "groupId": "sap.foo:groupTypeAbc:sap.foo:groupAssignmentValue",
      "groupTypeId": "sap.foo:groupTypeAbc",
      "title": "Title of group assignment / instance"
    }
  ],
  "groupTypes": [
    {
      "groupTypeId": "sap.foo:groupTypeAbc",
      "title": "Title of group type"
    }
  ],
  "tombstones": [
    {
      "ordId": "sap.foo:apiResource:astronomy:v0",
      "removalDate": "2020-12-02T14:12:59Z"
    }
  ]
}