Skip to content

Commit

Permalink
Add disclaimer that metadata access is currently open access (#79)
Browse files Browse the repository at this point in the history
  • Loading branch information
Fannon authored Oct 23, 2024
1 parent 3b1f489 commit f6f6873
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ You can use this information to construct a static metadata catalog or to perfor

For more information, have a look at the [Open Resource Discovery](https://sap.github.io/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
Expand Down Expand Up @@ -59,6 +63,11 @@ This project is open to feature requests/suggestions, bug reports etc. via [GitH

If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/cap-js/ord/issues/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](https://github.com/cap-js/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
Expand Down

0 comments on commit f6f6873

Please sign in to comment.