Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Common.DocumentationRef #306

Merged
merged 11 commits into from
Sep 19, 2024
Merged

Common.DocumentationRef #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
b134372
As discussed in Albatross 2024-02-06
HeikoTheissen Feb 6, 2024
912a357
Example according to URN ABNF
HeikoTheissen Feb 7, 2024
0bf7690
dateElement -> dataElement
HeikoTheissen Feb 7, 2024
000c194
URN namespace sap-com
HeikoTheissen Feb 8, 2024
1121fc6
Merge remote-tracking branch 'origin/main' into Common.DocumentationRef
HeikoTheissen May 6, 2024
b075664
Merge remote-tracking branch 'origin/main' into Common.DocumentationRef
HeikoTheissen Sep 17, 2024
a513e5b
Make experimental
HeikoTheissen Sep 17, 2024
27313c1
Applies everywhere
HeikoTheissen Sep 19, 2024
22ee614
Merge remote-tracking branch 'origin/main' into Common.DocumentationRef
HeikoTheissen Sep 19, 2024
10e1994
Updated example
HeikoTheissen Sep 19, 2024
6dcea79
URI, not URL
HeikoTheissen Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions vocabularies/Common.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,16 @@
"@Core.Description": "A short, human-readable text suitable for tool tips in UIs",
"@Core.IsLanguageDependent": true
},
"DocumentationRef": {
"$Kind": "Term",
"@Common.Experimental": true,
"@Core.Description": "A URI referencing language-dependent documentation for the annotated model element",
uhlmannm marked this conversation as resolved.
Show resolved Hide resolved
"@Core.Example": {
"@odata.type": "https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Core.V1.xml#Core.PrimitiveExampleValue",
"Description": "URN scheme to look up the documentation for an object with given type and id in a given system.\n This example looks up the documentation for data element /iwbep/account in system G1Y_000.",
"Value": "urn:sap-com:documentation:key?=type=DTEL&id=%2fiwbep%2faccount&origin=G1Y_000"
}
},
"Text": {
"$Kind": "Term",
"$Nullable": true,
Expand Down
Loading