Skip to content

Commit 4e427b6

Browse files
ralfhandlralfhandl
committed
Linked MD files from README.md
Cleaner MD content
1 parent 83bdbd2 commit 4e427b6

7 files changed

+220
-304
lines changed

‎README.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,18 @@
2424

2525
<div>
2626
<h3>Further Description of this Repository</h3>
27-
28-
<p>[Any narrative content may be provided here by the TC, for example, if the Members wish to provide an extended statement of purpose.]</p>
27+
<p>This repository contains XML sources as well as auto-generated markdown documentation for the following vocabularies:</p>
2928
</div>
3029

31-
<div>
30+
* [Core](vocabularies/Org.OData.Core.V1.md)
31+
* [Capabilities](vocabularies/Org.OData.Capabilities.V1.md)
32+
* [Measures](vocabularies/Org.OData.Measures.V1.md)
33+
* [Validation](vocabularies/Org.OData.Validation.V1.md)
34+
* [Authorization](vocabularies/Org.OData.Authorization.V1.md)
35+
* [Aggregation](vocabularies/Org.OData.Aggregation.V1.md)
36+
3237

38+
<div>
3339
<h3>Contact</h3>
3440
<p>Please send questions or comments about <a href="https://www.oasis-open.org/resources/tcadmin/github-repositories-for-oasis-tc-members-chartered-work">OASIS TC GitHub repositories</a> to <a href="mailto:[email protected]">Robin Cover</a> and <a href="mailto:[email protected]">Chet Ensign</a>. For questions about content in this repository, please contact the TC Chair or Co-Chairs as listed on the the OData TC's <a href="https://www.oasis-open.org/committees/odata/">home page</a>.</p>
35-
</div>
41+
</div>

‎vocabularies/Org.OData.Aggregation.V1.md

+27-38
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,28 @@
1-
<body xmlns:ac="remove this before pressing 'Apply'">
2-
<h1>Aggregation Vocabulary</h1>
3-
<p>Terms to describe which data in a given entity model can be aggregated, and how.</p>
4-
<p>
5-
<strong>Namespace: Org.OData.Aggregation.V1</strong>
6-
</p>
7-
<p></p>
1+
# Aggregation Vocabulary
2+
3+
Terms to describe which data in a given entity model can be aggregated, and how.
4+
5+
**Namespace: Org.OData.Aggregation.V1**
6+
87
<table width="100%" style="border: 1px solid #000000;" border="1">
9-
<tbody>
10-
<tr>
11-
<th><strong>Term</strong></th><th><strong>Description</strong></th>
12-
</tr>
13-
<tr>
14-
<td>ApplySupported</td><td>This structured type or entity container supports the $apply system query option</td>
15-
</tr>
16-
<tr>
17-
<td>Groupable</td><td>This property can be used in the groupby transformation</td>
18-
</tr>
19-
<tr>
20-
<td>Aggregatable</td><td>This property can be used in the aggregate transformation</td>
21-
</tr>
22-
<tr>
23-
<td>CustomAggregate</td><td>Dynamic property that can be used in the aggregate transformation</td>
24-
</tr>
25-
<tr>
26-
<td>ContextDefiningProperties</td><td>The annotated property or custom aggregate is only well-defined in the context of these properties</td>
27-
</tr>
28-
<tr>
29-
<td>LeveledHierarchy</td><td>Defines a leveled hierarchy by defining an ordered list of properties in the hierarchy</td>
30-
</tr>
31-
<tr>
32-
<td>RecursiveHierarchy</td><td>Defines a recursive hierarchy.</td>
33-
</tr>
34-
<tr>
35-
<td>AvailableOnAggregates</td><td>This action or function is available on aggregated entities if the RequiredProperties are still defined</td>
36-
</tr>
37-
</tbody>
38-
</table>
39-
</body>
8+
<tbody><tr><th><strong>Term</strong></th><th><strong>Description</strong></th></tr>
9+
<tr><td>ApplySupported</td>
10+
<td>This structured type or entity container supports the $apply system query option</td></tr>
11+
<tr><td>Groupable</td>
12+
<td>This property can be used in the groupby transformation</td></tr>
13+
<tr><td>Aggregatable</td>
14+
<td>This property can be used in the aggregate transformation</td></tr>
15+
<tr><td>CustomAggregate</td>
16+
<td>Dynamic property that can be used in the aggregate transformation</td></tr>
17+
<tr><td>ContextDefiningProperties</td>
18+
<td>The annotated property or custom aggregate is only well-defined in the context of these properties</td></tr>
19+
<tr><td>LeveledHierarchy</td>
20+
<td>Defines a leveled hierarchy by defining an ordered list of properties in the hierarchy</td></tr>
21+
<tr><td>RecursiveHierarchy</td>
22+
<td>Defines a recursive hierarchy.</td></tr>
23+
<tr><td>AvailableOnAggregates</td>
24+
<td>This action or function is available on aggregated entities if the RequiredProperties are still defined</td></tr>
25+
26+
</tbody></table>
27+
28+
[XML Source](Org.OData.Aggregation.V1.xml)

