cap-js / ord

Open Resource Discovery (ORD) is a protocol that allows applications and services to self-describe their exposed resources and capabilities. This plugin enables generation of ORD document for CAP based applications.

CDS Plugin for ORD

About this project

This plugin enables generation of ORD document for CAP based applications. When you adopt ORD, your application gains a single entry point, known as the Service Provider Interface. This interface allows you to discover and gather relevant information or metadata. You can use this information to construct a static metadata catalog or to perform a detailed runtime inspection of your actual system landscapes.

Open Resource Discovery (ORD) is a protocol that enables applications and services to self-describe their available resources and capabilities. It's not only useful for describing static documentation, but it also accurately reflects tenant-specific configurations and extensions at runtime. Typically, ORD is used to describe APIs and Events, but it also supports higher-level concepts like Entity Types (Business Objects) and Data Products (beta).

Requirements and Setup

Installation

npm install @cap-js/ord

Usage

Programmatic API

const cds = require('@sap/cds')
require('@cap-js/ord');

const csn = await cds.load(cds.env.folders.srv)
const ord = cds.compile.to.ord(csn)

Command Line

cds compile <path to srv folder> --to ord [-o] [destinationFilePath]

ORD Endpoints

1. Run cds watch in the application's root.
2. Check the following relative paths for ORD information - /.well-known/open-resource-discovery , /open-resource-discovery/v1/documents/1.

Customizing ORD Document

You can find more information, such as how to customize the ORD Document, in this document.

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.

Security / Disclosure

If you find any bug that may be a security problem, please follow our instructions at in our security policy on how to report it. Please do not create GitHub issues for security-related doubts or problems.

Code of Conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.

Licensing

Copyright 2024 SAP SE or an SAP affiliate company and cds-plugin-for-ord contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.