Re: [Ietf-message-headers] Update to NEW PREFERENCE - allow-entityreferences, callback, continue-on-error, include-annotations, maxpagesize, omit-values, and track-changes
Chet Ensign <chet.ensign@oasis-open.org> Tue, 10 September 2019 20:33 UTC
Return-Path: <chet.ensign@oasis-open.org>
X-Original-To: ietf-message-headers@ietfa.amsl.com
Delivered-To: ietf-message-headers@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 5D6E212008C for <ietf-message-headers@ietfa.amsl.com>; Tue, 10 Sep 2019 13:33:00 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.898
X-Spam-Level:
X-Spam-Status: No, score=-1.898 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=oasis-open-org.20150623.gappssmtp.com
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id AsuzwTAStLud for <ietf-message-headers@ietfa.amsl.com>; Tue, 10 Sep 2019 13:32:57 -0700 (PDT)
Received: from mail-ed1-x532.google.com (mail-ed1-x532.google.com [IPv6:2a00:1450:4864:20::532]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 18E4D120806 for <ietf-message-headers@ietf.org>; Tue, 10 Sep 2019 13:32:56 -0700 (PDT)
Received: by mail-ed1-x532.google.com with SMTP id c20so9496401eds.1 for <ietf-message-headers@ietf.org>; Tue, 10 Sep 2019 13:32:55 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oasis-open-org.20150623.gappssmtp.com; s=20150623; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=R/3d0rBRVJZOksvsdLwgatsNfvnXRVojHRs28g7t1Go=; b=Xvrs09NsiT/aYKpiThKks1cqkLPofNIOeqJeQgP1epthtz9GH82KuyQUJRqEmRJs1I WXMi+5mZJphh4yyUJc/RPsZij3lqubK09uhKpaLVF9eKGXxvm9pormbmj/4K9Fn7HA2D klHtTbkSkDRnNCy83eqIT1iiAHJEqSR2dWeUlCNNivvS9uvOQx78HPv7Jy4qQcz5Ugq4 EhOTcVcpD7tLhREOT6fDh54kngA9+OPUnRaJUDOyMZcE5I6/BbSBLbBZH7mHcPwh8wPU 75oUhbmGEhmkd8Cu6NolWPqhc24AGAVVnyvrr62053wYMvWV5/C2DZm4IOMsJ14k3mJZ RSHg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=R/3d0rBRVJZOksvsdLwgatsNfvnXRVojHRs28g7t1Go=; b=gkhO9ksKYitVwgVV76croMyMLZt9TistyDLbHl8Vq5/SuZPl+bobGzWP7iE+ZUJhzN 99VY/3a7p8fAYkFzZH61DHBw4Znr/5uIMooA0Bsd5zv5vt06pnlJyNYeklK52wSItzD+ +QuTlixyrbxgczVzBExzrtwY7c5sCNqosAjpOQDTAvUzp1J5c30j9j3aKSHaFv9Q+r7U Ug3F47DMcR/yPXQoDrQu0OPigJfeaJSrK7o+csC/c8PD49wU4bp9+eDDhyZSIIp1Jqt9 0LMNpVw3zsJg6ZYCMUPsTN3evfnoq+luE06XHqo5mI3C+b27jYXsPuhrYAnmpPFPUt9h fcsg==
X-Gm-Message-State: APjAAAU4Xkba41yNsD0HX9Cd0vO52v2urPjkr/Od+N1PTIhUgSR9j/pH xr/bpTuIcro/7rq/xc1k0wvIENxP6BlOeIz3I1db2mv9Lg==
X-Google-Smtp-Source: APXvYqxtJtxmMEhPtL1aygxSMWRuF329EkED/IMewsnp+hXwxv7XXDhinEfukrkBgrJic4vIJZ/M2VYRWoWVLEaL+64=
X-Received: by 2002:aa7:d2ca:: with SMTP id k10mr6029757edr.241.1568147574405; Tue, 10 Sep 2019 13:32:54 -0700 (PDT)
MIME-Version: 1.0
References: <CAAwgnnNAH60xetu0h0Z15VipGgVNd7BZz0xBUsXdDW55TkLTOg@mail.gmail.com>
In-Reply-To: <CAAwgnnNAH60xetu0h0Z15VipGgVNd7BZz0xBUsXdDW55TkLTOg@mail.gmail.com>
From: Chet Ensign <chet.ensign@oasis-open.org>
Date: Tue, 10 Sep 2019 16:32:43 -0400
Message-ID: <CAAwgnnMjSOQWbi6TDJLvnpk-ZDLvBS4MufOKz2SHaFX4a6fn=w@mail.gmail.com>
To: ietf-message-headers@ietf.org
Cc: "Mark Biamonte (Progress)" <Mark.Biamonte@progress.com>, "Ralf Handl (SAP)" <ralf.handl@sap.com>
Content-Type: multipart/alternative; boundary="00000000000020ce88059238cf24"
Archived-At: <https://mailarchive.ietf.org/arch/msg/ietf-message-headers/z6q9gb1gqHxuxNWTL6AoXBwi7zE>
Subject: Re: [Ietf-message-headers] Update to NEW PREFERENCE - allow-entityreferences, callback, continue-on-error, include-annotations, maxpagesize, omit-values, and track-changes
X-BeenThere: ietf-message-headers@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Discussion list for header fields used in Internet messaging applications." <ietf-message-headers.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/ietf-message-headers>, <mailto:ietf-message-headers-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/ietf-message-headers/>
List-Post: <mailto:ietf-message-headers@ietf.org>
List-Help: <mailto:ietf-message-headers-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/ietf-message-headers>, <mailto:ietf-message-headers-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 10 Sep 2019 20:33:00 -0000
Many thanks to all who reviewed the notice for message headers whose most recent post of August 23, 2019 is linked below [1]. We have not heard further comment resulting from the community review, so we plan to formally make the registration request to IANA in one week (2019-09-17). Please let us know if there are any other steps we should take. [1] subject: Update to NEW PREFERENCE - allow-entityreferences, callback, continue-on-error, include-annotations, maxpagesize, omit-values, and track-changes https://mailarchive.ietf.org/arch/msg/ietf-message-headers/2t0qiJMArcdXC2a9kWydXOtlppE On Fri, Aug 23, 2019 at 6:00 PM Chet Ensign <chet.ensign@oasis-open.org> wrote: > This message contains an update to the registration request submitted on > 29 August 2018 in > https://lists.w3.org/Archives/Public/ietf-http-wg/2018JulSep/0277.html > > In response to the feedback received (summed up nicely in > https://lists.w3.org/Archives/Public/ietf-http-wg/2018OctDec/0279.html), > the OData Technical Committee updated the registration documents to include > the OData prefix in the Header and Preference names as suggested. > > Below, please find the revised request. I have included the prior values > in [ ]s so that all the changes are visible. > > --- > > Open Data (OData) Protocol IANA Prefer Header Preference registration > request > 22-Jul-2019 > > ------------------------------------------------------------------------------ > > 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 [was allow-entityreferences and etc.] > [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 [was 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> > [was "The allow-entityreferences preference was named > odata.allow-entityreferences in OData version 4.0."] > > #### > Preference: > [odata.]callback [was 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> > [was The callback preference was named odata.callback in OData version > 4.0.] > > #### > Preference: > [odata.]continue-on-error [was 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> > [was The continue-on-error preference was named odata.continue-on-error in > OData version 4.0.] > > #### > Preference: > [odata.]include-annotations [was 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> > [was The include-annotations preference was named > odata.include-annotations in OData version 4.0.] > > #### > Preference: > [odata.]maxpagesize [was 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> > [was The maxpagesize preference was named odata.maxpagesize in OData > version 4.0.] > > #### > Preference: > omit-values [was 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 [was 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> > [was The track-changes preference was named odata.track-changes in OData > version 4.0.] > > -- > > /chet > ---------------- > Chet Ensign > Chief Technical Community Steward > OASIS: Advancing open standards for the information society > http://www.oasis-open.org > > Mobile: +1 201-341-1393 > -- /chet ---------------- Chet Ensign Chief Technical Community Steward OASIS: Advancing open standards for the information society http://www.oasis-open.org Mobile: +1 201-341-1393
- [Ietf-message-headers] Update to NEW PREFERENCE -… Chet Ensign
- Re: [Ietf-message-headers] Update to NEW PREFEREN… Chet Ensign