Skip to content

Commit

Permalink
Merge branch 'main' into ODATA-1618
Browse files Browse the repository at this point in the history
  • Loading branch information
@ralfhandl
ralfhandl committed Nov 30, 2023
2 parents 538ba09 + 36e0daa commit 1358fce
Show file tree
Hide file tree
Showing 39 changed files with 1,239 additions and 1,083 deletions.
634 changes: 315 additions & 319 deletions docs/odata-csdl-json/odata-csdl-json.html
View file

Large diffs are not rendered by default.

82 changes: 45 additions & 37 deletions docs/odata-csdl-json/odata-csdl-json.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -930,7 +930,7 @@ Example 7:
{
"$Version": "4.01",
"$EntityContainer": "org.example.DemoService",
...
…
}
```
:::
Expand Down Expand Up @@ -983,19 +983,19 @@ The reference object MAY contain the members
Example 8: references to other CSDL documents
```json
{
...
…
"$Reference": {
"https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Capabilities.V1.json": {
...
…
},
"https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Core.V1.json": {
...
…
},
"http://example.org/display/v1": {
...
…
}
},
...
…
}
```
:::
Expand Down Expand Up @@ -1061,7 +1061,7 @@ Example 9: references to entity models containing definitions of
vocabulary terms
```json
{
...
…
"$Reference": {
"https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Capabilities.V1.json": {
"$Include": [
Expand Down Expand Up @@ -1089,7 +1089,7 @@ vocabulary terms
]
}
},
...
…
}
```
:::
Expand Down Expand Up @@ -1158,7 +1158,7 @@ The value of `$TargetNamespace` is a namespace.
Example 10: reference documents that contain annotations
```json
{
...
…
"$Reference": {
"http://odata.org/ann/b": {
"$IncludeAnnotations": [
Expand All @@ -1181,7 +1181,7 @@ Example 10: reference documents that contain annotations
]
}
},
...
…
}
```
:::
Expand Down Expand Up @@ -1281,13 +1281,13 @@ Example 11: document defining a schema `org.example` with an alias and a
description for the schema
```json
{
...
…
"org.example": {
"$Alias": "self",
"@Core.Description": "Example schema",
...
…
},
...
…
}
```
:::
Expand All @@ -1314,7 +1314,7 @@ Example 12: annotations targeting the `Person` type with qualifier
"$Annotations": {
"self.Person": {
"@Core.Description#Tablet": "Dummy",
...
…
}
}
}
Expand Down Expand Up @@ -1886,7 +1886,7 @@ Example 22: the `Product` entity type has a navigation property to a
```json
"Product": {
"$Kind": "EntityType",
...
…
"Category": {
"$Kind": "NavigationProperty",
"$Type": "self.Category",
Expand All @@ -1902,7 +1902,7 @@ Example 22: the `Product` entity type has a navigation property to a
},
"Category": {
"$Kind": "EntityType",
...
…
"Products": {
"$Kind": "NavigationProperty",
"$Collection": true,
Expand Down Expand Up @@ -2134,7 +2134,7 @@ the `Kind` property of the category.
```json
"Product": {
"$Kind": "EntityType",
...
…
"CategoryID": {},
"CategoryKind": {},
"Category": {
Expand All @@ -2157,7 +2157,7 @@ the `Kind` property of the category.
"Kind": {
"$Nullable": true
},
...
…
}
```
:::
Expand Down Expand Up @@ -2204,7 +2204,7 @@ products in that category
```json
"Category": {
"$Kind": "EntityType",
...
…
"Products": {
"$Kind": "NavigationProperty",
"$Collection": true,
Expand Down Expand Up @@ -2279,7 +2279,7 @@ Example 25: a complex type used by two entity types
}
},
"Product": {
...
…
"ProductDimensions": {
"$Nullable": true,
"$Type": "self.Dimensions"
Expand All @@ -2290,7 +2290,7 @@ Example 25: a complex type used by two entity types
}
},
"ShipmentBox": {
...
…
"Dimensions": {
"$Nullable": true,
"$Type": "self.Dimensions"
Expand Down Expand Up @@ -3139,7 +3139,7 @@ entity container located in `SomeOtherSchema`
"Extending": {
"$Kind": "EntityContainer",
"$Extends": "Some.Other.Schema.Base",
...
…
}
```
:::
Expand Down Expand Up @@ -3703,8 +3703,7 @@ are defined in [OData-VocCore](#ODataVocCore))
"Property",
"Term"
],
"@Core.Description": "Properties and terms annotated with this term
MUST contain a valid URL",
"@Core.Description": "Properties and terms annotated with this term MUST contain a valid URL",
"@Core.RequiresType": "Edm.String"
}
```
Expand Down Expand Up @@ -4186,7 +4185,7 @@ the null value.
::: example
Example 60: type-cast segment
```
.../self.Manager/...
…/self.Manager/…
```
:::

Expand All @@ -4211,7 +4210,7 @@ properties:
::: example
Example 61: term-cast segments
```
.../@Capabilities.SortRestrictions/...
…/@Capabilities.SortRestrictions/…
```
:::

Expand All @@ -4231,7 +4230,7 @@ expression is the model element reached via this path.
::: example
Example 62: property segments in model path
```
.../Orders/Items/Product/...
…/Orders/Items/Product/…
```
:::

Expand All @@ -4251,11 +4250,11 @@ number of items in the collection identified by the preceding segment.
::: example
Example 63: property segments in instance path
```
.../Addresses/Street
…/Addresses/Street
```

```
.../Addresses/$count
…/Addresses/$count
```
:::

Expand All @@ -4275,11 +4274,11 @@ segment](#TermCast).
Example 64: model path segment addressing an annotation on a navigation property
vs. term cast addressing an annotation on the resource addressed by the navigation property
```
.../[email protected]
…/[email protected]
```

```
.../Items/@Core.Description
…/Items/@Core.Description
```
:::

Expand Down Expand Up @@ -4408,7 +4407,7 @@ enclosing type `self.A` of the hosting property `A2`.
"@[email protected]": {
"$Path": "A1"
},
"@Core.Description": "..."
"@Core.Description": "…"
}
},
"B": {
Expand Down Expand Up @@ -4437,7 +4436,7 @@ type `self.B` of the hosting property `A2`.
"@Core.Description#[email protected]": {
"$Path": "B1"
},
"@Core.Description#viaset": "..."
"@Core.Description#viaset": "…"
},
"self.Container/SetA/A2/@Core.Description#viaset": {
"@Core.IsLanguageDependent": {
Expand All @@ -4456,7 +4455,7 @@ type `self.A` named in the target path.
"@Core.Description#[email protected]": {
"$Path": "A1"
},
"@Core.Description#external": "..."
"@Core.Description#external": "…"
},
"self.A/A2/@Core.Description": {
"@Core.IsLanguageDependent": {
Expand Down Expand Up @@ -4555,7 +4554,6 @@ containing a path.
Example 70:
```json
"@UI.HyperLink": "Supplier",

"@Capabilities.UpdateRestrictions": {
"NonUpdatableNavigationProperties": [
"Supplier",
Expand Down Expand Up @@ -4591,7 +4589,6 @@ Property path expressions are represented as a string containing a path.
Example 71:
```json
"@UI.RefreshOnChangeOf": "ChangedAt",

"@Capabilities.UpdateRestrictions": {
"NonUpdatableProperties": [
"CreatedAt",
Expand Down Expand Up @@ -4627,7 +4624,6 @@ Example 72:
"@UI.DisplayName": {
"$Path": "FirstName"
},

"@UI.DisplayName#second": {
"$Path": "@vCard.Address#work/FullName"
}
Expand Down Expand Up @@ -5539,9 +5535,21 @@ segments
Example 89: Target expressions
```
MySchema.MyEntityContainer/MyEntitySet
```

```
MySchema.MyEntityContainer/MySingleton
```

```
MySchema.MyEntityContainer/MySingleton/MyContainmentNavigationProperty
```

```
MySchema.MyEntityContainer/MySingleton/My.EntityType/MyContainmentNavProperty
```

```
MySchema.MyEntityContainer/MySingleton/MyComplexProperty/MyContainmentNavProp
```
:::
Expand Down
Loading

0 comments on commit 1358fce

Please sign in to comment.