‎vocabularies/Org.OData.Authorization.V1.md

+13-17
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
1-
<body xmlns:ac="remove this before pressing 'Apply'">
2-
<h1>OData Vocabulary</h1>
3-
<p>The Authorization Vocabulary provides terms for describing a web authorization flow</p>
4-
<p>
5-
<strong>Namespace: Org.OData.Authorization</strong>
6-
</p>
7-
<p></p>
1+
# OData Vocabulary
2+
3+
The Authorization Vocabulary provides terms for describing a web authorization flow
4+
5+
**Namespace: Org.OData.Authorization**
6+
87
<table width="100%" style="border: 1px solid #000000;" border="1">
9-
<tbody>
10-
<tr>
11-
<th><strong>Term</strong></th><th><strong>Description</strong></th>
12-
</tr>
13-
<tr>
14-
<td>Authorizations</td><td>Lists the methods available to authorize access to the annotated resource.</td>
15-
</tr>
16-
</tbody>
17-
</table>
18-
</body>
8+
<tbody><tr><th><strong>Term</strong></th><th><strong>Description</strong></th></tr>
9+
<tr><td>Authorizations</td>
10+
<td>Lists the methods available to authorize access to the annotated resource.</td></tr>
11+
12+
</tbody></table>
13+
14+
[XML Source](Org.OData.Authorization.xml)

‎vocabularies/Org.OData.Capabilities.V1.md

