Skip to main content

Last Call Review of draft-ietf-httpapi-link-template-02
review-ietf-httpapi-link-template-02-genart-lc-holmberg-2023-05-16-00

Request Review of draft-ietf-httpapi-link-template
Requested revision No specific revision (document currently at 04)
Type Last Call Review
Team General Area Review Team (Gen-ART) (genart)
Deadline 2023-05-29
Requested 2023-05-15
Authors Mark Nottingham
I-D last updated 2023-05-16
Completed reviews Opsdir Telechat review of -03 by Dhruv Dhody (diff)
Genart Last Call review of -02 by Christer Holmberg (diff)
Secdir Last Call review of -02 by Radia Perlman (diff)
Assignment Reviewer Christer Holmberg
State Completed
Request Last Call review on draft-ietf-httpapi-link-template by General Area Review Team (Gen-ART) Assigned
Posted at https://mailarchive.ietf.org/arch/msg/gen-art/yr8IaPnNh2eDPr8M7XFP3SFd9zI
Reviewed revision 02 (document currently at 04)
Result Ready w/issues
Completed 2023-05-16
review-ietf-httpapi-link-template-02-genart-lc-holmberg-2023-05-16-00
I am the assigned Gen-ART reviewer for this draft. The General Area
Review Team (Gen-ART) reviews all IETF documents being processed
by the IESG for the IETF Chair.  Please treat these comments just
like any other last call comments.

For more information, please see the FAQ at

<https://wiki.ietf.org/en/group/gen/GenArtFAQ>.

Document: draft-ietf-httpapi-link-template-12
Reviewer: Christer Holmberg
Review Date: 2023-05-16
IETF LC End Date: 2023-05-29
IESG Telechat date: Not scheduled for a telechat

Summary: The document is well written and easy to read. However, there are some
issues and editorial nits that I would like the authors to address.

Major issues:

Section 2:
==========

Q2_1: There is no ABNF for the header field. There are examples using both
quotes ("/{username}") and angle brackets (</books/{book_id}/author>), so
please include the ABNF.

---

Q2_2: The text says "Parameter values MUST be Strings."

It is unclear what "Strings" means. Does it mean that parameter values must be
encoded as quoted-strings? If so, why? RFC8288 says that parameter values can
be encoded both as token and quoted-string.

---

Minor issues:

N/A

Nits/editorial comments:

Section 2:
==========

Q2_3: The text says:

      Link-Template: </books/{book_id}/author>;
                       rel="author" anchor="#{book_id}"

Is there a ";" missing between the rel and anchor parameters?

---

Q2_4: The text says:

        Link-Template: "/widgets/{widget_id}"
                       rel="https://example.org/rel/widget";
                       var-base="https://example.org/vars/"

Is there a ";" missing at the end of the first line?

---