IETF Logo Mail Archive

Re: [CDNi] CDNI JSON object description notations

"Murray, Rob (Nokia - GB/Cambridge)" <rob.murray@nokia.com> Wed, 02 May 2018 14:11 UTC

Return-Path: <rob.murray@nokia.com>
X-Original-To: cdni@ietfa.amsl.com
Delivered-To: cdni@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id A74E412706D for <cdni@ietfa.amsl.com>; Wed, 2 May 2018 07:11:06 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.91
X-Spam-Level:
X-Spam-Status: No, score=-1.91 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_PASS=-0.001, T_DKIMWL_WL_HIGH=-0.01] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=nokia.onmicrosoft.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 XI4tWVlmn7b4 for <cdni@ietfa.amsl.com>; Wed, 2 May 2018 07:10:59 -0700 (PDT)
Received: from EUR03-AM5-obe.outbound.protection.outlook.com (mail-eopbgr30117.outbound.protection.outlook.com [40.107.3.117]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 28F1F126D85 for <cdni@ietf.org>; Wed, 2 May 2018 07:10:59 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nokia.onmicrosoft.com; s=selector1-nokia-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=FsSK48r20k5wOGBPjlepSK1QE3Wi5pLBZ/3OWYfPhE0=; b=pOWlpzYu6s1Szaoo5ZevZ8uXKMNCa3eBWhSn2CXAmkjtrfGj2z+pLgPsnoGRYI7urwx2XalJ+pbKQaIJ4jl25NFThXuC0YniE6318xvc/LdwOLeYQhDOdip2+i5dgKCsU2H8RXjM+cAK59t+UvhW6Cw6rifvX15SRtL7oO2XJ7w=
Received: from DB5PR07MB1590.eurprd07.prod.outlook.com (10.165.212.144) by DB5PR07MB0984.eurprd07.prod.outlook.com (10.161.200.154) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.735.6; Wed, 2 May 2018 14:10:55 +0000
Received: from DB5PR07MB1590.eurprd07.prod.outlook.com ([fe80::a0cc:c2e5:64b2:38d2]) by DB5PR07MB1590.eurprd07.prod.outlook.com ([fe80::a0cc:c2e5:64b2:38d2%5]) with mapi id 15.20.0735.006; Wed, 2 May 2018 14:10:55 +0000
From: "Murray, Rob (Nokia - GB/Cambridge)" <rob.murray@nokia.com>
To: Ori Finkelman <orif@qwilt.com>, "<cdni@ietf.org>" <cdni@ietf.org>
Thread-Topic: [CDNi] CDNI JSON object description notations
Thread-Index: AQHT4hP/Zzcux0dwgEe+D03nMQMMyKQci18A
Date: Wed, 02 May 2018 14:10:55 +0000
Message-ID: <AE177EA9-9F51-4420-95FA-4F9E859D7DEE@nokia.com>
References: <CAMb9nTsuq3hn6Cv6JcifOOt6giqswDmf7qiewLAJ9feSrzjb3A@mail.gmail.com>
In-Reply-To: <CAMb9nTsuq3hn6Cv6JcifOOt6giqswDmf7qiewLAJ9feSrzjb3A@mail.gmail.com>
Accept-Language: en-GB, en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
user-agent: Microsoft-MacOutlook/10.c.0.180410
x-originating-ip: [81.134.152.3]
x-ms-publictraffictype: Email
x-microsoft-exchange-diagnostics: 1; DB5PR07MB0984; 7:x39b5+utn73VLjAKFWBnhNSOHucEMLRIB0D0g5J2OjnOt2AhjS7Hy2S8vNtT/kp/BVSIzZp2So9Uj0YerwJQjBUwmvIQuTUBdts/sp0JQ8Sj1vjMU24gPAuxcegwLRdS07qqpwUqSTwsfrz1zcc31h2cumr6RClVA3T1JL8KnhtGtuJPzEnc2LoNCKXXaffsI9LnzpgDqoSTQ0i5JlBbaDHdP3AXJMhgLICcGVbz+AZqnUXuRuhwzfuT6e1U0VVZ
x-ms-exchange-antispam-srfa-diagnostics: SOS;
x-ms-office365-filtering-ht: Tenant
x-microsoft-antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652020)(8989080)(48565401081)(5600026)(4534165)(4627221)(201703031133081)(201702281549075)(8990040)(2017052603328)(7193020); SRVR:DB5PR07MB0984;
x-ms-traffictypediagnostic: DB5PR07MB0984:
authentication-results: spf=none (sender IP is ) smtp.mailfrom=rob.murray@nokia.com;
x-microsoft-antispam-prvs: <DB5PR07MB0984192FE0E12C64C44EE52686800@DB5PR07MB0984.eurprd07.prod.outlook.com>
x-exchange-antispam-report-test: UriScan:(28532068793085)(788757137089)(21748063052155);
x-exchange-antispam-report-cfa-test: BCL:0; PCL:0; RULEID:(6040522)(2401047)(8121501046)(5005006)(93006095)(93001095)(3231254)(11241501184)(806099)(944501410)(52105095)(10201501046)(3002001)(6055026)(6041310)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123560045)(20161123562045)(20161123564045)(20161123558120)(6072148)(201708071742011); SRVR:DB5PR07MB0984; BCL:0; PCL:0; RULEID:; SRVR:DB5PR07MB0984;
x-forefront-prvs: 06607E485E
x-forefront-antispam-report: SFV:NSPM; SFS:(10019020)(39380400002)(396003)(376002)(346002)(366004)(39860400002)(50944005)(199004)(189003)(82746002)(6246003)(606006)(58126008)(478600001)(2900100001)(6116002)(3846002)(53936002)(5660300001)(3660700001)(33656002)(76176011)(97736004)(8936002)(3280700002)(6486002)(966005)(110136005)(486006)(66066001)(6436002)(102836004)(186003)(106356001)(86362001)(68736007)(105586002)(6306002)(83716003)(54896002)(99286004)(6512007)(8676002)(26005)(2616005)(476003)(11346002)(81156014)(81166006)(2906002)(5250100002)(25786009)(36756003)(6506007)(53546011)(236005)(229853002)(59450400001)(14454004)(446003)(7736002)(316002)(491001)(217873001); DIR:OUT; SFP:1102; SCL:1; SRVR:DB5PR07MB0984; H:DB5PR07MB1590.eurprd07.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1;
received-spf: None (protection.outlook.com: nokia.com does not designate permitted sender hosts)
x-microsoft-antispam-message-info: v7jF+8F/Fh/C26FdEoApjYZNEBXNOfU3RD8Fg2JipcT4UV3/g1lWrLUS6hQFMlBkMKqsmgwRNTy8RIkBjGumbsDK0keUQTaHnqn44nbOT6Bp2GPCv7pSMEZv6JyPHBt/FtIUeb/7LicmioOwsD4WhiU2XoGJeVHd1d4suLtrNZf5B8jHFLFsEb/jLSlbTHrUaZDniatZA4JcaN/qD6QJA7XXD7nfmi2kOAboyI/uzUA=
spamdiagnosticoutput: 1:99
spamdiagnosticmetadata: NSPM
Content-Type: multipart/alternative; boundary="_000_AE177EA99F51442095FA4F9E859D7DEEnokiacom_"
MIME-Version: 1.0
X-MS-Office365-Filtering-Correlation-Id: 3801c5c2-4eb8-4af3-df48-08d5b0368552
X-OriginatorOrg: nokia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 3801c5c2-4eb8-4af3-df48-08d5b0368552
X-MS-Exchange-CrossTenant-originalarrivaltime: 02 May 2018 14:10:55.2545 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 5d471751-9675-428d-917b-70f44f9630b0
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB5PR07MB0984
Archived-At: <https://mailarchive.ietf.org/arch/msg/cdni/35A485vEmm3vSMCHh5suWWC0QZ8>
Subject: Re: [CDNi] CDNI JSON object description notations
X-BeenThere: cdni@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: "This list is to discuss issues associated with the Interconnection of Content Delivery Networks \(CDNs\)" <cdni.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/cdni>, <mailto:cdni-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/cdni/>
List-Post: <mailto:cdni@ietf.org>
List-Help: <mailto:cdni-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/cdni>, <mailto:cdni-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 02 May 2018 14:11:07 -0000

