Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sap/open-resource-discovery

Open Resource Discovery (ORD) is a protocol that allows applications and services to self-describe their exposed resources and capabilities.
https://github.com/sap/open-resource-discovery

api discovery metadata open-resource-discovery ord protocol

Last synced: 29 days ago
JSON representation

Open Resource Discovery (ORD) is a protocol that allows applications and services to self-describe their exposed resources and capabilities.

Host: GitHub
URL: https://github.com/sap/open-resource-discovery
Owner: SAP
License: apache-2.0
Created: 2023-05-08T08:56:14.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-09-27T12:09:16.000Z (about 1 month ago)
Last Synced: 2024-09-27T12:10:11.607Z (about 1 month ago)
Topics: api, discovery, metadata, open-resource-discovery, ord, protocol
Language: TypeScript
Homepage: https://sap.github.io/open-resource-discovery/
Size: 21 MB
Stars: 24
Watchers: 5
Forks: 1
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        [![REUSE status](https://api.reuse.software/badge/github.com/SAP/open-resource-discovery)](https://api.reuse.software/info/github.com/SAP/open-resource-discovery)

# Open Resource Discovery Specification

![Open Resource Discovery Logo](./static/img/open-resource-discovery-logo-wide.png 'Open Resource Discovery Logo')

## Summary

Open Resource Discovery (ORD) is a protocol that **allows applications and services to self-describe their exposed resources and capabilities**.

It can be used to describe static documentation, but can also reflect tenant specific configuration and extensions (at run-time).

**To learn more, have a look at the [Open Resource Discovery Specification](https://sap.github.io/open-resource-discovery/) documentation.**

> ℹ ORD is an open standard by SAP, currently geared towards the SAP ecosystem.

> However, it is built to be a generic standard and could be used outside of SAP, if the infrastructure (aggregators, namespace registry) is built or adjusted.

> The standard is extensible through extensibility attributes, custom types and policy levels.

## Communication, Feedback & FAQ

If you have feedback, questions or problems, please create a [GitHub issue](https://github.com/SAP/open-resource-discovery/issues).

## Ownership and Governance

The ORD development is driven by SAP internally, but public feedback, suggestions and contributions are welcome.

## Resources

### Learning Material

Currently there are no public resources beside the ORD spec itself.

We plan to add more in the future.

### Tools and Examples

#### ORD Reference Application

Check out the [ORD Reference Application](https://ord-reference-application.cfapps.sap.hana.ondemand.com/) for an example ORD implementation and how it behaves.

#### ORD Example Data

- Within this repository: [examples/](./examples/).

## History

For detailed and recent changes, please refer to the [CHANGELOG.md](CHANGELOG.md).

## Acknowledgements

* The original idea for ORD came from Harsh Jegadeesan and Divya Mary.

* The currently active core-contributors to the spec are: [Simon Heimler](https://github.com/Fannon), [Sebastian Wennemers](https://github.com/swennemers), [Steffen Göbel](https://github.com/steffengoebel), [Ralf Hofmann](https://github.com/ormos), [Kiril Kabakchiev](https://github.com/KirilKabakchiev), [Nikolay Mateev](https://github.com/NickyMateev), [Bibin Thomas](https://github.com/Bibin-T) and others.

## License

Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/open-resource-discovery).