Re: [core] Warren Kumari's No Objection on draft-ietf-core-problem-details-05: (with COMMENT)

[Carsten Bormann <[e-mail]>]

Hi Warren,

thank you for these two comments — small things like these do improve the document.
The proposed fixes are at:

https://github.com/core-wg/core-problem-details/pull/36/files

On 2022-06-13, at 18:50, Warren Kumari via Datatracker <[e-mail]> wrote:
> 
> Warren Kumari has entered the following ballot position for
> draft-ietf-core-problem-details-05: No Objection
> […]
> The document, along with other ballot positions, can be found here:
> https://datatracker.ietf.org/doc/draft-ietf-core-problem-details/
> 
> 
> 
> ----------------------------------------------------------------------
> COMMENT:
> ----------------------------------------------------------------------
> 
> Thank you for this document, and also for responding to Joel's OpsDir review --
> https://datatracker.ietf.org/doc/review-ietf-core-problem-details-04-opsdir-lc-jaeggli-2022-06-06/
> 
> I have two comments (well, one comment and a nit):
> 1: Introduction: "It is designed to be reused by REST APIs, which can identify
> distinct shapes of these data items specific to their needs." - I like this
> description, but I initially went off trying to find if something (RFC7252,
> STD94, REST, etc) has described shapes before. Section 2 does a nice job of
> describing the term, but putting "shapes" in quotes in the introduction would
> have saved me some rabbit-holing...

The shape thing seems to raise interesting comments...
I just found a couple of quotes on my keyboard and added these to the introduction.

> 2: Section 3.2 / Figure 3 has an example, which helped make this all a lot
> clearer to me. I think that it would be helpful to people not familiar with
> this topic to have an example much earlier in the document...

I don’t think we can change the sequence here, but I added a forward reference for one-click access to an example for those people who want to see it right away.

Grüße, Carsten