Hi Ori, all,

I don't think the difference has any particular significance, just style. I probably based the Triggers headings on an earlier version of the metadata draft, or maybe just changed the headings without thinking.

I'm not sure whether it's best to have an Open Caching extensions draft per CDNI interface. Perhaps it depends on where the extensions are headed ... if the intention is to update/replace each of the existing RFCs, maybe it'll be easiest to keep the draft updates separate. Otherwise, if the new draft is going to turn into a standalone SVA Open Caching extensions RFC, perhaps it'd be best to keep all the extensions together?

Rob.


From: CDNi <cdni-bounces@ietf.org> on behalf of Ori Finkelman <orif@qwilt.com>
Date: Wednesday, 2 May 2018 at 13:49
To: "<cdni@ietf.org>" <cdni@ietf.org>
Subject: [CDNi] CDNI JSON object description notations

Dear all,
I am currently drafting and extension for the CDNI Triggers interface.
I am wondering about the differences in JSON object specification notations between RFCs 8006 (metadata) and 8008 (FCI)  vs RFC 8007 (Triggers).
In metadata and FCI a json field is described as a "property" that has a "description" and a "type", for example
+  GenericMetadata https://tools.ietf.org/html/rfc8006#section-4.1.7


      Property: generic-metadata-type



         Description: Case-insensitive CDNI Metadata object type.



         Type: String containing the CDNI Payload Type [RFC7736<https://tools.ietf.org/html/rfc7736>] of the

         object contained in the generic-metadata-value property (see

         Table 4).

+ FCI Base Advertisement Object https://tools.ietf.org/html/rfc8008#section-5.1



      Property: capability-type



         Description: CDNI capability object type.



         Type: FCI-specific CDNI Payload Type (from the "CDNI Payload

         Types" registry [RFC7736<https://tools.ietf.org/html/rfc7736>])



         Mandatory-to-Specify: Yes.

While in Triggers, the JSON field is described as a "name" that has a "description" and a "value" for example:
+ Trigger Specification https://tools.ietf.org/html/rfc8007#section-5.2.1


      Name: type



         Description: Defines the type of the CI/T Trigger Command.



         Value: Trigger Type, as defined in Section 5.2.2<https://tools.ietf.org/html/rfc8007#section-5.2.2>.

I was wondering what is the reason for this difference, is it anything but different styles ? what notation should we follow when extending these interfaces, and in my case, as my draft extends both interface, what notation should be used ?
Perhaps, this means I should have two separate drafts ?

Thanks,
Ori

--
Ori Finkelman
Qwilt | Work: +972-72-2221647 | Mobile: +972-52-3832189 | orif@qwilt.com<mailto:orif@qwilt.com>

v2.23.0 | Report a Bug | By Email