IETF Logo Mail Archive

Re: [httpapi] OpenAPI media type

"Kevin Smith, Vodafone" <Kevin.Smith@vodafone.com> Fri, 28 July 2023 10:30 UTC

Return-Path: <Kevin.Smith@vodafone.com>
X-Original-To: httpapi@ietfa.amsl.com
Delivered-To: httpapi@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id A7A88C151AED for <httpapi@ietfa.amsl.com>; Fri, 28 Jul 2023 03:30:56 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.106
X-Spam-Level:
X-Spam-Status: No, score=-2.106 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_BLOCKED=0.001, RCVD_IN_MSPIKE_H2=-0.001, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_BLOCKED=0.001, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=vodafone.com
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id jGxt1XucklyB for <httpapi@ietfa.amsl.com>; Fri, 28 Jul 2023 03:30:52 -0700 (PDT)
Received: from EUR02-DB5-obe.outbound.protection.outlook.com (mail-db5eur02lp2111.outbound.protection.outlook.com [104.47.11.111]) (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 37339C1519BF for <httpapi@ietf.org>; Fri, 28 Jul 2023 03:30:51 -0700 (PDT)
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Dnn/gLXVLowy3oNj0z75lqcL1v3uhopgbJvpC6ZbTUN96ObguDKhI/FMTQY3PP/2Ja6sbphB5Nc+GtaXlgdwlmhf9LblUnHjsIdgQvXin0gcAjsQGbDeVdsfbOwpcy5DX9vMH5naN+H88mgmHB/8hKuZ8W/oaNBcgDWmsiSlag1/5eBBtmyoc4neGRazF8PNOMDkPUsEcUCX82qwSRi0Gr7mo9zHq/Lxe8/mX7fxv3ysfmumlWtBOgC0IpOVYq5ERyST3p2tamNqhUI4Ydi6+h5QWhFKNnnRlTt9gQ6JIZqB/1j/C0mUBZqkqomBFh0vG49yzqbwXW79g/wji4Z+lw==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=E+Ci1BvBSSK0yeXrvbDlLDMRWLSToXnfAGodgg1BsAM=; b=liDpJT46OwZD4o80rxJWq9CJUUL9RBGmOMzOD0u7bCAHENAkLBEd0TNpHjtXA/ZJDnHGN6FDbOgo0nzNDJyh3HKIPBlhw2z6PzJy/cuhQWJmoFIoxcne3d5Rld7upTnLQd3kzBAHyKocRU4AYOQAVGIeFiEfcoCMV6OBVH6RpPICmtEpaOGHAVbJraLD6TSR/fyGowMvArSzKJkmEn9ABm6My486PEhOW7jGYF6QPzKlzS+7kxI2eI4WSbwcHMeEbvINDmFFvEVoahSWJR+P1lbgOnzcO5HlV2hg/cdhIXcJtYyePH2zDf6BnoAUNej9kB6frgLPnI9OwR+s5fntkg==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=vodafone.com; dmarc=pass action=none header.from=vodafone.com; dkim=pass header.d=vodafone.com; arc=none
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=vodafone.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=E+Ci1BvBSSK0yeXrvbDlLDMRWLSToXnfAGodgg1BsAM=; b=rTzOxq2XrIp0xhk3boNivJreoZeNJjAUKLQKFrIyvzNYGl0aPSAAQsCm/HAu0GYbbNmqxOFfxOX5vjdGtIQyv/YPdo0w7J6evn1wv7GzuzVMhIme4GVWBJi/zB9Uqn/PIKUg0xG7wNffZF+MX73gSAKyUS8hczTt3HTsjzZhcr8hZAiOOrR0SlCM6k30i7B8ta5VU2c4eZR00/G7nx7tRlUIG3v9kI+3ihMqitvShMexdw6gjtZ/SVIqJa7fDe9blxQI79VLgToqNzdAdfV2284E1OaaJ5C0gB8f683JAY+E7hJvqJzwfwjqNNoZ4rQc9+zeej4ivW86KZ56rbnvwQ==
Received: from AM5PR0501MB2418.eurprd05.prod.outlook.com (2603:10a6:203:9::17) by PAWPR05MB10716.eurprd05.prod.outlook.com (2603:10a6:102:35a::5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6631.29; Fri, 28 Jul 2023 10:30:45 +0000
Received: from AM5PR0501MB2418.eurprd05.prod.outlook.com ([fe80::e893:8735:2198:aa4f]) by AM5PR0501MB2418.eurprd05.prod.outlook.com ([fe80::e893:8735:2198:aa4f%3]) with mapi id 15.20.6631.026; Fri, 28 Jul 2023 10:30:45 +0000
From: "Kevin Smith, Vodafone" <Kevin.Smith@vodafone.com>
To: "httpapi@ietf.org" <httpapi@ietf.org>
Thread-Topic: Re: [httpapi] OpenAPI media type
Thread-Index: AdnBPMqjUmPT8cAYQyWx6ob4sYWOig==
Date: Fri, 28 Jul 2023 10:30:45 +0000
Message-ID: <AM5PR0501MB24184A63A7707CEBBD0B84F79106A@AM5PR0501MB2418.eurprd05.prod.outlook.com>
Accept-Language: en-GB, en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
msip_labels: MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_Enabled=true; MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_SetDate=2023-07-28T10:30:44Z; MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_Method=Standard; MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_Name=0359f705-2ba0-454b-9cfc-6ce5bcaac040; MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_SiteId=68283f3b-8487-4c86-adb3-a5228f18b893; MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_ActionId=60cd0189-db43-47b4-80be-87ba001f2d80; MSIP_Label_0359f705-2ba0-454b-9cfc-6ce5bcaac040_ContentBits=2
authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=vodafone.com;
x-ms-publictraffictype: Email
x-ms-traffictypediagnostic: AM5PR0501MB2418:EE_|PAWPR05MB10716:EE_
x-ms-office365-filtering-correlation-id: 2482757b-5bb7-41ac-1f61-08db8f55b3bf
x-ms-exchange-senderadcheck: 1
x-ms-exchange-antispam-relay: 0
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info: OI9p5dbEK7kJXYrcid+BUKq+ZR401ZkfCGIvXm0gQp3xLnz95IBQO+cyooqxbKNn8oJG8RIGFRGs1PHgq8yoI1o0f2FW4KFFWB84u3J91p2xrWWimR2xlziyZ4eaKSuSLZb2xcoUZxiEngB+42dK4JWY8wUluxkaYBm4j8HJldNFp0T22plWE+9C0dFxwHxB6u5MGzEwJVbAl1Ii4VM8+pgz4bJFsSTU1S/Asyzg0UWWPokapDl3sufflcam56H/W86byIZctV6FF0IZQxzpKQwqrIEDToc2XM+Ch6YwZ2NDTBms4oo8+JjzjiMpqmUwixZLO/1xIasVFZjJmCBxsfMChb/a8G86aZHrCaspihnlYh0hDFIt72Vi+9qa7t0cVzd1vJC+L1ae8eT3NdGdAf4UQH8IPp5Agzyl/WefNUEFOySy2tg7R0sqsN6RCPCsnOebI9aTYI4M4n4Jo798nTHatbX+WlAgeKs6v0orc+FjVvmdoou3JY1rVbdgX6kxxFgWSc4fxSANPr7EafUQvZyRSY5VR9aQhzM/qgdDMwBHpamxaOUSWKDTwLzJpsYH5nsuavWVmBHuxpN7/XdHwQ5Se18FlTWUATd6GJkexO8=
x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:AM5PR0501MB2418.eurprd05.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230028)(4636009)(376002)(39860400002)(396003)(346002)(366004)(136003)(451199021)(2906002)(316002)(8936002)(8676002)(52536014)(5660300002)(4744005)(41300700001)(38070700005)(33656002)(55016003)(86362001)(7696005)(71200400001)(122000001)(478600001)(82960400001)(26005)(6506007)(186003)(9686003)(66946007)(76116006)(38100700002)(66556008)(66446008)(64756008)(66476007)(6916009); DIR:OUT; SFP:1101;
x-ms-exchange-antispam-messagedata-chunkcount: 1
x-ms-exchange-antispam-messagedata-0: CGFju3VfaaPyFCadzx3sdWVSpJFF3Fq0gSBv/wPGE/ltKTHcg7sLZIXsTyLAyX+B/+MMBM2AUldflWj7OKANDNKwb77Ixgw46Ig3aY3kMpPvvJkdM/GqnQ/dos5CLcvLai0wCxh6fkM5nbIPPjkZ2yuErgLrVc1ZI+TDoGnQjB0WqWEbId4PYqMHMSei+W3SPBieDb4Tn1xt1Ajqfh2LKbrodWWu4KrBji7Id4wh3n1vuLVfYL8qwltp42zbFoHdiVLv4+2lzSc1drjLzImaOqMDzOXY4b0KpWSallpwCqLvFZzfMK1cHsmvM7qqRuDznYtWhsbZKnYg9gqlK/JOk+Hd7zZISzs/o7Tk4vIc0WNG1aqtG4wt92CSLMUORZTHVNhbp1Xi4q+lWP0j1/rDGkZnMhbJdnkOxt9g4hHLlaEqSGrvpTXX/04WPQxrvtq82SO8AtOyVEKKS48fOiupWIUUBSemqH1nwPipKTApMOYHhiI4/3ZCIuTryb4slMg+ow9N+wmwKuNClFC1cNpDK10x6tBrD4/WO22DKrEskbIJH9ThQhi3rhN8rxd+z0LL3Tu2/zRVx54w4R71K+CjAE31fKlKWd4javQBGAwBG32iVudBFtznzqhqNMFCg1JP+j5BRAromFxnvV+wgukdvj2bDJTUb7gpFnZrqA8wP8haNnUscJB4tie4M6oltMJZjJz8fGUWlf+mLGaYIJyqqIzsvl8IeOK/1F9kvi2aXSn0sYRjUkhlorswW0cIvw0TQJO4FyIp+ZkVsYhm9CLz9UC/xcfikTQ4BrcUziCuTTZyANPCHAxIA0iiOCA2xi/Apl28IOxSf2M7Bv5QF1/eZeaD4OAZjNkVDwL4S6fc+JN2OPzpqYGw7cp1g0CoTH+YZdcSQbGxmCRFWv86ipNdpRMDcEDvLDK92m1nst/TqoP6elHzQGef81lUd0H/v0bkq7syUgjUwgSsi5MUrigMVxWB0dJKaf/xfPNgGJI/EeALtIQOiBvQTZ/sryCjSEAH+MOQUcD9/6OxFWgrPEJW/Ng+mrzl56mNg2MMOwYVeQdZ7umWL4uzqgh9c+h+r6F+mPNJLSOZN37ZvL2NxCVdgI9woLoasCa2Qrn/jXTCpg/xxBG046C11xk+bGwNLyIE1C2MszERgX2eXqsATtBUV8TyXheq/r9UW0Omki4U4ZsPJmfndxa2ndi9fQDGdsovJoXQVkm96bV/bxQYGI229Syd91rIzM3n9JoX1tEgS38fxBxujCI5gKY2xrBtfDlLOdK8RXZ92H4yVKSnJc0gQkxpPxydGZFJPUHXyi91OcO+LeqnvblFJEkQnlTc3FiSRWEso7KH0FuraeiBHt7pxn9G6/j4cvP35aGwQzBgqdxlNU3PTG0k6z+c0HeKWzFdORW0gt3DlNLWJNInowOWxaOpWyFnp/bQP5ryqdM6/O5yZG2KQMQGyYRhE9RSEFtJioUvqdB+vpFeMAmncNX7ZDKdcQF1a1mU58Wymef6nd/Tfh/B+U8fCeQUUwdOBFXnDqXhchgf9CZ3D8wQ1+lPVapwQiHs9lay0OawAB35Yk8zg4sflOLdIhXF+Vxk/ywH
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: vodafone.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: AM5PR0501MB2418.eurprd05.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 2482757b-5bb7-41ac-1f61-08db8f55b3bf
X-MS-Exchange-CrossTenant-originalarrivaltime: 28 Jul 2023 10:30:45.3521 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 68283f3b-8487-4c86-adb3-a5228f18b893
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: AKZRZ20N9kWIAKb8nYOGT6pSz8SOn+ujXvDde68MBbMQfx2pQaOT944bGd/pA+qVl9H9CtO334OIUKnbBCoc4NatDveBR2P3vRFXyQNMfCo=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PAWPR05MB10716
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/KOqF9kRzGZrg--gOmKCpEZp6CP0>
Subject: Re: [httpapi] OpenAPI media type
X-BeenThere: httpapi@ietf.org
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: Building Blocks for HTTP APIs <httpapi.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/httpapi>, <mailto:httpapi-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/httpapi/>
List-Post: <mailto:httpapi@ietf.org>
List-Help: <mailto:httpapi-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/httpapi>, <mailto:httpapi-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 28 Jul 2023 10:30:56 -0000

Hi Darrel,

I think this can be part of realising your suggestion at yesterday's 117 session, namely for an api-catalog to support links to OAS definitions.

So e.g.

   {
     "linkset": [
       {
         "anchor": "https://developer.example.com/apis/foo_api",
         "api-definition": [
           {
             "href": "https://developer.example.com/apis/foo_api/spec",
             "type": "application/oas+yaml"
           }
         ],  
etc. 

This would require a new link relation, "api-definition" - and I see draft-ietf-httpapi-yaml-mediatypes-09 proposes the +yaml suffix, so I assume application/oas+yaml and application/oas+json could also be registered to explicitly indicate the link returns an OAS definition ?

All best,
Kevin



C2 General

v2.46.0 | Report a Bug | By Email | System Status