RE: [odata] Agenda for OData TC meeting on 2017-12-07

anonymous morphed into George Ericson(Dell)

Ralf Handl (SAP SE): Weekly meeting of the OData TC.

Dial-in information: https://www.oasis-open.org/apps/org/workgroup/odata/download.php/56760/latest

Online chat room: http://webconf.soaphub.org/conf/room/odatatc

Screen sharing: https://sap.emea.pgiconnect.com/OData-TC/

Michael Pizzo: Ralf; can you paste in the registration link and agenda? I was not able to find the agenda mail.

Ralf Handl (SAP SE): Voting Members: 5 of 12 (41%) (used for quorum calculation)

anonymous morphed into Mark Biamonte (Progress)

Ralf Handl (SAP SE): Calendar link for registration: https://www.oasis-open.org/apps/org/workgroup/odata/event.php?event_id=44007

Ralf Handl (SAP SE): Voting Members: 6 of 12 (50%) (used for quorum calculation)

Ralf Handl (SAP SE): Voting Members: 7 of 12 (58%) (used for quorum calculation)

Ralf Handl (SAP SE): Quorum achieved: yes

George Ericson(Dell): {"Capacity.Data.Bytes": 1234123}

Ralf Handl (SAP SE): Voting Members: 8 of 12 (66%) (used for quorum calculation)

Ralf Handl (SAP SE): 2.Approve agenda [8:05 am PT]

George Ericson(Dell): { "Capacity" { "Data" { "Bytes" : 1234123}}}

Ralf Handl (SAP SE): Here [1] is a draft agenda for the OData TC (Technical Committee) meeting scheduled on Thursday December 07, 2017 during 8-10 am PST (17:00-19:00 CET). 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=44007

2.Approve agenda [8:05 am PT]

3.Approve minutes from previous meeting(s) [8:10 am PT]

a.Minutes from November 30, 2017 TC meeting: https://www.oasis-open.org/committees/download.php/62132/odata-meeting-197_on-20171130-minutes.html

