@sap-ux/odata-vocabularies
Carries the OASIS and SAP OData vocabularies as a package, with a VocabularyService for asking which terms exist, where they apply and what their types and properties are.
Annotation tooling needs the vocabularies before it can check anything: which terms exist, what they may be applied to, and what a term's type and properties are. This package keeps copies of the vocabularies OASIS and SAP publish and exposes them through VocabularyService, whose methods answer term applicability, types and properties, and documentation. The questions it answers are about the vocabulary rather than about a project, so nothing in it reads or writes the annotations of a particular service; that half is @sap-ux/fiori-annotation-api@sap-ux/fiori-annotation-apiThe programmatic API Fiori tooling uses to read and write annotations on a project, rather than editing the files as text.sap official, cap's. It declares Node.js 22 or later.
Facts
Where it sits
Who is behind it
In the atlas: maintains 7, contributes to 25@devineaSAPSAPMaintains this
In the atlas: maintains 137, wrote 14@SAPmaintainersCian MorrinContributes to this
In the atlas: contributes to 15@cianmSAPDonal Tobin (SAP)Contributes to this
In the atlas: contributes to 13@donal-tobin-sapfionan-SAPContributes to this
In the atlas: contributes to 14@fionan-SAPgernotkuhrContributes to this
In the atlas: contributes to 10@gernotkuhrDominik HeimContributes to this
In the atlas: contributes to 25@heimwegeMaruf RasullyContributes to this
In the atlas: contributes to 12@marufrasullyVilim MikicContributes to this
In the atlas: contributes to 16@mikicvi-SAPNafees AhmedContributes to this
In the atlas: contributes to 11@nahmed22Tobias QueckContributes to this
In the atlas: contributes to 17@tobiasqueckUwe SchwerkContributes to this
In the atlas: contributes to 9@UweSchwerk13 contributors
What it declares
Every artifact
- Type
- Package
- Origin
- By SAP
- Runtime
- Node.js
As a package
- Where it runs
- does not say
- Distributed through
- npm
Connections
Describing a service so a Fiori client renders it without UI code
Download
Install
npm add @sap-ux/odata-vocabulariesDerived from the package name. No recipe recorded; the README has the configuration.
README
quoted from SAP/open-ux-tools under Apache-2.0, read
@sap-ux/odata-vocabularies
Library that contains the most recent copies of the OData vocabularies authored by OASIS and SAP
Supported Vocabularies
- Aggregation
- Authorization
- Core
- Capabilities
- Measures
- Temporal
- Repeatability
- Validation
- JSON
- Analytics
- Auditing
- CodeList
- Common
- Communication
- DataIntegration
- DirectEdit
- Graph
- Hierarchy
- HTML5
- ODM
- PersonalData
- Session
- Support
- UI
Maintaining Vocabularies
Use the odata-vocabularies-sync skill (.agents/skills/odata-vocabularies-sync/SKILL.md) via an AI agent:
- No argument — update all existing vocabularies to their latest published versions
- With a JSON URL (must end in
.json, XML is not supported) — register a new vocabulary, then update all
Local testing in tools-suite
To test local changes to this package inside the XML annotation language server of tools-suite, use yalc. pnpm link does not work there because the language server is an esbuild bundle and dependencies are resolved at build time.
Quick reference — after every change:
# in open-ux-tools/packages/odata-vocabularies
pnpm --filter @sap-ux/odata-vocabularies build
yalc push
# in tools-suite root
yalc add @sap-ux/odata-vocabularies
yarn build:scope sap-ux-annotation-modeler-extension
# restart the Extension Host in VS CodeInstallation
Npm
npm install --save @sap-ux/odata-vocabularies
Yarn
yarn add @sap-ux/odata-vocabularies
Pnpm
pnpm add @sap-ux/odata-vocabularies
Usage
-
Import the needed functions in your modules
import { VocabularyService } from '@sap-ux/odata-vocabularies';
Vocabulary API
The vocabulary API is implemented via class VocabularyService and currently exposes the following functions:
-
checkTermApplicability
-
getComplexType
-
getComplexTypeProperty
-
getDerivedTypeNames
-
getDocumentation
-
getTerm
-
getTermsForTargetKinds
-
getType
-
getVocabularies
-
getVocabulary
-
getVocabularyNamespace
History
Dependencies 1
Notes
Patch Changes
Workspace Updates
- @sap-ux/odata-annotation-core-types 1.0.3 → 1.0.4
Dependencies 1
Notes
Patch Changes
Workspace Updates
- @sap-ux/odata-annotation-core-types 1.0.2 → 1.0.3
Dependencies 1
Notes
Patch Changes
Workspace Updates
- @sap-ux/odata-annotation-core-types 1.0.1 → 1.0.2
Fixes 2
Notes
Released: 2026-06-03T14:58:37Z
Patch Changes
- 21a3de7: FIX: TypeScript type errors in test files (ESM migration follow-up)
- Updated dependencies [21a3de7]
- @sap-ux/odata-annotation-core-types@1.0.1
Breaking 1, Fixes 1
Notes
Released: 2026-05-30T20:54:07Z
Major Changes
-
32609a7: # Migration to ECMAScript Modules (ESM)
Packages in the SAP Open UX Tools monorepo have been migrated from CommonJS (CJS) to ECMAScript Modules (ESM) with NodeNext module resolution.
'@sap-ux/backend-proxy-middleware-cf' is experimental and will remain at major version 0. '@sap-ux/generator-odata-downloader' is a top level yeoman generator and will remain as CJS until validation as ESM is done.
What Changed
- Module System: Most packages now use native ESM (
"type": "module"in package.json) - TypeScript Configuration: Updated to
module: "NodeNext"andmoduleResolution: "NodeNext" - Import Statements: All relative imports now include explicit
.jsextensions (per ESM spec) - Build Output: Generated JavaScript files are now ESM modules
- Node.js Requirement: Minimum Node.js version remains >=22.x
Jest Configuration (for Testing)
If your project tests code that imports these packages, update your Jest configuration:
export default { extensionsToTreatAsEsm: ['.ts'], transform: { '^.+\\.ts$': ['ts-jest', { useESM: true }] } };And run Jest with:
NODE_OPTIONS='--experimental-vm-modules' jest - Module System: Most packages now use native ESM (
Patch Changes
- Updated dependencies [32609a7]
- @sap-ux/odata-annotation-core-types@1.0.0
-
Fixes 1
Notes
Released: 2026-05-20T13:39:22Z
Patch Changes
- Updated dependencies [2f1ece0]
- @sap-ux/odata-annotation-core-types@0.6.1
- Updated dependencies [2f1ece0]
Features 1, Fixes 1
Notes
Released: 2026-05-15T08:12:20Z
Minor Changes
- 72695e5: chore: drop Node 20 support as it is no longer maintained
Patch Changes
- Updated dependencies [72695e5]
- @sap-ux/odata-annotation-core-types@0.6.0
Fixes 2
Notes
Released: 2026-05-14T11:45:51Z
Patch Changes
- 50a8ba5: chore: fresh release after workflow updates
- Updated dependencies [50a8ba5]
- @sap-ux/odata-annotation-core-types@0.5.9
Fixes 1
Notes
Released: 2026-04-30T14:23:24Z
Patch Changes
- @sap-ux/odata-annotation-core-types@0.5.8
Fixes 1
Notes
Released: 2026-03-30T22:24:11Z
Patch Changes
- c53a4ba: chore(odata-vocabularies): upgrade prettier 2.5.1 → 3.8.1; remove @types/prettier (types now bundled in prettier 3.x)
Fixes 1
Notes
Released: 2026-03-16T17:06:45Z
Patch Changes
- Updated dependencies [dfa433e]
- @sap-ux/odata-annotation-core-types@0.5.7
- Updated dependencies [dfa433e]
Fixes 1
Notes
Released: 2026-03-04T09:03:38Z
Patch Changes
- Updated dependencies [a2cbf4e]
- @sap-ux/odata-annotation-core-types@0.5.6
- Updated dependencies [a2cbf4e]
Fixes 2
Notes
Released: 2026-02-23T19:07:48Z
Patch Changes
- cc1c422: fix(deps): update dependency npm-run-all2 to v8
- Updated dependencies [cc1c422]
- @sap-ux/odata-annotation-core-types@0.5.5
Fixes 2
Notes
Released: 2026-02-10T21:03:43Z
Patch Changes
- 3795bb2: Add Node.js engine requirement (>=20.x)
- Updated dependencies [3795bb2]
- @sap-ux/odata-annotation-core-types@0.5.4
Fixes 1
Notes
Released: 2026-01-29T14:02:02Z
Patch Changes
- Updated dependencies [6d71400]
- @sap-ux/odata-annotation-core-types@0.5.3
- Updated dependencies [6d71400]
Fixes 2
Notes
Released: 2025-12-15T10:50:50Z
Patch Changes
- 4ecfbe2: Chore - upgrade eslint devDependenies, convert to flat config and fix lint issues.
- Updated dependencies [4ecfbe2]
- @sap-ux/odata-annotation-core-types@0.5.2
Fixes 2
Notes
Released: 2025-11-05T06:53:42Z
Patch Changes
- cfe9c13: Add deep link to package and changelog to README.md
- Updated dependencies [cfe9c13]
- @sap-ux/odata-annotation-core-types@0.5.1
Fixes 1
Notes
Released: 2025-09-23T16:06:33Z
Patch Changes
- Updated dependencies [aa8bb7a]
- @sap-ux/odata-annotation-core-types@0.5.0
- Updated dependencies [aa8bb7a]
Fixes 1
Notes
Released: 2025-09-16T20:04:56Z
Patch Changes
- Updated dependencies [1f18878]
- @sap-ux/odata-annotation-core-types@0.4.6
- Updated dependencies [1f18878]
Fixes 1
Notes
Released: 2025-08-13T10:00:10Z
Patch Changes
- Updated dependencies [c7db726]
- @sap-ux/odata-annotation-core-types@0.4.5
- Updated dependencies [c7db726]
Fixes 1
Notes
Released: 2025-06-10T10:19:01Z
Patch Changes
- Updated dependencies [08ed948]
- @sap-ux/odata-annotation-core-types@0.4.4
- Updated dependencies [08ed948]
Fixes 1
Notes
Released: 2025-05-14T22:35:53Z
Patch Changes
- @sap-ux/odata-annotation-core-types@0.4.3
Fixes 1
Notes
Released: 2025-03-10T20:40:35Z
Patch Changes
- 011c8c5: fix(deps): update dependency axios to v1.8.2 [security]
Fixes 2
Notes
Released: 2024-10-04T15:21:13Z
Patch Changes
- 93f8a83: chore - upgrade typescript 5.6.2
- Updated dependencies [93f8a83]
- @sap-ux/odata-annotation-core-types@0.4.2
Fixes 1
Notes
Released: 2024-08-07T11:06:05Z
Patch Changes
- @sap-ux/odata-annotation-core-types@0.4.1
Breaking 1, Features 1, Fixes 1
Notes
Released: 2024-07-05T15:03:05Z
Minor Changes
- c2359077: [BREAKING CHANGE] Change TypeScript transpile target to ES2021 to align with NodeJS 18+
Patch Changes
- Updated dependencies [c2359077]
- @sap-ux/odata-annotation-core-types@0.4.0
Fixes 1
Notes
Released: 2024-06-20T13:03:49Z
Patch Changes
- d09edfd5: Update vocabularies June 2024
Fixes 1
Notes
Released: 2024-04-03T09:16:44Z
Patch Changes
- 95c72dff: update vocabularies content
Fixes 1
Notes
Released: 2024-03-14T15:29:35Z
Patch Changes
- 82c07285: OData Vocabularies: Update Some Texts in Specific Vocabularies For Analytics Support in CDS
Fixes 2
Notes
Released: 2024-02-07T11:10:48Z
Patch Changes
- eb0b7b37: Chore - TypeScript 5 upgrade
- Updated dependencies [eb0b7b37]
- @sap-ux/odata-annotation-core-types@0.3.1
Fixes 1
Notes
Released: 2024-01-24T11:05:22Z
Patch Changes
- aa8469f3: OData Vocabularies: Update Vocabularies Containing Cds Specific Analytics Annotations
Fixes 1
Notes
Released: 2024-01-19T16:44:06Z
Patch Changes
- 820ad0dc: odata-vocabularies for CDS analytics: use IsFLags for collection of enums, remove empty lines
Fixes 1
Notes
Released: 2024-01-17T08:59:35Z
Patch Changes
- 2f1f8366: fix(odata-vocabularies): replace alias ODataJSON with JSON
Features 1
Notes
Released: 2024-01-16T12:59:00Z
Minor Changes
- 39877d71: support loading additional terms for cap cds analytics features
Fixes 1
Notes
Released: 2024-01-09T09:27:13Z
Patch Changes
- Updated dependencies [d6151909]
- @sap-ux/odata-annotation-core-types@0.3.0
- Updated dependencies [d6151909]
Features 1, Fixes 1
Notes
Released: 2023-12-12T07:54:42Z
Minor Changes
- 5b256cea: support applicable terms constraint
Patch Changes
- Updated dependencies [5b256cea]
- @sap-ux/odata-annotation-core-types@0.2.0
Fixes 1
Notes
Released: 2023-12-07T12:16:28Z
Patch Changes
- Updated dependencies [807e2857]
- @sap-ux/odata-annotation-core-types@0.1.3
- Updated dependencies [807e2857]
Fixes 1
Notes
Released: 2023-12-04T14:20:02Z
Patch Changes
- 1df7493f: fix: enable and fill applicableterms
Fixes 1
Notes
Released: 2023-11-24T09:29:29Z
Patch Changes
- 89a1bf27: fix: change access type of uppercaseNameMap prop
Fixes 1
Notes
Released: 2023-11-24T08:58:15Z
Patch Changes
- fd883c14: fix: enable uppercaseNameMap property in vocabulary service
Fixes 1
Notes
Released: 2023-11-22T12:13:22Z
Patch Changes
- 860a43a6: fix: update tesconfig to generate correct files order in dist
Others providing
Compare all 14 on the Fiori annotations page →- com.sap.cds:cds-services-bomcom.sap.cds:cds-services-bomThe Maven bill of materials for CAP Java, pinning every com.sap.cds module in a release, from the API and core runtime to the Spring Boot starters and the CQN engine, to the same version.sap official, capMaven bill of materials pinning CAP Java module versions
- urp-vocaburp-vocabA CDS vocabulary for User-Rendered Patterns, with @urp.display annotations describing views, card templates, layouts and sections on an entity, consumed by the author's own matching renderer.independent, capCDS vocabulary for User-Rendered Patterns display annotations
- @mpah/enum-value-help@mpah/enum-value-helpA CAP plugin that generates value help for enum fields from an @enumValueHelp annotation, serving the enum's values from one generated entity instead of hand-written OData annotations.independent, capCAP plugin generating value help for enum fields from an annotation
- @sap/cds-fiori@sap/cds-fioriFiori draft handling and UI-facing behaviour for CAP services.sap official, capFiori draft handling and UI-facing behaviour for CAP services
- @sap/cds@sap/cdsThe CAP Node.js runtime, which compiles the CDS model, serves the services declared in it, answers generic requests before any handler runs, and loads every cds-plugin.sap official, capCAP Node.js runtime
- @sap/generator-fiori@sap/generator-fioriThe single entry point for generating a Fiori application — the user picks a template and the generator produces the project around it.sap official, capEntry point for generating a Fiori application from a template
- @sap-ux/cds-annotation-parser@sap-ux/cds-annotation-parserParses annotations out of CDS source, so tooling can read what a model says about its UI without compiling it.sap official, capParser for annotations in CDS source
- @sap/ux-cds-compiler-facade@sap/ux-cds-compiler-facadeWraps the CAP CDS compiler behind one set of APIs for annotation handling, so tooling reads a model without tracking which compiler version is installed.sap official, capWrapper around the CDS compiler for annotation handling
- @sap-ux/cds-odata-annotation-converter@sap-ux/cds-odata-annotation-converterConverts CDS annotations into their OData form, which is the translation Fiori tooling needs to reason about a service the way a client sees it.sap official, capConverter from CDS annotations to their OData form
- @sap/ux-cds-odata-language-server-extension@sap/ux-cds-odata-language-server-extensionAdds the OData annotation features to @sap/vscode-cds, the CDS plug-in for Visual Studio Code: completion, micro-snippets, diagnostics, vocabulary documentation, Go to Definition and an i18n check inside a .cds file.sap official, capOData annotation features for the @sap/vscode-cds extension
- @sap-ux/fiori-annotation-api@sap-ux/fiori-annotation-apiThe programmatic API Fiori tooling uses to read and write annotations on a project, rather than editing the files as text.sap official, capProgrammatic API for reading and writing project annotations
- cap-js-geoloc-plugincap-js-geoloc-pluginA CAP plugin for geocoding, address correction and route calculation, driven by three annotations on the model, with the geocoder and router chosen in configuration from providers such as OSRM and Nominatim.independent, capAnnotation-driven geocoding, address correction and routing for CAP
- cap-user-infocap-user-infoResolves the createdBy and modifiedBy of a managed entity to a stored user record of email, given name and family name, and renders the two fields as links with a quickview.independent, capUser details and quickview links for createdBy and modifiedBy
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
Contributors
History in the atlas
- First seen.
For your agent
- Ref
artifact:sap-ux-odata-vocabularies- JSON
- /artifacts/sap-ux-odata-vocabularies.json
- MCP
- Connecting an agent