Skip to content

Commit 5de9a6e

Browse files
Merge pull request #5925 from joostverhoog/deprecated-odata-3
Publishing OData 3 is deprecated
2 parents 06b4910 + 01766fe commit 5de9a6e

File tree

4 files changed

+6
-13
lines changed

4 files changed

+6
-13
lines changed

content/en/docs/refguide/modeling/integration/odata-services/published-odata-services/_index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@ In Studio Pro, entities can be exposed as [OData resources](/refguide/published-
1212

1313
A published OData service is a REST service with an OpenAPI contract, which means that OpenAPI compatible REST clients can easily interact with it.
1414

15-
The standards used for OData in Mendix are:
15+
The standard used for OData in Mendix is [OData version 4](http://www.odata.org/documentation), which returns data in JSON format.
1616

17-
* [OData version 3](http://www.odata.org/documentation/odata-version-3-0), which returns data in Atom XML format.
18-
* [OData version 4](http://www.odata.org/documentation), which returns data in JSON format.
17+
The option to publish [OData version 3](http://www.odata.org/documentation/odata-version-3-0) services, which return data in Atom XML format, is deprecated and will be removed in a future version.
1918

2019
Not all parts of the standard are implemented. If something is not documented here, it is has not yet been added.
2120

content/en/docs/refguide/modeling/integration/odata-services/published-odata-services/odata-query-options.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ For this example, imagine that you have four entities in your domain model: **Em
3030
* An association between **Employee** and **Address**
3131
* An association between **City** and **Address**
3232

33-
Associated objects can be retrieved by passing the `$expand` query parameter. For example: `/odata/myservice/v1/Employees?$expand=Cars,Address($expand=City)` (OData 4) or `/odata/myservice/v1/Employees?$expand=Cars,Address/City` (OData 3).
33+
Associated objects can be retrieved by passing the `$expand` query parameter. For example: `/odata/myservice/v1/Employees?$expand=Cars,Address($expand=City)` (OData 4) or `/odata/myservice/v1/Employees?$expand=Cars,Address/City` (OData 3 (deprecated)).
3434

3535
## 3 Counting the Number of Objects
3636

@@ -42,7 +42,7 @@ You can find out how many objects there are by passing the `$count` query option
4242

4343
For OData 4, by setting the `$count` query option to `true`, a count of the number of items returned will be included in the result. For example: `?$count=true`.
4444

45-
For OData 3, by setting the `$inlinecount` query option to `allpages`, a count of the number of items returned will be included in the result. For example: `?$inlinecount=allpages`.
45+
For OData 3 (deprecated), by setting the `$inlinecount` query option to `allpages`, a count of the number of items returned will be included in the result. For example: `?$inlinecount=allpages`.
4646

4747
## 4 Filtering
4848

@@ -56,7 +56,7 @@ This table describes how to pass values for different attribute types:
5656
| --- | --- |
5757
| String | Enclosed in single quotes (for example, `'John'`) |
5858
| Enumeration | The enumeration member name between single quotes, prefixed with the enum type (for example, `DefaultNamespace.PrimaryColor'Red'`). OData v4.01 syntax without the qualified enum type name is not supported |
59-
| Datetime | For OData 4: a plain value (for example, `2021-12-31`). For OData 3: Preceded with `datetime` and enclosed in single quotes (for example, `datetime'2021-12-31'` or `datetime'<epoch value here>'`) |
59+
| Datetime | For OData 4: a plain value (for example, `2021-12-31`). For OData 3 (deprecated): Preceded with `datetime` and enclosed in single quotes (for example, `datetime'2021-12-31'` or `datetime'<epoch value here>'`) |
6060
| Other | Plain value (for example, 15) |
6161

6262
### 4.2 Comparison Operators
@@ -97,7 +97,7 @@ We support the following comparison operators:
9797
| minute | `/Employees?$filter=minute(Registration) eq 55` | All employees registered on the 55th minute of any hour |
9898
| second | `/Employees?$filter=second(Registration) eq 55` | All employees registered on the 55th second of any minute of any hour |
9999

100-
<small><sup>1</sup> In OData 3, the `contains` function is called `substringof`, and its arguments are reversed For example, `/Employees?$filter=substringof('f', Name)`</small>
100+
<small><sup>1</sup> In OData 3 (deprecated), the `contains` function is called `substringof`, and its arguments are reversed For example, `/Employees?$filter=substringof('f', Name)`</small>
101101

102102
### 4.5 Combining Filters
103103

content/en/docs/refguide/modeling/integration/odata-services/published-odata-services/published-odata-attribute.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,6 @@ The type of the attribute.
4040

4141
This field is shown when the type is an enumeration that was previously exposed as a string, and only for OData version 4. Change the value to **Enumeration** to publish the enumeration. This informs clients of the possible values of this attribute.
4242

43-
In Studio Pro 9.23 and below, enumeration attributes were published as strings.
44-
4543
### 2.7 Capabilities
4644

4745
Select **Sortable** to allow clients to sort results based on this attribute.

content/en/docs/refguide/modeling/integration/odata-services/wrap-services-odata.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,10 +116,6 @@ When you use a microflow to provide data, any security constraints are applied t
116116

117117
If the **ODataResponse** is present as a microflow parameter, then it will return the **Count** attribute value regardless of the result list of objects. Otherwise, it will return -1 for not defined, which is the default value. A **Count** value of 0 means that there no record.
118118

119-
{{% alert color="info" %}}
120-
In Studio Pro [9.17](/releasenotes/studio-pro/9.17/) and above, the count value can be stored in the `ODataResponse` object.
121-
{{% /alert %}}
122-
123119
## 5 Key Selection When Exposing Entities as OData Resources {#select-key}
124120

125121
Select which attribute(s) to use as a [key](/refguide/published-odata-resource/#key) when exposing an entity as Published OData Resource so that clients will be able to identify objects returned by the service.

0 commit comments

Comments
 (0)