4.Review action items [Action item list: https://www.oasis-open.org/apps/org/workgroup/odata/members/action_items.php] [8:15am PT]

a.Action items due

i.none

5.Committee Note on OData to OpenAPI Mapping [8:20 am PT]

a.Document Walkthrough

i.https://www.oasis-open.org/committees/download.php/61852/odata-openapi-v1.0-wd02-2017-10-20.docx  starting at 4.6 Field components

6.Issues [9:20 am PT]

a.Vocabularies: APPLIED

i.ODATA-1064 Add ability to annotate collections to return only count and NextLink

b.Vocabularies: NEW or OPEN

i.ODATA-1134 Add KeyAsSegment annotation term to core vocabulary

ii.ODATA-1132 Propagation of NavigationRestrictions

iii.ODATA-1124 Authorization vocabulary: KeyLocation - also allow cookie as value?

iv.ODATA-1121 Extend FilterExpressionRestrictions with "MultiPredicate"

v.ODATA-1067 Consider ability to define computed default values

vi.ODATA-1005 Make sure we have capabilities for all new 4.01 functionality

vii.ODATA-884 Add term ErrorCodes to describe possible codes in error messages (public comment c201510e00019)

7.Next meetings [9:50 am PT]

a.Thursday December 14, 2017 during 8-10 am PST

8.AOB and wrap up [9:55 am PT]

[2] References

Chat room: http://webconf.soaphub.org/conf/room/odatatc

Conference call & Screen sharing: https://sap.emea.pgiconnect.com/OData-TC

Conference call details: https://www.oasis-open.org/apps/org/workgroup/odata/download.php/56760/TC%20meeting%20dial-in%20details.htm

[3] Timeline

https://www.oasis-open.org/committees/download.php/61677/TC%20Timeline-2017-09-29.docx

Ralf Handl (SAP SE): #4: Mark has short update on IANA registration

Ralf Handl (SAP SE): Info: Public Review of V4.01 has started, from December 04 to December 18

Ralf Handl (SAP SE): 7.Next meetings [9:50 am PT]

a.Thursday December 14, 2017 during 8-10 am PST

Ralf Handl (SAP SE): Hubert can't make it

Ralf Handl (SAP SE): Mike can't make it

Ralf Handl (SAP SE): Proposal: no more meetings this year, first meeting next year on January 11

Ralf Handl (SAP SE): Works for Mike, Hubert, Martin, Ralf

Mark Biamonte (Progress): Works for Mark

Ralf Handl (SAP SE): George agrees

Ralf Handl (SAP SE): Decision: next meeting on January 11, 2018

Ralf Handl (SAP SE): 3.Approve minutes from previous meeting(s) [8:10 am PT]

a.Minutes from November 30, 2017 TC meeting: https://www.oasis-open.org/committees/download.php/62132/odata-meeting-197_on-20171130-minutes.html

Ralf Handl (SAP SE): Minutes are approved

Ralf Handl (SAP SE): 4.Review action items [Action item list: https://www.oasis-open.org/apps/org/workgroup/odata/members/action_items.php] [8:15am PT]

a.Action items due

Ralf Handl (SAP SE): i. IANA registration

Ralf Handl (SAP SE): Mark removed SchemaVersion header as it has been replaced with $schemaversion query option

Ralf Handl (SAP SE): 5.Committee Note on OData to OpenAPI Mapping [8:20 am PT]

a.Document Walkthrough

i.https://www.oasis-open.org/committees/download.php/61852/odata-openapi-v1.0-wd02-2017-10-20.docx  starting at 4.6 Field components

Ralf Handl (SAP SE): 4.6: Add remark on more restrictive name pattern in OpenAPI 3.0

Ralf Handl (SAP SE): 4.6.1.1.1: try to avoid anyOf constructs just for special numeric values and Int64

Michael Pizzo: I move that services that don't support storing INF,-INF, or NaN for numbers are allowed to return "number", rather than anyof{number,string} for numeric types, including int64 if IEE754Compatible=true is not specified as a type parameter.

Michael Pizzo: I move that services that don't support storing INF,-INF, or NaN for numbers are allowed to return "number" or "integer" (as appropriate), rather than anyof{number,string} (or anyof{integer,string}) for numeric types, including int64 if IEE754Compatible=true is not specified as a type parameter

Michael Pizzo: I move that services that don't support storing INF,-INF, or NaN for numbers are allowed to return "number" or "integer" (as appropriate), rather than anyof{number,string} (or anyof{integer,string}) for numeric types, including int64 and Decimal if IEE754Compatible=true is not specified as a type parameter

Hubert Heijkers (IBM): I second

Ralf Handl (SAP SE): motion passes

Michael Pizzo: George to open a JIRA issue to add text to the JSON CSDL document clarifying that $schema is allowed in a JSON CSDL document, referencing the json schema published as part of the work product.

Michael Pizzo: (as a non-normative change)

Ralf Handl (SAP SE): 6.Issues [9:20 am PT]

a.Vocabularies: APPLIED

i.ODATA-1064 Add ability to annotate collections to return only count and NextLink

Ralf Handl (SAP SE): b.Vocabularies: NEW or OPEN

i.ODATA-1134 Add KeyAsSegment annotation term to core vocabulary

Ralf Handl (SAP SE): DATA-1134 is OPEN

Ralf Handl (SAP SE): ODATA-1134

Ralf Handl (SAP SE): Proposal is not aligned with summary:

Add a new boolean term to the capabilities vocabulary, SupportsKeyAsSegment:

<Term Name="SupportsKeyAsSegment" Type="Core.Tag" DefaultValue="True" AppliesTo="EntityContainer"/>

Ralf Handl (SAP SE): Use KeyAsSegmentSupported to rhyme with TopSupported and SkipSupported

Ralf Handl (SAP SE): Mike likes it

Michael Pizzo: Updated proposal: Add a new boolean term to the capabilities vocabulary, KeyAsSegmentSupported:

<Term Name="KeyAsSegmentSupported" Type="Core.Tag" DefaultValue="True" AppliesTo="EntityContainer"/>

Mark Biamonte (Progress): I move that OData-1134 be resolved as proposed

George Ericson(Dell): Second: motion to resolve 1134 as proposed.

Ralf Handl (SAP SE): ODATA-1134 is RESOLVED with the amended proposal

Ralf Handl (SAP SE): ii.ODATA-1132 Propagation of NavigationRestrictions

iii.ODATA-1124 Authorization vocabulary: KeyLocation - also allow cookie as value?

iv.ODATA-1121 Extend FilterExpressionRestrictions with "MultiPredicate"

v.ODATA-1067 Consider ability to define computed default values

vi.ODATA-1005 Make sure we have capabilities for all new 4.01 functionality

vii.ODATA-884 Add term ErrorCodes to describe possible codes in error messages (public comment c201510e00019)

Ralf Handl (SAP SE): iii.ODATA-1124 Authorization vocabulary: KeyLocation - also allow cookie as value?

Ralf Handl (SAP SE): ODATA-1124 is OPEN

Ralf Handl (SAP SE): <EnumType Name="KeyLocation">

        <Member Name="Header">

          <Annotation Term="Core.Description" String="API Key is passed in the header" />

        </Member>

        <Member Name="QueryOption">

          <Annotation Term="Core.Description" String="API Key is passed as a query option" />

        </Member>

      </EnumType>

Ralf Handl (SAP SE): OpenAPI 3 also allows "cookie":

instringapiKeyREQUIRED. The location of the API key. Valid values are "query", "header" or "cookie".

Michael Pizzo: Link to the full vocabulary: https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Authorization.V1.xml

Ralf Handl (SAP SE): in | string | apiKey | REQUIRED. | The location of the API key. Valid values are "query", "header" or "cookie".

Michael Pizzo: Description of APIKey:

Michael Pizzo: <ComplexType Name="ApiKey" BaseType="Auth.Authorization">

        <Property Name="KeyName" Type="Edm.String" Nullable="false">

          <Annotation Term="Core.Description" String="The name of the header or query parameter" />

        </Property>

        <Property Name="Location" Type="Auth.KeyLocation" Nullable="false">

          <Annotation Term="Core.Description" String="Whether the API Key is passed in the header or as a query option" />

        </Property>

      </ComplexType>

Michael Pizzo: <Term Name="Authorizations" Type="Collection(Auth.Authorization)" AppliesTo="EntityContainer EntitySet Singleton NavigationProperty Action Function">

        <Annotation Term="Core.Description" String="Lists the methods available to authorize access to the annotated resource" />

      </Term>

Michael Pizzo: I propose we resolve ODATA-1124 by adding "Cookie" as a valid value for KeyLocation.

Hubert Heijkers (IBM): I second

Ralf Handl (SAP SE): George: we should add descriptions and examples to these term definitions

Ralf Handl (SAP SE): ODATA-1124 is RESOLVED as proposed

Ralf Handl (SAP SE): vii.ODATA-884 Add term ErrorCodes to describe possible codes in error messages (public comment c201510e00019)

Ralf Handl (SAP SE): Jeff Wight proposes to add a term that allows describing possible code values in OData error responses, see https://lists.oasis-open.org/archives/odata-comment/201510/msg00019.html

Example:

<Annotation Term="Core.ErrorCodes">

  <Collection>

    <Record>

      <PropertyValue Property="HttpMethod" String="GET" />

      <PropertyValue Property="HttpStatusCode" String="400" />

      <PropertyValue Property="ODataErrorCode" String="QueryFilterFunctionNotSupported" />

      <PropertyValue Property="Description"

        String="This error indicates that a request was made with a filter function that isnt supported on this entity set. Please refer to the Capabilities.FilterFunctions annotation on this entity set for a list of supported functions, and the exact error message for which function usage triggered this error." />

    </Record>

  </Collection>

</Annotation>

Ralf Handl (SAP SE): "@Core.ErrorCodes":[

Ralf Handl (SAP SE): { "method": "get", "HttpStatusCodes": [

Ralf Handl (SAP SE): { "code": "400" , "subcodes":[

Ralf Handl (SAP SE): {<Term Name="ErrorCodes" Type="Collection(Core.ErrorCodeType)" AppliesTo="EntitySet Singleton ActionImport FunctionImport Action Function">

Ralf Handl (SAP SE): https://raw.githubusercontent.com/oasis-tcs/odata-openapi/master/examples/example.openapi3.json

Ralf Handl (SAP SE): "responses": {

"200": {

"description": "Retrieved entities",

"content": {

"application/json": {

"schema": {

"title": "Collection of Product",

"type": "object",

"properties": {

"value": {

"type": "array",

"items": {

"$ref": "#/components/schemas/ODataDemo.Product"

},

"default": {

"$ref": "#/components/responses/error"

Ralf Handl (SAP SE): Hubert: we also need to allow annotating success response codes, e.g. 200 and 201 for actions

Michael Pizzo: Alternate structure:

Ralf Handl (SAP SE): Homework: think about nested structure

Michael Pizzo: alternate structure:

  <Term Name="HttpResponses" Type="Collection(Core.HttpMethodResponse)" AppliesTo="EntitySet Singleton ActionImport FunctionImport Action Function">

    <Annotation Term="Core.Description" String="Describes possible error codes in OData responses" />

    <Annotation Term="Core.LongDescription" String="The list need not be complete. It may be used to generate API documentation, so restricting it to the most common and most important errors may increase readability." />

  </Term>

  <ComplexType Name="HttpMethodResponse">

    <Property Name="Method" Type="Edm.String">

      <Annotation Term="Core.Description" String="Request verb of the HTTP request, e.g. GET, POST, PATCH, DELETE" />

    </Property>

    <Property Name="HttpStatusCodes" Type="Collection(Core.HttpStatusCode)">

      <Annotation Term="Core.Description" String="HTTP status code of the response, e.g. 400, 403, 501" />

    </Property>

  </ComplexType>

  <ComplexType Name="HttpStatusCode">

    <Property Name="Code" Type="Edm.String">

      <Annotation Term="Core.Description" String="HTTP status code of the response, e.g. 400, 403, 501" />

    </Property>

    <Property Name="Responses" Type="Collection(Core.HttpStatusCodeResponse)">

      <Annotation Term="Core.Description" String="HTTP status code of the response, e.g. 400, 403, 501" />

    </Property>

  </ComplexType>

  <ComplexType Name="HttpStatusCodeResponse">

    <Property Name="ODataErrorCode" Type="Edm.String">

      <Annotation Term="Core.Description" String="Language-independent, machine-readable OData error code" />

    </Property>

    <Property Name="Description" Type="Edm.String">

      <Annotation Term="Core.Description" String="Human-readable description of the error situation" />

    </Property>

  </ComplexType>

Ralf Handl (SAP SE): 8.AOB and wrap up [9:55 am PT]

Ralf Handl (SAP SE): George and Mike to prepare proposal for ODATA-1064

Ralf Handl (SAP SE): Meeting is adjourned

Ralf Handl (SAP SE): Happy Holidays!

From: odata@lists.oasis-open.org [mailto:odata@lists.oasis-open.org] On Behalf Of Handl, Ralf
Sent: Montag, 4. Dezember 2017 13:52
To: 'odata@lists.oasis-open.org' <odata@lists.oasis-open.org>
Subject: [odata] Agenda for OData TC meeting on 2017-12-07

Here [1] is a draft agenda for the OData TC (Technical Committee) meeting scheduled on Thursday December 07, 2017 during 8-10 am PST (17:00-19:00 CET). 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]