NEW PREFERENCE - allow-entityreferences, callback, continue-on-error, include-annotations, maxpagesize, omit-values, and track-changes
Chet Ensign <chet.ensign@oasis-open.org> Wed, 18 September 2019 20:15 UTC
Return-Path: <ietf-http-wg-request+bounce-httpbisa-archive-bis2juki=lists.ie@listhub.w3.org>
X-Original-To: ietfarch-httpbisa-archive-bis2Juki@ietfa.amsl.com
Delivered-To: ietfarch-httpbisa-archive-bis2Juki@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id EE68D120858 for <ietfarch-httpbisa-archive-bis2Juki@ietfa.amsl.com>; Wed, 18 Sep 2019 13:15:32 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.898
X-Spam-Level:
X-Spam-Status: No, score=-2.898 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, HEADER_FROM_DIFFERENT_DOMAINS=0.001, HTML_MESSAGE=0.001, MAILING_LIST_MULTI=-1, 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 OcwqkzFbA1wQ for <ietfarch-httpbisa-archive-bis2Juki@ietfa.amsl.com>; Wed, 18 Sep 2019 13:15:30 -0700 (PDT)
Received: from frink.w3.org (frink.w3.org [IPv6:2603:400a:ffff:804:801e:34:0:38]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 08EB4120863 for <httpbisa-archive-bis2Juki@lists.ietf.org>; Wed, 18 Sep 2019 13:15:29 -0700 (PDT)
Received: from lists by frink.w3.org with local (Exim 4.89) (envelope-from <ietf-http-wg-request@listhub.w3.org>) id 1iAgJo-0006Hd-3L for ietf-http-wg-dist@listhub.w3.org; Wed, 18 Sep 2019 20:12:52 +0000
Resent-Date: Wed, 18 Sep 2019 20:12:52 +0000
Resent-Message-Id: <E1iAgJo-0006Hd-3L@frink.w3.org>
Received: from mimas.w3.org ([2603:400a:ffff:804:801e:34:0:4f]) by frink.w3.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from <chet.ensign@oasis-open.org>) id 1iAgJk-0006Gm-28 for ietf-http-wg@listhub.w3.org; Wed, 18 Sep 2019 20:12:48 +0000
Received: from mail-ed1-x531.google.com ([2a00:1450:4864:20::531]) by mimas.w3.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.89) (envelope-from <chet.ensign@oasis-open.org>) id 1iAgJi-0001Yj-3c for ietf-http-wg@w3.org; Wed, 18 Sep 2019 20:12:47 +0000
Received: by mail-ed1-x531.google.com with SMTP id f20so1099736edv.8 for <ietf-http-wg@w3.org>; Wed, 18 Sep 2019 13:12:25 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oasis-open-org.20150623.gappssmtp.com; s=20150623; h=mime-version:from:date:message-id:subject:to:cc; bh=8yovkwyPVDsrYC9pe6+axQPpy3cyS10LkD0aF6G9Yzo=; b=KaNDcF6s9MZMNrXw1Ts3v5X9/qTziZXQCvUdX2XQYJxL7vIjZQ5xQEt3tkwgC1tAQ9 CoYb1p54tpGg7a+k6Pn+UQPkiUDt3ExcCZtf263bKN+78Dxax74j8rZYS2gWL/qvsiCo eZ8PJYLLkaNSyJgFk01BCftAoUzMmSPZITY1/D+mTNYbjXXQzlo5p0I4H74gZGncG0lZ n6rKnSkSWn1rOBM/mKeO0ZexgY8ecW2bw4oePIsaYixG06qdD0tEY2OBd1gGbqUgfp6d FGWqRbiT2B6eZ67Jo7Glj1VfMtVgNv0O/0jyojkRd4mYYlsMxoIkdFC6M3PBimG0ZTXB vePg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:from:date:message-id:subject:to:cc; bh=8yovkwyPVDsrYC9pe6+axQPpy3cyS10LkD0aF6G9Yzo=; b=aBqbnNhc2nt0RhNq20BYFTf5V0wISyujZN2/QTXetGFeDZO9+Kyl87qu+y22DTSY9z 1xV9Mz+boQmT3fsasPLJwEbnbD0EQrQ51Js1RedEn3JF55BqdWirMYGHsuNuvc9HC/hJ XigOtLg9vedqDlbplpb+IYlmu04l8EyAfZYxPngSXZXf9VpBstt2JjcEi7+CWhHPcbBn jdHwhIPnoVsFgGr0dsmb+mPdks5X39Zs5C9FQi2rF/9tdSwhtUvEwdfo1l5nXx2GoChF GsarpxawN9XXB8zCYeZJSoGL7aQlR/CsrCxC8hUkOmUx+225GjuaNZyjTL9BXD7IaohE z/kw==
X-Gm-Message-State: APjAAAWkJt+PKWDg2TDBIv2Jna2Drni/GPIs70Tif0+bKgyMGlYD64XX o+F5MzmnjjAnudN4fERHBXbh3EvQF/47vMXLbqt5fNpjsg==
X-Google-Smtp-Source: APXvYqwEwkv//ZkkI0lDBIs2h0QsICnoT+R2oGtUWD+Eq1st4pNoqBDnOND9JGMh0f9088piCLd8Pgf4buK+pBxoUYo=
X-Received: by 2002:a50:935d:: with SMTP id n29mr12306290eda.294.1568837543758; Wed, 18 Sep 2019 13:12:23 -0700 (PDT)
MIME-Version: 1.0
From: Chet Ensign <chet.ensign@oasis-open.org>
Date: Wed, 18 Sep 2019 16:12:12 -0400
Message-ID: <CAAwgnnPpDFLo6z+ZD9bZ_cC+H=cxkJzgnF2s1d4EMTrO=xoQNQ@mail.gmail.com>
To: "ietf-http-wg@w3.org Group" <ietf-http-wg@w3.org>
Cc: "Mark Biamonte (Progress)" <Mark.Biamonte@progress.com>, "Ralf Handl (SAP)" <ralf.handl@sap.com>
Content-Type: multipart/alternative; boundary="00000000000081a0630592d974e0"
Received-SPF: pass client-ip=2a00:1450:4864:20::531; envelope-from=chet.ensign@oasis-open.org; helo=mail-ed1-x531.google.com
X-W3C-Hub-Spam-Status: No, score=-3.1
X-W3C-Hub-Spam-Report: AWL=1.833, 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, W3C_AA=-1, W3C_IRA=-1, W3C_WL=-1
X-W3C-Scan-Sig: mimas.w3.org 1iAgJi-0001Yj-3c c81df2592b020f05af68ce44227e1718
X-Original-To: ietf-http-wg@w3.org
Subject: NEW PREFERENCE - allow-entityreferences, callback, continue-on-error, include-annotations, maxpagesize, omit-values, and track-changes
Archived-At: <https://www.w3.org/mid/CAAwgnnPpDFLo6z+ZD9bZ_cC+H=cxkJzgnF2s1d4EMTrO=xoQNQ@mail.gmail.com>
Resent-From: ietf-http-wg@w3.org
X-Mailing-List: <ietf-http-wg@w3.org> archive/latest/37022
X-Loop: ietf-http-wg@w3.org
Resent-Sender: ietf-http-wg-request@w3.org
Precedence: list
List-Id: <ietf-http-wg.w3.org>
List-Help: <https://www.w3.org/Mail/>
List-Post: <mailto:ietf-http-wg@w3.org>
List-Unsubscribe: <mailto:ietf-http-wg-request@w3.org?subject=unsubscribe>
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. 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 standards for the information society http://www.oasis-open.org Mobile: +1 201-341-1393