Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 3.63 KB

README.md

File metadata and controls

77 lines (47 loc) · 3.63 KB
Raw

REUSE status

CDS Plugin for ORD

About this project

This plugin adds support for the Open Resource Discovery (ORD) protocol for CAP based applications. When you add the ORD plugin, your application gains a single entry point, which allows to discover and gather machine-readable information or metadata about the application. You can use this information to construct a static metadata catalog or to perform a detailed runtime inspection of your actual system instances / system landscapes.

For more information, have a look at the Open Resource Discovery page.

⚠ By installing this plugin, the metadata describing your CAP application will be made openly accessible.

If you have a need to protect your metadata, please refrain from installing this plugin until we support metadata protection (planned).

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]

Sample Application Demo

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.

Sample Application Demo

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.

At the current state, the plugin will expose static metadata with open access. This means that the CAP resources are described and documented openly, but it does not imply that the resources themselves can be accessed.

If you have a need to protect your metadata, please refrain from installing this plugin until we support metadata protection.

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.