odata-vocabularies
SAP Vocabularies for semantic markup of structured data published via OData services.
SAP Vocabularies
This repository defines the following SAP vocabularies:
- Analytics: Analytical resources
- CodeList: Code Lists
- Common: Semantics common to all types of APIs
- Communication: Contact information based on vCard
- DataIntegration: Data Integration
- DirectEdit: Terms for Direct-Edit User Interfaces - experimental
- Graph: SAP Graph - experimental
- Hierarchy: Hierarchies - experimental
- HTML5: Rendering directives for UI5
- ODM: One Domain Model
- Offline: Terms for Offline OData - experimental
- PDF: PDF response format
- PersonalData: Personal data / GDPR
- Session: Sticky Sessions
- UI: Representing data in user interfaces
These vocabularies complement the OASIS OData Vocabularies published by the OASIS OData Technical Committee.
To learn how to construct an annotation value from a term definition, or vice versa, look here:
- Annotation Cheat-Sheet for CSDL JSON
- Annotation Cheat-Sheet for CSDL XML
- Annotation Cheat-Sheet for CAP CDS
Vocabulary-based annotations fully replace the old SAP Annotations for OData Version 2.0
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 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 to be installed.
Installation
Clone or download this repository, go to its root folder, and type
npm install
Editing
Edit only the XML files, then refresh the JSON and Markdown files with
npm run build
Known Issues
No known issues.
How to obtain support
See CONTRIBUTING.md.
Contributing
See CONTRIBUTING.md.
Licensing
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.