[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: RE: Agenda for OData TC meeting on 2018-10-04 - chat transcript
|
I added a (very brief) summary of the discussion that George and I had during the meeting on control information, annotations, and meta-models: [10:00] Michael Pizzo: Discussion: Control information and
annotations are different metamodel concepts that happen to have the same representation in the json payload. [10:01] Michael Pizzo: Protocol operations that target control
information should be specific to control information, and protocol operations that target annotations should be specific to things within the annotation metamodel concept. From: odata@lists.oasis-open.org <odata@lists.oasis-open.org>
On Behalf Of Handl, Ralf [17:01] Room information was updated by: Ralf Handl (SAP SE) New agena item 4 1/2: Request TC GitHub Repository for ANTLR grammar for URL Conventions:
GitHub repository name:odata-antlr
MaintainersHubert Heijkers, hubert-heijkers, hubert@heijkers.com
Stefan Hagen, sdrees, stefan@hagen.link
Mike Pizzo, mikepizzo, mikep@microsoft.com
Ralf Handl, ralfhandl, ralf.handl@sap.com
DescriptionSupporting an ANTLR grammar for OData URLs
Purpose statementThis repository contains an ANTLR-based grammar for OData Uniform Resource Identifiers.
Notes
From: odata@lists.oasis-open.org <odata@lists.oasis-open.org> On Behalf Of Handl, Ralf
Sent: Donnerstag, 4. Oktober 2018 11:24
To: odata@lists.oasis-open.org
Subject: [CAUTION] [odata] Agenda for OData TC meeting on 2018-10-04
Here [1] is a draft agenda for the OData TC (Technical Committee) meeting scheduled on Thursday October 04, 2018 during 8-10 am PDT (17:00-19:00 CEST). For additional information, such as dial-in details and chat room, refer to [2]. For TC timeline, see [3]. Feel free to suggest additions or modifications.
Thanks.
[1] Agenda
1.Roll call [8:00 am PT]
a.Self-registration link: https://www.oasis-open.org/apps/org/workgroup/odata/event.php?event_id=46276
2.Approve agenda [8:05 am PT]
3.Approve minutes from previous meeting(s) [8:10 am PT]
a.Minutes from September 27, 2018 TC Face-to-Face meeting: https://www.oasis-open.org/committees/download.php/64003/odata-meeting-231_on-20180927-and-20180928-minutes-f2f.html
4.Review action items [Action item list: https://www.oasis-open.org/apps/org/workgroup/odata/members/action_items.php?sort_field=due_closed_date] [8:15am PT]
a.Upcoming
i.#0037 Concept for Google Protocol Buffers as a data format Hubert Heijkers 2018-09-27
b.In progress
i.#0036 Register the OData- headers and preferences with IANA Mark Biamonte 2018-07-26
5.Issues [8:20 am PT]
a.GitHub Pull Requests
i.ODATA-1212: Validation.AllowedTerms - https://github.com/oasis-tcs/odata-vocabularies/pull/18
b.V4.01: NEW or OPEN
i.ODATA-1237 How to specify static result entity set for bound actions/functions?
ii.ODATA-1236 What should be returned for inserted non-entity value?
iii.ODATA-1064 Add ability to annotate collections to return only count and NextLink
iv.ODATA-1198 ETag handling deviations from RFC7232 are avoidable if we consider two kinds of ETag (ETag in response header and ETag in response payload)
v.ODATA-1168 Clarify the use of ETags for Avoiding Update Conflicts
vi.ODATA-1165 Describe $expand and $select via prose text and examples, remove ABNF snippets
vii.ODATA-1135 Document use of JSON $schema
viii.ODATA-1005 Make sure we have capabilities for all new 4.01 functionality
c.Vocabularies: NEW or OPEN examples, custom headers and query options, error codes
i.ODATA-1226 Ambiguity with Capabilities.ChangeTracking annotation
ii.ODATA-1216 Terms for POST/PATCH/PUT with system query options to shape response
iii.ODATA-1214 Annotate constructor actions
iv.ODATA-1200 ODATA-884 / Support sample values for types, parameters, request/response bodies
v.ODATA-1194 Add term Core.Example to allow including annotation examples in term definitions
vi.ODATA-1176 Capabilities: add new term SelectSupported
vii.ODATA-1140 ODATA-884 / Add details to HTTPResponseCode term
viii.ODATA-1099 Add annotations to describe custom query options and custom headers
ix.ODATA-884 Add term ErrorCodes to describe possible codes in error messages (public comment c201510e00019)
d.Data Aggregation: NEW or OPEN
i.ODATA-1218 Transformations for recursive hierarchy processing
ii.ODATA-1207 Clarify need for @odata.id in nested response structures
iii.ODATA-947 Transformation for computing ratios with aggregated values
iv.ODATA-945 Correct examples 53 and 54
e.Vocabularies: NEW or OPEN that need more discussion
i.ODATA-1177 Allow referencing a (JSON) schema for Edm.Untyped properties
ii.ODATA-1107 Introduce instance annotation to specify which types an instance "implements"
iii.ODATA-1060 Improve specification of element response requirements
6.Next meetings [9:50 am PT]
a.Thursday October 11, 2018 during 8-10 am PDT (17:00-19:00 CEST)
b.Thursday October 18, 2018 during 8-10 am PDT (17:00-19:00 CEST)
7.AOB and wrap up [9:55 am PT]
[2] References
Chat room: http://webconf.soaphub.org/conf/room/odatatc
Conference call & Screen sharing: https://lync.co.sap.com/meet/ralf.handl/Q4QB1098
Conference call details: https://www.oasis-open.org/apps/org/workgroup/odata/download.php/63673/latest/TC%20meeting%20dial-in%20details.htm
[3] Timeline
https://www.oasis-open.org/committees/download.php/62637/TC%20Timeline-2018-03-02.docx
[17:03] Hubert Heijkers (IBM): Count me in, I'll be there in 3-5 minutes... [17:06] Ralf Handl (SAP SE): Voting Members: 6 of 10 (60%) (used for quorum calculation) [17:06] Ralf Handl (SAP SE): Quorum achieved: yes [17:06] Michael Pizzo: (Hubert; I checked you in) [17:06] Ralf Handl (SAP SE): 2.Approve agenda [8:05 am PT] [17:07] Ralf Handl (SAP SE): Agenda is approved [17:07] Ralf Handl (SAP SE): 3.Approve minutes from previous meeting(s) [8:10 am PT] a.Minutes from September 27, 2018 TC Face-to-Face meeting: https://www.oasis-open.org/committees/download.php/64003/odata-meeting-231_on-20180927-and-20180928-minutes-f2f.html
[17:07] Ralf Handl (SAP SE): Minutes are approved [17:07] Ralf Handl (SAP SE): 4.Review action items [Action item list: https://www.oasis-open.org/apps/org/workgroup/odata/members/action_items.php?sort_field=due_closed_date] [8:15am PT] a.Upcoming
i.#0037 Concept for Google Protocol Buffers as a data format Hubert Heijkers 2018-09-27
b.In progress
i.#0036 Register the OData- headers and preferences with IANA Mark Biamonte 2018-07-26
[17:08] Ralf Handl (SAP SE): 5.Issues [8:20 am PT] a.GitHub Pull Requests
i.ODATA-1212: Validation.AllowedTerms - https://github.com/oasis-tcs/odata-vocabularies/pull/18
[17:09] Ralf Handl (SAP SE): Application of https://issues.oasis-open.org/browse/ODATA-1212 [17:13] Ralf Handl (SAP SE): <Annotations Target="C_PURCHASEORDER_FS_SRV.C_PurchaseOrderFsType"> <Annotation Term="UI.Facets">
<Collection>
<Record Type="UI.CollectionFacet">
<PropertyValue Property="Label" String="General Information"/>
<PropertyValue Property="ID" String="GeneralInfo"/>
<PropertyValue Property="Facets">
<Collection>
<Record Type="UI.ReferenceFacet">
<Annotation Term="UI.IsSummary"/>
<Annotation Term="UI.PartOfPreview"/>
<PropertyValue Property="Label" String="Basic Data"/>
<PropertyValue Property="ID" String="BasicData"/>
<PropertyValue AnnotationPath="@UI.Identification" Property="Target"/>
</Record>
<Record Type="UI.ReferenceFacet">
<PropertyValue Property="Label" String="Delivery and Payment"/>
<PropertyValue Property="ID" String="DelivAndPayment"/>
<PropertyValue AnnotationPath="@UI.FieldGroup#DelivAndPayment" Property="Target"/>
</Record>
<Record Type="UI.ReferenceFacet">
<PropertyValue Property="Label" String="Recipient"/>
<PropertyValue Property="ID" String="Recipient"/>
<PropertyValue AnnotationPath="@UI.FieldGroup#Recipient" Property="Target"/>
</Record>
</Collection>
</PropertyValue>
</Record>
<Record Type="UI.ReferenceFacet">
<PropertyValue Property="Label" String="Items"/>
<PropertyValue Property="ID" String="Items"/>
<PropertyValue AnnotationPath="to_PurchaseOrderItem/@UI.LineItem" Property="Target"/>
</Record>
<Record Type="UI.ReferenceFacet">
<PropertyValue Property="Label" String="Purchase Requisition Items"/>
<PropertyValue Property="ID" String="PurchReqItm"/>
<PropertyValue AnnotationPath="to_PurReqItemByPurOrder/@UI.LineItem#PurchReqItemByPurOrder" Property="Target"/>
</Record>
</Collection>
</Annotation>
[17:17] Ralf Handl (SAP SE): Current definition: <ComplexType Name="ReferenceFacet" BaseType="UI.Facet">
<Annotation Term="Core.Description" String="Facet that refers to a thing perspective, e.g. LineItem" />
<Property Name="Target" Type="Edm.AnnotationPath" Nullable="false">
<Annotation Term="Core.Description"
String="Referenced information: Communication.Contact, Communication.Address, or a term that is tagged with UI.ThingPerspective, e.g. UI.StatusInfo, UI.LineItem, UI.Identification, UI.FieldGroup, UI.Badge" />
</Property>
</ComplexType>
[17:18] Ralf Handl (SAP SE): Would become: <ComplexType Name="ReferenceFacet" BaseType="UI.Facet">
<Annotation Term="Core.Description" String="Facet that refers to a thing perspective, e.g. LineItem" />
<Property Name="Target" Type="Edm.AnnotationPath" Nullable="false">
<Annotation Term="Core.Description"
String="Referenced information: Communication.Contact, Communication.Address, or a term that is tagged with UI.ThingPerspective, e.g. UI.StatusInfo, UI.LineItem, UI.Identification, UI.FieldGroup, UI.Badge" />
</Property>
</ComplexType>
[17:20] Ralf Handl (SAP SE): <ComplexType Name="ReferenceFacet" BaseType="UI.Facet"> <Annotation Term="Core.Description" String="Facet that refers to a thing perspective, e.g. LineItem" />
<Property Name="Target" Type="Edm.AnnotationPath" Nullable="false">
<Annotation Term="Core.Description">
<Collection>
<String>Communication.Contact</String>
...
</Collection>
</Annotation>
<Annotation Term="Core.Description"
String="Referenced information: Communication.Contact, Communication.Address, or a term that is tagged with UI.ThingPerspective, e.g. UI.StatusInfo, UI.LineItem, UI.Identification, UI.FieldGroup, UI.Badge" />
</Property>
</ComplexType>
[17:20] Ralf Handl (SAP SE): <ComplexType Name="ReferenceFacet" BaseType="UI.Facet"> <Annotation Term="Core.Description" String="Facet that refers to a thing perspective, e.g. LineItem" />
<Property Name="Target" Type="Edm.AnnotationPath" Nullable="false">
<Annotation Term="Validation.AllowedTerms">
<Collection>
<String>Communication.Contact</String>
...
</Collection>
</Annotation>
<Annotation Term="Core.Description"
String="Referenced information: Communication.Contact, Communication.Address, or a term that is tagged with UI.ThingPerspective, e.g. UI.StatusInfo, UI.LineItem, UI.Identification, UI.FieldGroup, UI.Badge" />
</Property>
</ComplexType>
[17:25] Michael Pizzo: Annotate a property or term of type AnnotationPath to restrict the terms that can be targeted by the path. [17:27] Ralf Handl (SAP SE): Ralf to update the pull request [17:33] Ralf Handl (SAP SE): New agena item 4 1/2: Request TC GitHub Repository for ANTLR grammar for URL Conventions: GitHub repository name:odata-antlr
MaintainersHubert Heijkers, hubert-heijkers, hubert@heijkers.com
Stefan Hagen, sdrees, stefan@hagen.link
Mike Pizzo, mikepizzo, mikep@microsoft.com
Ralf Handl, ralfhandl, ralf.handl@sap.com
DescriptionSupporting an ANTLR grammar for OData URLs
Purpose statementThis repository contains an ANTLR-based grammar for OData Uniform Resource Identifiers.
Notes
[17:34] Hubert Heijkers (IBM): I move to have the chair request the creation of the odata-antlr git repository with the above mentioned description. [17:34] George Ericson (Dell): Second [17:34] Ralf Handl (SAP SE): Motion passes, Ralf to request Github repo [17:34] Ralf Handl (SAP SE): b.V4.01: NEW or OPEN [17:34] Ralf Handl (SAP SE): ii.ODATA-1236 What should be returned for inserted non-entity value? [17:35] Ralf Handl (SAP SE): https://issues.oasis-open.org/browse/ODATA-1236 [17:41] Ralf Handl (SAP SE): JSON PATCH format: https://tools.ietf.org/html/rfc6902 [17:41] Ralf Handl (SAP SE): Example PATCH /my/data HTTP/1.1
Host: example.org
Content-Length: 326
Content-Type: application/json-patch+json
If-Match: "abc123"
[
{ "op": "test", "path": "/a/b/c", "value": "foo" },
{ "op": "remove", "path": "/a/b/c" },
{ "op": "add", "path": "/a/b/c", "value": [ "foo", "bar" ] },
{ "op": "replace", "path": "/a/b/c", "value": 42 },
{ "op": "move", "from": "/a/b/c", "path": "/a/b/d" },
{ "op": "copy", "from": "/a/b/d", "path": "/a/b/e" }
]
[17:43] Ralf Handl (SAP SE): A.2. Adding an Array Element An example target JSON document:
{ "foo": [ "bar", "baz" ] }
A JSON Patch document:
[
{ "op": "add", "path": "/foo/1", "value": "qux" }
]
The resulting JSON document:
{ "foo": [ "bar", "qux", "baz" ] }
[17:49] Michael Pizzo: Ralf: would expect, if a response was returned, it would be the collection. [17:49] Michael Pizzo: Hubert: would expect, if a response was returned, it would be the added item. [17:52] Michael Pizzo: George: what if you do an POST to collection/$index? [17:53] Michael Pizzo: (mea culpa) $index is a query option: orderedCollection?$index=10 [17:55] Michael Pizzo: consensus: we are (still) okay returning the updated collection. [17:55] Michael Pizzo: Updated proposal: 1) We shouldn't have different behavior for ordered versus non-ordered collections.
2) Inserting into a non-entity collection (in general) isn't creating a resource, so 201 is not appropriate, which resolves the issue of the location and entity-id headers.
3) By default, we should return 204, no content (and no body)
4) If we support the return=representation header, we should return the updated collection.
[17:56] Ralf Handl (SAP SE): ODATA-1236 is OPEN [17:56] Hubert Heijkers (IBM): I move to resolve ODATA-1236 as per the amended proposal [17:56] Michael Pizzo: I second [17:56] Ralf Handl (SAP SE): ODATA-1236 is RESOLVED as proposed [17:57] Ralf Handl (SAP SE): i.ODATA-1237 How to specify static result entity set for bound actions/functions? [17:57] Ralf Handl (SAP SE): https://issues.oasis-open.org/browse/ODATA-1237 [17:57] Ralf Handl (SAP SE): Description Bound actions/functions that return a single entity or a collection of entities can specify the entity set of the returned entities relative to the binding parameter via the EntitySetPath attribute.
How to specify that the returned entities always belong to a statically known entity set that cannot be reached via navigation from the binding parameter type?
[17:59] Ralf Handl (SAP SE): Mike: we intentionally constructed bound functions/actions this way to make the function/action definition independent from the schema that defines the binding target [17:59] Ralf Handl (SAP SE): Mike: also we nowhere have references from Schema children to an Entity Container [18:00] Ralf Handl (SAP SE): Mike: extended path syntax for EntitySetPath would be restricted to V4.01 schemas to not break existing clients [18:01] Ralf Handl (SAP SE): Mike: softer solution would be an annotation. It could also be used in V4 schemas because it can be ignored. [18:16] Michael Pizzo: My other concern would be that, if we allow an absolute path to an entityset for the entitysetpath, that people will default to always specifying that entityset path even if the relative path exists. [18:20] Ralf Handl (SAP SE): Example: EntityType Name=Customer
- NavigationProperty Name=to_Orders
Function Name=OutstandingOrders
- Binding Parameter Name=__in Type=s.Customer
- EntitySetPath=__in/to_Orders
[18:21] Michael Pizzo: That works as long as to_Orders is contained or has a navigationpropertybinding. [18:22] Ralf Handl (SAP SE): ODATA-1237 is OPEN [18:24] Ralf Handl (SAP SE): Proposal No action.
We intentionally constructed bound functions/actions this way to make the function/action definition independent from the schema that defines the binding target.
Also we intentionally don't have references from Schema children to an Entity Container.
Model designers are encourage to add navigation paths that allow them specifying an EntitySetPath.
[18:25] Ralf Handl (SAP SE): Corrected: No action.
We intentionally constructed bound functions/actions this way to make the function/action definition independent of the schema that defines the binding target.
Also we intentionally don't have references from Schema children to an Entity Container.
Model designers are encouraged to add navigation paths that allow them specifying an EntitySetPath.
[18:25] Michael Pizzo: I move we resolve ODATA-1237 with no action. [18:25] Hubert Heijkers (IBM): I second [18:26] Ralf Handl (SAP SE): ODATA-1237 is CLOSED without action [18:27] Ralf Handl (SAP SE): iii.ODATA-1064 Add ability to annotate collections to return only count and NextLink [18:58] Ralf Handl (SAP SE): George and Mike to prepare examples and walk us through the proposal [18:58] Ralf Handl (SAP SE): 6.Next meetings [9:50 am PT] a.Thursday October 11, 2018 during 8-10 am PDT (17:00-19:00 CEST)
b.Thursday October 18, 2018 during 8-10 am PDT (17:00-19:00 CEST)
[18:59] Ralf Handl (SAP SE): 7.AOB and wrap up [9:55 am PT] [18:59] Ralf Handl (SAP SE): Meeting is adjourned! From: odata@lists.oasis-open.org <odata@lists.oasis-open.org>
On Behalf Of Handl, Ralf New agena item 4 1/2: Request TC GitHub Repository for ANTLR grammar for URL Conventions:
From: odata@lists.oasis-open.org <odata@lists.oasis-open.org>
On Behalf Of Handl, Ralf Here [1] is a draft agenda for the OData TC (Technical Committee) meeting
scheduled on
Thursday October 04, 2018 during 8-10 am PDT (17:00-19:00 CEST).
For additional information, such as dial-in details and chat room, refer to [2]. For TC timeline, see [3]. Feel free to suggest additions or modifications.
Thanks. [1]
Agenda
1.
Roll call [8:00 am PT]
2.
Approve agenda [8:05 am PT]
3.
Approve minutes from previous meeting(s) [8:10 am PT]
4.
Review action items [Action item list:
https://www.oasis-open.org/apps/org/workgroup/odata/members/action_items.php?sort_field=due_closed_date] [8:15am PT]
i. #0037
Concept for Google Protocol Buffers as a data format – Hubert Heijkers – 2018-09-27
i. #0036
Register the OData- headers and preferences with IANA – Mark Biamonte – 2018-07-26
5.
Issues [8:20 am PT]
i. ODATA-1212:
Validation.AllowedTerms - https://github.com/oasis-tcs/odata-vocabularies/pull/18
i. ODATA-1237
How to specify static result entity set for bound actions/functions?
ii. ODATA-1236
What should be returned for inserted non-entity value?
iii. ODATA-1064
Add ability to annotate collections to return only count and NextLink
iv. ODATA-1198
ETag handling deviations from RFC7232 are avoidable if we consider two kinds of ETag (ETag in response header and ETag in response payload)
v. ODATA-1168
Clarify the use of ETags for Avoiding Update Conflicts
vi. ODATA-1165
Describe $expand and $select via prose text and examples, remove ABNF snippets
vii. ODATA-1135
Document use of JSON $schema
viii. ODATA-1005
Make sure we have capabilities for all new 4.01 functionality
i. ODATA-1226
Ambiguity with Capabilities.ChangeTracking annotation
ii. ODATA-1216
Terms for POST/PATCH/PUT with system query options to shape response
iii. ODATA-1214
Annotate constructor actions
iv. ODATA-1200
ODATA-884 / Support sample values for types, parameters, request/response bodies
v. ODATA-1194
Add term Core.Example to allow including annotation examples in term definitions
vi. ODATA-1176
Capabilities: add new term SelectSupported
vii. ODATA-1140
ODATA-884 / Add details to HTTPResponseCode term
viii. ODATA-1099
Add annotations to describe custom query options and custom headers
ix. ODATA-884
Add term ErrorCodes to describe possible codes in error messages (public comment c201510e00019)
i. ODATA-1218
Transformations for recursive hierarchy processing
ii. ODATA-1207
Clarify need for @odata.id in nested response structures
iii. ODATA-947
Transformation for computing ratios with aggregated values
iv. ODATA-945
Correct examples 53 and 54
i. ODATA-1177
Allow referencing a (JSON) schema for Edm.Untyped properties
ii. ODATA-1107
Introduce instance annotation to specify which types an instance "implements"
iii. ODATA-1060
Improve specification of element response requirements
6.
Next meetings [9:50 am PT]
7.
AOB and wrap up [9:55 am PT] [2]
References
[3]
Timeline |
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]