OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

odata message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Fwd: [IANA #1159807] Re: NEW PREFERENCE - allow-entityreferences, callback, continue-on-error, include-annotations, maxpagesize, omit-values, and track-changes



Members of the OData TC,Â

Please see the message below from Amanda Baber at IANA. Your request to add new preferences to the HTTP Preferences registry has been completed. The entries are now listed.Â

This completes all the tasks associated with your registration requests for the new header preferences and permanent header field registrations. I have tracked this work inÂhttps://issues.oasis-open.org/browse/TCADMIN-3209Âand will now close that ticket.Â

Congrats & as always, please let me know if you have any questions.Â

Best,Â

/chetÂ


---------- Forwarded message ---------
From: Amanda Baber via RT <iana-prot-param@iana.org>
Date: Wed, Jan 22, 2020 at 7:34 PM
Subject: [IANA #1159807] Re: NEW PREFERENCE - allow-entityreferences, callback, continue-on-error, include-annotations, maxpagesize, omit-values, and track-changes
To: <chet.ensign@oasis-open.org>
Cc: <ralf.handl@sap.com>, <mark.biamonte@progress.com>


Hi Chet,

We've added the following entries to the HTTP Preferences registry:

Preference: odata.allow-entityreferences
Description: Indicates that the service is allowed to return references in place of resources that have previously been returned, with at least the properties requested, in the same response.
Reference: [OData Version 4.01 Part 1: Protocol]
http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_Preferenceallowentityreferencesodata

Preference: odata.callback
Description: Requests that the service invoke the specified URL to signal some service state, such as the completion of an asynchronous result or availability of new or modified information. The service state that triggers the change is dependent upon the request.
Reference: [OData Version 4.01 Part 1: Protocol]
http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_Preferencecallbackodatacallback

Preference: odata.continue-on-error  Â
Description: Requests that the service attempt to continue processing a request that encounters non-fatal errors, for example in a multi-part request. The response SHOULD indicate what portions of the request were and were not able to be successfully handled.
Reference: [OData Version 4.01 Part 1: Protocol]
http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_Preferencecontinueonerrorodatacontin

Preference: odata.include-annotations
Value: Comma-separated list of terms to include or, when prefixed with a minus sign (-), exclude from the response. Terms MUST be namespace-qualified and MAY specify just a namespace to include or exclude all terms within that namespace. The special value "*" matches all annotations.
Description: Specifies the set of annotations the client requests to be included, where applicable, or excluded in the response.   Â
Reference: [OData Version 4.01 Part 1: Protocol]
http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_Preferenceincludeannotationsodatainc

Preference: odata.maxpagesize
Value: A positive integer that represents the maximum number of items each collection in a response SHOULD contain.  Â
Description: Requests that each collection within the response contain no more than the number of items specified as the positive integer value of this preference.  Â
Reference: [OData Version 4.01 Part 1: Protocol]
http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_Preferencemaxpagesizeodatamaxpagesiz

Preference: omit-values
Value: One of nulls - properties containing null values may be omitted from the response defaults - properties containing the property default value may be omitted from the response.
Description: Specifies whether a server can omit properties with a null value or properties set to their default value from a response.
Reference: [OData Version 4.01 Part 1: Protocol]
http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_Preferenceomitvalues

Preference: odata.track-changes
Description: Requests that the service initiate change tracking on the result of this request, according to the underlying protocol. Â
Reference: [OData Version 4.01 Part 1: Protocol]
http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_Preferencetrackchangesodatatrackchan

Please see
https://www.iana.org/assignments/http-parameters

Best regards,

Amanda Baber
Lead IANA Services Specialist

On Wed Jan 08 17:52:53 2020, chet.ensign@oasis-open.org wrote:
> Happy New Year again Amanda!
>
> Following up on this request as well. I sent this request to ietf-
> http-wg@
> on 18 Sep 2019 (
> https://lists.w3.org/Archives/Public/ietf-http-
> wg/2019JulSep/0285.html). I
> have just checked and there were no responses to it.
>
> Should I take any follow up action here?
>
> Thanks very much,
>
> /chet
>
> On Wed, Sep 18, 2019 at 3:15 PM Amanda Baber via RT <
> iana-prot-param@iana.org> wrote:
>
> > Hi Chet,
> >
> > You don't need to do anything about the message header [RFC3864]
> > requests
> > at the moment. We'll contact you about those when we hear back from
> > the
> > reviewer.
> >
> > We'll close this request to add entries to the HTTP Preferences
> > registry
> > (see
> > https://www.iana.org/assignments/http-parameters/http-
> > parameters.xhtml#preferences),
> > as we should expect to hear from a reviewer within two weeks of your
> > message to ietf-http-wg@w3.org. If, after you write to ietf-http-
> > wg@w3.org,
> > two weeks pass without a response from either of the HTTP Preferences
> > reviewers, let us know.
> >
> > Best regards,
> >
> > Amanda Baber
> > Lead IANA Services Specialist
> >
> > On Wed Sep 18 14:40:07 2019, chet.ensign@oasis-open.org wrote:
> > > Amanda, my apologies. I was following RFC 3864 - Registration
> > > Procedures
> > > for Message Header Fields, section 4.3 -
> > > https://tools.ietf.org/html/rfc3864#page-10 and sent the proposals
> > > to
> > > ietf-message-headers@lists.ietf.org. As noted, the Technical
> > > Committee
> > > did
> > > receive comments and revised the specification in line with the
> > > feedback.
> > > We did not receive feedback to the second communication.
> > >
> > > I see from your next message that you sent that request to the
> > > IESG-
> > > designated
> > > expert for review. Do you need me to do anything with this one?
> > >
> > > Again, my apologies. I will read RFC 7240 today and familiarize
> > > myself
> > > with
> > > the process there.
> > >
> > > Thanks for your help,
> > >
> > > /chet
> > >
> > > On Tue, Sep 17, 2019 at 7:04 PM Amanda Baber via RT <
> > > iana-prot-param@iana.org> wrote:
> > >
> > > > Hi Chet,
> > > >
> > > > According to RFC 7240, registration requests should be sent to
> > > > the <
> > > > ietf-http-wg@w3.org> mailing list. After two weeks, the
> > > > Designated
> > > > Expert(s) will either approve or deny the registration request,
> > > > communicating this decision to the review list and IANA.
> > > >
> > > > Have more than two weeks passed without a response from either of
> > > > the
> > > > designated experts?
> > > >
> > > > Best regards,
> > > >
> > > > Amanda Baber
> > > > Lead IANA Services Specialist
> > > >
> > > > On Tue Sep 17 22:18:48 2019, chet.ensign@oasis-open.org wrote:
> > > > > This email contains the information needed for Registration of
> > > > > the
> > > > > OData
> > > > > specific Prefer Header Preferences with IANA as called out in
> > > > > RFC
> > > > > 7240
> > > > > -
> > > > > Prefer Header for HTTP.
> > > > >
> > > > > This request was previous reviewed and discussed on
> > > > > ietf-message-headers@ietf.org in
> > > > > https://lists.w3.org/Archives/Public/ietf-http-
> > > > > wg/2018JulSep/0277.html,
> > > > > https://mailarchive.ietf.org/arch/msg/ietf-message-
> > > > > headers/2t0qiJMArcdXC2a9kWydXOtlppE,
> > > > > and
> > > > > https://mailarchive.ietf.org/arch/msg/ietf-message-
> > > > > headers/z6q9gb1gqHxuxNWTL6AoXBwi7zE
> > > > >
> > > > > ---
> > > > >
> > > > > Open Data (OData) Protocol IANA Prefer Header Preference
> > > > > registration
> > > > > request
> > > > >
> > > > > --------------------------------------------------------------
> > > > >
> > > > > This documentation contains the information needed for
> > > > > Registration
> > > > > of
> > > > > the
> > > > > OData specific Prefer Header Preferences with IANA as called
> > > > > out in
> > > > > RFC
> > > > > 7240 - Prefer Header for HTTP.
> > > > >
> > > > > The OData Prefer Header Preferences to be registered are
> > > > >
> > > > > odata.allow-entityreferences
> > > > > odata.callback
> > > > > odata.continue-on-error
> > > > > odata.include-annotations
> > > > > odata.maxpagesize
> > > > > omit-values
> > > > > odata.track-changes
> > > > >
> > > > > The details as required by RFC 7240 for registering these
> > > > > preferences
> > > > > are
> > > > > listed below
> > > > >
> > > > > ####
> > > > > Preference:
> > > > >
> > > > > odata.allow-entityreferences
> > > > >
> > > > > Value:
> > > > >
> > > > > <none>
> > > > >
> > > > > Optional Parameters:
> > > > >
> > > > > <none>
> > > > >
> > > > > Description:
> > > > >
> > > > > Indicates that the service is allowed to return references in
> > > > > place
> > > > > of
> > > > > resources that have previously been returned, with at least the
> > > > > properties
> > > > > requested, in the same response.
> > > > >
> > > > > Reference:
> > > > >
> > > > > OData Version 4.01 Part 1: Protocol â
> > > > > http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-
> > > > > protocol.html#sec_Preferenceallowentityreferencesodata
> > > > >
> > > > > Notes: [optional]
> > > > >
> > > > > <None>
> > > > >
> > > > >
> > > > > ####
> > > > >
> > > > > Preference:
> > > > >
> > > > > odata.callback
> > > > >
> > > > > Value:
> > > > >
> > > > > <none>
> > > > >
> > > > > Optional Parameters:
> > > > >
> > > > > url - The URL of a callback endpoint to be invoked by the
> > > > > service
> > > > > when
> > > > > data
> > > > > is available. The URL parameter is required
> > > > >
> > > > > Description:
> > > > >
> > > > > Requests that the service invoke the specified URL to signal
> > > > > some
> > > > > service
> > > > > state, such as the completion of an asynchronous result or
> > > > > availability of
> > > > > new or modified information. The service state that triggers
> > > > > the
> > > > > change is
> > > > > dependent upon the request
> > > > >
> > > > > Reference:
> > > > >
> > > > > OData Version 4.01 Part 1: Protocol â
> > > > > http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-
> > > > > protocol.html#sec_Preferencecallbackodatacallback
> > > > >
> > > > >
> > > > > Notes: [optional]
> > > > >
> > > > > <None>
> > > > >
> > > > >
> > > > > ####
> > > > >
> > > > > Preference:
> > > > >
> > > > > odata.continue-on-error
> > > > >
> > > > > Value:
> > > > >
> > > > > <none>
> > > > >
> > > > > Optional Parameters:
> > > > >
> > > > > <none>
> > > > >
> > > > > Description:
> > > > >
> > > > > Requests that the service attempt to continue processing a
> > > > > request
> > > > > that
> > > > > encounters non-fatal errors, for example in a multi-part
> > > > > request.
> > > > > The
> > > > > response SHOULD indicate what portions of the request were and
> > > > > were
> > > > > not
> > > > > able to be successfully handled.
> > > > >
> > > > > Reference:
> > > > >
> > > > > OData Version 4.01 Part 1: Protocol â
> > > > > http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-
> > > > > protocol.html#sec_Preferencecontinueonerrorodatacontin
> > > > >
> > > > > Notes: [optional]
> > > > >
> > > > > <None>
> > > > >
> > > > >
> > > > > ####
> > > > >
> > > > > Preference:
> > > > >
> > > > > odata.include-annotations
> > > > >
> > > > > Value:
> > > > >
> > > > > Comma-separated list of terms to include or, when prefixed with
> > > > > a
> > > > > minus
> > > > > sign (-), exclude from the response. Terms MUST be namespace-
> > > > > qualified
> > > > > and
> > > > > MAY specify just a namespace to include or exclude all terms
> > > > > within
> > > > > that
> > > > > namespace. The special value "*" matches all annotations.
> > > > >
> > > > > Optional Parameters:
> > > > >
> > > > > <none>
> > > > >
> > > > > Description:
> > > > >
> > > > > Specifies the set of annotations the client requests to be
> > > > > included,
> > > > > where
> > > > > applicable, or excluded in the response.
> > > > >
> > > > > Reference:
> > > > >
> > > > > OData Version 4.01 Part 1: Protocol â
> > > > > http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-
> > > > > protocol.html#sec_Preferenceincludeannotationsodatainc
> > > > >
> > > > > Notes: [optional]
> > > > >
> > > > > <None>
> > > > >
> > > > >
> > > > > ####
> > > > > Preference:
> > > > >
> > > > > odata.maxpagesize
> > > > >
> > > > > Value:
> > > > >
> > > > > a positive integer that represents the maximum number of items
> > > > > each
> > > > > collection in a response SHOULD contain
> > > > >
> > > > > Optional Parameters:
> > > > >
> > > > > <none>
> > > > >
> > > > > Description:
> > > > >
> > > > > Requests that each collection within the response contain no
> > > > > more
> > > > > than
> > > > > the
> > > > > number of items specified as the positive integer value of this
> > > > > preference.
> > > > >
> > > > > Reference:
> > > > >
> > > > > OData Version 4.01 Part 1: Protocol â
> > > > > http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-
> > > > > protocol.html#sec_Preferencemaxpagesizeodatamaxpagesiz
> > > > >
> > > > > Notes: [optional]
> > > > >
> > > > > <None>
> > > > >
> > > > >
> > > > > ####
> > > > >
> > > > > Preference:
> > > > >
> > > > > omit-values
> > > > >
> > > > > Value:
> > > > >
> > > > > One of
> > > > >Â Â nulls -Â properties containing null values may be omitted
> > > > > from
> > > > > the
> > > > > response
> > > > >Â Â defaults - properties containing the property default value
> > > > > may
> > > > > be
> > > > > omitted from the response
> > > > >
> > > > > Optional Parameters:
> > > > >
> > > > > <none>
> > > > >
> > > > > Description:
> > > > >
> > > > > Specifies whether a server can omit properties with a null
> > > > > value or
> > > > > properties set to their default value from a response
> > > > >
> > > > > Reference:
> > > > >
> > > > > OData Version 4.01 Part 1: Protocol â
> > > > > http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-
> > > > > protocol.html#sec_Preferenceomitvalues
> > > > >
> > > > > Notes: [optional]
> > > > >
> > > > > <none>
> > > > >
> > > > > ####
> > > > >
> > > > > Preference:
> > > > >
> > > > > odata.track-changes
> > > > >
> > > > > Value:
> > > > >
> > > > > <none>
> > > > >
> > > > > Optional Parameters:
> > > > >
> > > > > <none>
> > > > >
> > > > > Description:
> > > > >
> > > > > Requests that the service initiate change tracking on the
> > > > > result of
> > > > > this
> > > > > request, according to the underlying protocol.
> > > > >
> > > > > Reference:
> > > > >
> > > > > OData Version 4.01 Part 1: Protocol â
> > > > > http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-
> > > > > protocol.html#sec_Preferencetrackchangesodatatrackchan
> > > > >
> > > > > Notes: [optional]
> > > > >
> > > > > <none>
> > > >
> > > >
> >
> >



--

/chetÂ
----------------
Chet Ensign
Chief Technical Community Steward
OASIS: Advancing open source & open standards for the information society
http://www.oasis-open.org

Mobile: +1 201-341-1393Â


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]