[httpapi] Orie Steele's No Objection on draft-ietf-httpapi-api-catalog-06: (with COMMENT)

Orie Steele via Datatracker <noreply@ietf.org> Wed, 04 December 2024 20:44 UTC

Return-Path: <noreply@ietf.org>
X-Original-To: httpapi@ietf.org
Delivered-To: httpapi@ietfa.amsl.com
Received: from [10.244.8.175] (unknown [104.131.183.230]) by ietfa.amsl.com (Postfix) with ESMTP id 5EFE1C15109A; Wed, 4 Dec 2024 12:44:30 -0800 (PST)
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
From: Orie Steele via Datatracker <noreply@ietf.org>
To: The IESG <iesg@ietf.org>
X-Test-IDTracker: no
X-IETF-IDTracker: 12.28.2
Auto-Submitted: auto-generated
Precedence: bulk
Message-ID: <173334507005.1837030.14553190603338669439@dt-datatracker-5679c9c6d-qbvvv>
Date: Wed, 04 Dec 2024 12:44:30 -0800
Message-ID-Hash: 77XBLIHUA4YRERBPGFY2DZ5U5L5PHIUL
X-Message-ID-Hash: 77XBLIHUA4YRERBPGFY2DZ5U5L5PHIUL
X-MailFrom: noreply@ietf.org
X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header
CC: draft-ietf-httpapi-api-catalog@ietf.org, httpapi-chairs@ietf.org, httpapi@ietf.org, darrel@tavis.ca
X-Mailman-Version: 3.3.9rc6
Reply-To: Orie Steele <orie@transmute.industries>
Subject: [httpapi] Orie Steele's No Objection on draft-ietf-httpapi-api-catalog-06: (with COMMENT)
List-Id: Building Blocks for HTTP APIs <httpapi.ietf.org>
Archived-At: <https://mailarchive.ietf.org/arch/msg/httpapi/LWt8eSDh8E8tKFuwUrBFLVLyVco>
List-Archive: <https://mailarchive.ietf.org/arch/browse/httpapi>
List-Help: <mailto:httpapi-request@ietf.org?subject=help>
List-Owner: <mailto:httpapi-owner@ietf.org>
List-Post: <mailto:httpapi@ietf.org>
List-Subscribe: <mailto:httpapi-join@ietf.org>
List-Unsubscribe: <mailto:httpapi-leave@ietf.org>

Orie Steele has entered the following ballot position for
draft-ietf-httpapi-api-catalog-06: No Objection

When responding, please keep the subject line intact and reply to all
email addresses included in the To and CC lines. (Feel free to cut this
introductory paragraph, however.)


Please refer to https://www.ietf.org/about/groups/iesg/statements/handling-ballot-positions/ 
for more information about how to handle DISCUSS and COMMENT positions.


The document, along with other ballot positions, can be found here:
https://datatracker.ietf.org/doc/draft-ietf-httpapi-api-catalog/



----------------------------------------------------------------------
COMMENT:
----------------------------------------------------------------------

# Orie Steele, ART AD, comments for draft-ietf-httpapi-api-catalog-06
CC @OR13

* line numbers:
  -
  https://author-tools.ietf.org/api/idnits?url=https://www.ietf.org/archive/id/draft-ietf-httpapi-api-catalog-06.txt&submitcheck=True

* comment syntax:
  - https://github.com/mnot/ietf-comments/blob/main/format.md

* "Handling Ballot Positions":
  - https://ietf.org/about/groups/iesg/statements/handling-ballot-positions/

## Almost a Discuss

There is an open expert review comment for -06 and IANA is listed as not OK.

I read the expert's comment and I think I agree with them.

>From https://datatracker.ietf.org/doc/html/rfc8288#section-2.1.1.1

```
o  *Description*: A short English description of the type's
      semantics.  It SHOULD be stated in terms of the relationship
      between the link context and link target.
```

I believe that context was used correctly in -05, and ... I can see from the
list there are plans in the works to correct this:

https://mailarchive.ietf.org/arch/msg/httpapi/w8VtmpTdXLah8lfyGKkOzptOOLo/

## Comments

Thanks to Tim Bray for the ARTART Review, and the the authors for addressing
his comments.

As a general comment there appear to be a lot of BCP14 SHOULD's that are really
"you ought to", and that do not have an impact on interoperability or security,
I've opted not to ask the question "when can this SHOULD be ignored" on each of
them.

### Why is HEAD not mandatory?

```
186        *  SHOULD resolve an HTTPS HEAD request to /.well-known/api-catalog
187           with a response including a Link header with the relation(s)
188           defined in Section 3
```

When can this SHOULD be ignored?

### Which URL?

```
259        *  A linkset in JSON Document format (section 4.2 of [RFC9264]) of
260           API endpoints and information to facilitate API usage.  The
261           linkset SHOULD include a profile parameter (section 5 of
262           [RFC9264]) with a Profile URI [RFC7284] value of 'THIS-RFC-URL' to
263           indicate the linkset is representing an API Catalog document as
264           defined above.  Appendix A includes example API Catalog documents
265           based on the linkset format.
```

```
550        RFC Editor's Note: IANA is kindly requested to replace all instances
551        of THIS-RFC and THIS-RFC-URL with the actual RFC number/URL once
552        assigned.
```

Maybe its obvious but I assume this is not a link to the datatracker?

### Informative section with BCP14 RECOMMENDED?

```
662        This section is informative and provides and example of an API
663        Catalog document using the RECOMMENDED linkset format.
```

Also isn't linkset mandatory to support?