+63-92
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,64 @@
1-
<body xmlns:ac="remove this before pressing 'Apply'">
2-
<h1>Capabilities Vocabulary</h1>
3-
<p>Terms describing capabilities of a service</p>
4-
<p>
5-
<strong>Namespace: Org.OData.Capabilities.V1</strong>
6-
</p>
7-
<p></p>
1+
# Capabilities Vocabulary
2+
3+
Terms describing capabilities of a service
4+
5+
**Namespace: Org.OData.Capabilities.V1**
6+
87
<table width="100%" style="border: 1px solid #000000;" border="1">
9-
<tbody>
10-
<tr>
11-
<th><strong>Term</strong></th><th><strong>Description</strong></th>
12-
</tr>
13-
<tr>
14-
<td>ConformanceLevel</td><td>The conformance level achieved by this service</td>
15-
</tr>
16-
<tr>
17-
<td>SupportedFormats</td><td>Media types of supported formats, including format parameters</td>
18-
</tr>
19-
<tr>
20-
<td>SupportedMetadataFormats</td><td>Media types of supported formats for $metadata, including format parameters</td>
21-
</tr>
22-
<tr>
23-
<td>AcceptableEncodings</td><td>List of acceptable compression methods for ($batch) requests, e.g. gzip</td>
24-
</tr>
25-
<tr>
26-
<td>AsynchronousRequestsSupported</td><td>Service supports the asynchronous request preference</td>
27-
</tr>
28-
<tr>
29-
<td>BatchContinueOnErrorSupported</td><td>Service supports the continue on error preference. Supports $batch requests. Services that apply the BatchContinueOnErrorSupported term should also specify the ContinueOnErrorSupported property from the BatchSupport term.</td>
30-
</tr>
31-
<tr>
32-
<td>IsolationSupported</td><td>Supported odata.isolation levels</td>
33-
</tr>
34-
<tr>
35-
<td>CallbackSupported</td><td>Supports callbacks for the specified protocols</td>
36-
</tr>
37-
<tr>
38-
<td>CrossJoinSupported</td><td>Supports cross joins for the entity sets in this container</td>
39-
</tr>
40-
<tr>
41-
<td>ChangeTracking</td><td>Change tracking capabilities of this service or entity set</td>
42-
</tr>
43-
<tr>
44-
<td>CountRestrictions</td><td>Restrictions on /$count path suffix and $count=true system query option</td>
45-
</tr>
46-
<tr>
47-
<td>NavigationRestrictions</td><td>Restrictions on navigating properties according to OData URL conventions</td>
48-
</tr>
49-
<tr>
50-
<td>IndexableByKey</td><td>Supports key values according to OData URL conventions</td>
51-
</tr>
52-
<tr>
53-
<td>TopSupported</td><td>Supports $top</td>
54-
</tr>
55-
<tr>
56-
<td>SkipSupported</td><td>Supports $skip</td>
57-
</tr>
58-
<tr>
59-
<td>BatchSupported</td><td>Supports $batch requests. Services that apply the BatchSupported term should also apply the more comprehensive BatchSupport term.</td>
60-
</tr>
61-
<tr>
62-
<td>BatchSupport</td><td>Batch Support for the service</td>
63-
</tr>
64-
<tr>
65-
<td>FilterFunctions</td><td>List of functions and operators supported in $filter</td>
66-
</tr>
67-
<tr>
68-
<td>FilterRestrictions</td><td>Restrictions on $filter expressions</td>
69-
</tr>
70-
<tr>
71-
<td>SortRestrictions</td><td>Restrictions on $orderby expressions</td>
72-
</tr>
73-
<tr>
74-
<td>ExpandRestrictions</td><td>Restrictions on $expand expressions</td>
75-
</tr>
76-
<tr>
77-
<td>SearchRestrictions</td><td>Restrictions on $search expressions</td>
78-
</tr>
79-
<tr>
80-
<td>InsertRestrictions</td><td>Restrictions on insert operations</td>
81-
</tr>
82-
<tr>
83-
<td>DeepInsertSupport</td><td>Deep Insert Support for the service</td>
84-
</tr>
85-
<tr>
86-
<td>UpdateRestrictions</td><td>Restrictions on update operations</td>
87-
</tr>
88-
<tr>
89-
<td>DeleteRestrictions</td><td>Restrictions on delete operations</td>
90-
</tr>
91-
</tbody>
92-
</table>
93-
</body>
8+
<tbody><tr><th><strong>Term</strong></th><th><strong>Description</strong></th></tr>
9+
<tr><td>ConformanceLevel</td>
10+
<td>The conformance level achieved by this service</td></tr>
11+
<tr><td>SupportedFormats</td>
12+
<td>Media types of supported formats, including format parameters</td></tr>
13+
<tr><td>SupportedMetadataFormats</td>
14+
<td>Media types of supported formats for $metadata, including format parameters</td></tr>
15+
<tr><td>AcceptableEncodings</td>
16+
<td>List of acceptable compression methods for ($batch) requests, e.g. gzip</td></tr>
17+
<tr><td>AsynchronousRequestsSupported</td>
18+
<td>Service supports the asynchronous request preference</td></tr>
19+
<tr><td>BatchContinueOnErrorSupported</td>
20+
<td>Service supports the continue on error preference. Supports $batch requests. Services that apply the BatchContinueOnErrorSupported term should also specify the ContinueOnErrorSupported property from the BatchSupport term.</td></tr>
21+
<tr><td>IsolationSupported</td>
22+
<td>Supported odata.isolation levels</td></tr>
23+
<tr><td>CallbackSupported</td>
24+
<td>Supports callbacks for the specified protocols</td></tr>
25+
<tr><td>CrossJoinSupported</td>
26+
<td>Supports cross joins for the entity sets in this container</td></tr>
27+
<tr><td>ChangeTracking</td>
28+
<td>Change tracking capabilities of this service or entity set</td></tr>
29+
<tr><td>CountRestrictions</td>
30+
<td>Restrictions on /$count path suffix and $count=true system query option</td></tr>
31+
<tr><td>NavigationRestrictions</td>
32+
<td>Restrictions on navigating properties according to OData URL conventions</td></tr>
33+
<tr><td>IndexableByKey</td>
34+
<td>Supports key values according to OData URL conventions</td></tr>
35+
<tr><td>TopSupported</td>
36+
<td>Supports $top</td></tr>
37+
<tr><td>SkipSupported</td>
38+
<td>Supports $skip</td></tr>
39+
<tr><td>BatchSupported</td>
40+
<td>Supports $batch requests. Services that apply the BatchSupported term should also apply the more comprehensive BatchSupport term.</td></tr>
41+
<tr><td>BatchSupport</td>
42+
<td>Batch Support for the service</td></tr>
43+
<tr><td>FilterFunctions</td>
44+
<td>List of functions and operators supported in $filter</td></tr>
45+
<tr><td>FilterRestrictions</td>
46+
<td>Restrictions on $filter expressions</td></tr>
47+
<tr><td>SortRestrictions</td>
48+
<td>Restrictions on $orderby expressions</td></tr>
49+
<tr><td>ExpandRestrictions</td>
50+
<td>Restrictions on $expand expressions</td></tr>
51+
<tr><td>SearchRestrictions</td>
52+
<td>Restrictions on $search expressions</td></tr>
53+
<tr><td>InsertRestrictions</td>
54+
<td>Restrictions on insert operations</td></tr>
55+
<tr><td>DeepInsertSupport</td>
56+
<td>Deep Insert Support for the service</td></tr>
57+
<tr><td>UpdateRestrictions</td>
58+
<td>Restrictions on update operations</td></tr>
59+
<tr><td>DeleteRestrictions</td>
60+
<td>Restrictions on delete operations</td></tr>
61+
62+
</tbody></table>
63+
64+
[XML Source](Org.OData.Capabilities.V1.xml)

0 commit comments

Comments
 (0)