Skip to content

Commit

Permalink
Update to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Fannon committed Aug 28, 2024
1 parent 7d8440d commit e5d2c6e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@

## 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.
This plugin adds support for the [Open Resource Discovery](https://sap.github.io/open-resource-discovery/) (ORD) protocol for CAP based applications.
When you add the ORD, 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.

Open Resource Discovery [(ORD)](https://sap.github.io/open-resource-discovery/) 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).
For more information, have a look at the [Open Resource Discovery](https://sap.github.io/open-resource-discovery/) page.

## Requirements and Setup

Expand Down Expand Up @@ -50,7 +52,6 @@ cds compile <path to srv folder> --to ord [-o] [destinationFilePath]

You can find more information, such as how to customize the ORD Document, in this [document](ord.md).


## Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/ord/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](CONTRIBUTING.md).
Expand Down
1 change: 0 additions & 1 deletion ord.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Example:
"description": "this is my custom description",
"policyLevel": "sap:core:v1"
}

```

For all the service level information they can be added / overwritten using annotations (in the `.cds` files as `@ORD.Extensions`).
Expand Down

0 comments on commit e5d2c6e

Please sign in to comment.