Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into Common.skip
Browse files Browse the repository at this point in the history
Conflicts:
	vocabularies/Common.md
  • Loading branch information
HeikoTheissen committed Feb 16, 2022
2 parents ae2a625 + 9458f5f commit b410aff
Show file tree
Hide file tree
Showing 61 changed files with 4,668 additions and 1,875 deletions.
12 changes: 12 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"env": {
"commonjs": true,
"es2021": true,
"node": true
},
"extends": "eslint:recommended",
"parserOptions": {
"ecmaVersion": 12
},
"rules": {}
}
3 changes: 2 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
* text=auto
*.xml text
*.json eol=lf
vocabularies/*.md eol=lf
*.md eol=lf
41 changes: 20 additions & 21 deletions .github/workflows/nodejs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,29 @@ on: push

jobs:
build:

runs-on: ubuntu-latest

strategy:
matrix:
node-version: [12.x]
node-version: [16.x]

steps:
- uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: npm install, build, and test
run: |
npm install
npm run build --if-present
git config user.name ${GITHUB_ACTOR}
git config user.email ${PUSHER_EMAIL}
git add vocabularies/*.md vocabularies/*.json
git diff-index --quiet HEAD || git commit -m "auto-refreshed"
git push
env:
CI: true
PUSHER_EMAIL: ${{ github.event.pusher.email }}
- uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: npm install, build, and test
run: |
npm ci
npm run build --if-present
git config user.name ${GITHUB_ACTOR}
git config user.email ${PUSHER_EMAIL}
git add vocabularies/*.md vocabularies/*.json examples/*.json
git diff-index --quiet HEAD || git commit -m "auto-refreshed"
git push
env:
CI: true
PUSHER_EMAIL: ${{ github.event.pusher.email }}
18 changes: 10 additions & 8 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
{
// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
// Extension identifier format: ${publisher}.${name}. Example: vscode.csharp

// List of extensions which should be recommended for users of this workspace.
"recommendations": [
"redhat.vscode-xml"
]
}
"recommendations": [
"bierner.github-markdown-preview",
"dbaeumer.vscode-eslint",
"eg2.vscode-npm-script",
"esbenp.prettier-vscode",
"hbenl.vscode-mocha-test-adapter",
"hbenl.vscode-test-explorer",
"redhat.vscode-xml"
]
}
7 changes: 6 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,10 @@
],
"xml.catalogs": [
"./node_modules/odata-csdl/catalog.xml"
]
],
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"files.insertFinalNewline": true,
"files.trimFinalNewlines": true,
}
45 changes: 22 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,33 @@

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)
* [Graph: SAP Graph](vocabularies/Graph.md) - *experimental*
* [Hierarchy: Hierarchies](vocabularies/Hierarchy.md) - *experimental*
* [ODM: One Domain Model](vocabularies/ODM.md) - *experimental*
* [PersonalData: Personal data / GDPR](vocabularies/PersonalData.md)
* [Session: Sticky Sessions](vocabularies/Session.md)
* [UI: Representing data in user interfaces](vocabularies/UI.md)
* [HTML5: Rendering directives for UI5](vocabularies/HTML5.md)
- [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_
- [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) - _experimental_
- [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)
- [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

Expand All @@ -37,12 +38,10 @@ 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.


### Installation

Clone or download this repository, go to its root folder, and type
Expand All @@ -51,28 +50,28 @@ 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
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).

[![REUSE status](https://api.reuse.software/badge/github.com/SAP/odata-vocabularies)](https://api.reuse.software/info/github.com/SAP/odata-vocabularies)
33 changes: 33 additions & 0 deletions _layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!DOCTYPE html>
<html lang="{{ site.lang | default: "en-US" }}">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">

{% seo %}
<link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
</head>
<body>
<div class="container-lg px-3 my-5 markdown-body">
<h1><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repository_name }}</a></h1>

{{ content }}

</div>
<footer>
<div class="container">
<p>
© Copyright 2016, SAP SE and odata-vocabularies Contributors.
<a href="https://www.sap.com/about/legal/impressum.html">Legal Disclosure</a>.
<a href="https://www.sap.com/corporate/en/legal/terms-of-use.html">Terms of Use</a>.
<a href="{{ site.github.repository_url }}/blob/main/{{ page.path }}">View On <strong>GitHub</strong></a>.
</p>
<p>
This site is hosted by <a href="https://pages.github.com/">GitHub Pages</a>.
Please see the <a href="https://docs.github.com/en/github/site-policy/github-privacy-statement">GitHub Privacy Statement</a> for any information how GitHub processes your personal data.
</p>
</div>
</footer>
</body>
</html>
Loading

0 comments on commit b410aff

Please sign in to comment.