Skip to content

Commit

Permalink
ODATA-1486 (#143)
Browse files Browse the repository at this point in the history
  • Loading branch information
ralfhandl authored Nov 8, 2023
1 parent 03d3643 commit f49640c
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 35 deletions.
18 changes: 9 additions & 9 deletions docs/odata-url-conventions/odata-url-conventions.html
Original file line number Diff line number Diff line change
Expand Up @@ -474,17 +474,17 @@ <h2 id="43-addressing-entities"><a name="AddressingEntities" href="#AddressingEn
<p>The basic rules for addressing a collection (of entities), a single entity within a collection, a singleton, as well as a property of an entity are covered in the <code>resourcePath</code> syntax rule in <a href="#ODataABNF">OData-ABNF</a>.</p>
<p>Below is a (non-normative) snippet from <a href="#ODataABNF">OData-ABNF</a>:</p>
<pre><code>resourcePath = entitySetName [collectionNavigation]
/ singleton [singleNavigation]
/ singletonEntity [singleNavigation]
/ actionImportCall
/ entityColFunctionImportCall [ collectionNavigation ]
/ entityFunctionImportCall [ singleNavigation ]
/ complexColFunctionImportCall [ collectionPath ]
/ complexFunctionImportCall [ complexPath ]
/ primitiveColFunctionImportCall [ collectionPath ]
/ primitiveFunctionImportCall [ singlePath ]
/ functionImportCallNoParens
/ crossjoin
/ &#39;$all&#39; [ &quot;/&quot; qualifiedEntityTypeName ]</code></pre>
/ primitiveFunctionImportCall [ primitivePath ]
/ functionImportCallNoParens [ querySegment ]
/ crossjoin [ querySegment ]
/ %s&quot;$all&quot; [ &quot;/&quot; optionallyQualifiedEntityTypeName ]</code></pre>
<p>Since OData has a uniform composable URL syntax and associated rules there are many ways to address a collection of entities, including, but not limited to:</p>
<ul>
<li>Via an entity set (see rule <code>entitySetName</code> in <a href="#ODataABNF">OData-ABNF</a>)</li>
Expand All @@ -495,7 +495,7 @@ <h2 id="43-addressing-entities"><a name="AddressingEntities" href="#AddressingEn
</div>
<ul>
<li>By navigating a collection-valued navigation property (see rule: <code>entityColNavigationProperty</code>)</li>
<li>By invoking a function that returns a collection of entities (see rule: <code>entityColFunctionCall</code>)</li>
<li>By invoking a function import that returns a collection of entities (see rule: <code>entityColFunctionImportCall</code>)</li>
</ul>
<div class="example">
<p>Example 9: function with parameters in resource path</p>
Expand All @@ -506,13 +506,13 @@ <h2 id="43-addressing-entities"><a name="AddressingEntities" href="#AddressingEn
<pre><code>http://host/service/ProductsByColor(color=@color)?@color=&#39;red&#39;</code></pre>
</div>
<ul>
<li>By invoking an action that returns a collection of entities (see rule: <code>actionCall</code>)</li>
<li>By invoking an action import that returns a collection of entities (see rule: <code>actionImportCall</code>)</li>
</ul>
<p>Likewise there are many ways to address a single entity.</p>
<p>Sometimes a single entity can be accessed directly, for example by:</p>
<ul>
<li>Invoking a function that returns a single entity (see rule: <code>entityFunctionCall</code>)</li>
<li>Invoking an action that returns a single entity (see rule: <code>actionCall</code>)</li>
<li>Invoking a function import that returns a single entity (see rule: <code>entityFunctionImportCall</code>)</li>
<li>Invoking an action import that returns a single entity (see rule: <code>actionImportCall</code>)</li>
<li>Addressing a singleton</li>
</ul>
<div class="example">
Expand Down
26 changes: 13 additions & 13 deletions docs/odata-url-conventions/odata-url-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -513,17 +513,17 @@ Below is a (non-normative) snippet from [OData-ABNF](#ODataABNF):

```
resourcePath = entitySetName [collectionNavigation]
/ singleton [singleNavigation]
/ singletonEntity [singleNavigation]
/ actionImportCall
/ entityColFunctionImportCall [ collectionNavigation ]
/ entityFunctionImportCall [ singleNavigation ]
/ complexColFunctionImportCall [ collectionPath ]
/ complexFunctionImportCall [ complexPath ]
/ primitiveColFunctionImportCall [ collectionPath ]
/ primitiveFunctionImportCall [ singlePath ]
/ functionImportCallNoParens
/ crossjoin
/ '$all' [ "/" qualifiedEntityTypeName ]
/ primitiveFunctionImportCall [ primitivePath ]
/ functionImportCallNoParens [ querySegment ]
/ crossjoin [ querySegment ]
/ %s"$all" [ "/" optionallyQualifiedEntityTypeName ]
```

Since OData has a uniform composable URL syntax and associated rules
Expand All @@ -540,8 +540,8 @@ http://host/service/Products

- By navigating a collection-valued
navigation property (see rule: `entityColNavigationProperty`)
- By invoking a function that returns a
collection of entities (see rule: `entityColFunctionCall`)
- By invoking a function import that returns a
collection of entities (see rule: `entityColFunctionImportCall`)

::: example
Example 9: function with parameters in resource path
Expand All @@ -557,16 +557,16 @@ http://host/service/ProductsByColor(color=@color)?@color='red'
```
:::

- By invoking an action that returns a
collection of entities (see rule: `actionCall`)
- By invoking an action import that returns a
collection of entities (see rule: `actionImportCall`)

Likewise there are many ways to address a single entity.

Sometimes a single entity can be accessed directly, for example by:
- Invoking a function that returns a
single entity (see rule: `entityFunctionCall`)
- Invoking an action that returns a single
entity (see rule: `actionCall`)
- Invoking a function import that returns a
single entity (see rule: `entityFunctionImportCall`)
- Invoking an action import that returns a single
entity (see rule: `actionImportCall`)
- Addressing a singleton

::: example
Expand Down
26 changes: 13 additions & 13 deletions odata-url-conventions/4 Resource Path.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,17 @@ Below is a (non-normative) snippet from [OData-ABNF](#ODataABNF):

```
resourcePath = entitySetName [collectionNavigation]
/ singleton [singleNavigation]
/ singletonEntity [singleNavigation]
/ actionImportCall
/ entityColFunctionImportCall [ collectionNavigation ]
/ entityFunctionImportCall [ singleNavigation ]
/ complexColFunctionImportCall [ collectionPath ]
/ complexFunctionImportCall [ complexPath ]
/ primitiveColFunctionImportCall [ collectionPath ]
/ primitiveFunctionImportCall [ singlePath ]
/ functionImportCallNoParens
/ crossjoin
/ '$all' [ "/" qualifiedEntityTypeName ]
/ primitiveFunctionImportCall [ primitivePath ]
/ functionImportCallNoParens [ querySegment ]
/ crossjoin [ querySegment ]
/ %s"$all" [ "/" optionallyQualifiedEntityTypeName ]
```

Since OData has a uniform composable URL syntax and associated rules
Expand All @@ -105,8 +105,8 @@ http://host/service/Products

- By navigating a collection-valued
navigation property (see rule: `entityColNavigationProperty`)
- By invoking a function that returns a
collection of entities (see rule: `entityColFunctionCall`)
- By invoking a function import that returns a
collection of entities (see rule: `entityColFunctionImportCall`)

::: example
Example ##ex: function with parameters in resource path
Expand All @@ -122,16 +122,16 @@ http://host/service/ProductsByColor(color=@color)?@color='red'
```
:::

- By invoking an action that returns a
collection of entities (see rule: `actionCall`)
- By invoking an action import that returns a
collection of entities (see rule: `actionImportCall`)

Likewise there are many ways to address a single entity.

Sometimes a single entity can be accessed directly, for example by:
- Invoking a function that returns a
single entity (see rule: `entityFunctionCall`)
- Invoking an action that returns a single
entity (see rule: `actionCall`)
- Invoking a function import that returns a
single entity (see rule: `entityFunctionImportCall`)
- Invoking an action import that returns a single
entity (see rule: `actionImportCall`)
- Addressing a singleton

::: example
Expand Down

0 comments on commit f49640c

Please sign in to comment.