https://github.com/sap/odata-vocabularies
SAP Vocabularies for semantic markup of structured data published via OData (www.odata.org) services.
https://github.com/sap/odata-vocabularies
Last synced: about 1 year ago
JSON representation
SAP Vocabularies for semantic markup of structured data published via OData (www.odata.org) services.
- Host: GitHub
- URL: https://github.com/sap/odata-vocabularies
- Owner: SAP
- License: apache-2.0
- Created: 2019-11-25T10:24:28.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T06:02:11.000Z (about 1 year ago)
- Last Synced: 2025-04-07T07:22:11.124Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://sap.github.io/odata-vocabularies
- Size: 9.43 MB
- Stars: 179
- Watchers: 11
- Forks: 65
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# odata-vocabularies
SAP Vocabularies for semantic markup of structured data published via [OData](https://www.odata.org) services.
## SAP Vocabularies
This repository defines the following SAP vocabularies:
- [Analytics: Analytical resources](vocabularies/Analytics.md)
- [CodeList: Code Lists](vocabularies/CodeList.md)
- [Common: Semantics common to all types of APIs](vocabularies/Common.md)
- [Communication: Contact information based on vCard](vocabularies/Communication.md)
- [DataIntegration: Data Integration](vocabularies/DataIntegration.md)
- [DirectEdit: Terms for Direct-Edit User Interfaces](vocabularies/DirectEdit.md) - _experimental_
- [EntityRelationship: Terms to document relationships outside of the current API context](vocabularies/EntityRelationship.md) - _experimental_
- [Graph: SAP Graph](vocabularies/Graph.md) - _experimental_
- [Hierarchy: Hierarchies](vocabularies/Hierarchy.md) - _experimental_
- [HTML5: Rendering directives for UI5](vocabularies/HTML5.md)
- [ODM: One Domain Model](vocabularies/ODM.md)
- [Offline: Terms for Offline OData](vocabularies/Offline.md) - _experimental_
- [PDF: PDF response format](vocabularies/PDF.md)
- [PersonalData: Personal data / GDPR](vocabularies/PersonalData.md)
- [Session: Sticky Sessions](vocabularies/Session.md)
- [UI: Representing data in user interfaces](vocabularies/UI.md)
These vocabularies complement the [OASIS OData Vocabularies](https://github.com/oasis-tcs/odata-vocabularies) published by the [OASIS OData Technical Committee](https://www.oasis-open.org/committees/odata).
To learn how to construct an annotation value from a term definition, or vice versa, look here:
- [Annotation Cheat-Sheet for CSDL JSON](https://oasis-tcs.github.io/odata-vocabularies/docs/annotation-cheat-sheet-json.html)
- [Annotation Cheat-Sheet for CSDL XML](https://oasis-tcs.github.io/odata-vocabularies/docs/annotation-cheat-sheet.html)
- [Annotation Cheat-Sheet for CAP CDS](https://sap.github.io/odata-vocabularies/docs/annotation-cheat-sheet-cap.html)
Vocabulary-based annotations fully replace the old [SAP Annotations for OData Version 2.0](docs/v2-annotations.md)
## Requirements
Each vocabulary in this repository is described by three files: the `*.xml` source file, an auto-generated equivalent `*.json` representation, and a `*.md` Markdown description, also auto-generated from the `*.xml` source.
No specific tools are needed to use these vocabulary files.
Contributors to this repository will need to run the generators, which require [Node.js](https://nodejs.org/) to be installed.
## Download and Installation
The tools in this repository are only needed by contributors to refresh the `*.json` and `*.md` files after changing the `*.xml` source files. These tools require [Node.js](https://nodejs.org/) to be installed.
To run the tools, you will need to [install](https://pandoc.org/installing.html) [Pandoc](https://pandoc.org).
### Installation
Clone or download this repository, go to its root folder, and type
```sh
npm install
```
### Editing
Edit only the XML files, then refresh the JSON and Markdown files with
```sh
npm run build
```
## Known Issues
No known issues.
## How to obtain support
See [CONTRIBUTING.md](CONTRIBUTING.md).
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md).
## Licensing
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/odata-vocabularies).
[](https://api.reuse.software/info/github.com/SAP/odata-vocabularies)