ietf-wg-httpapi / mediatypes

Other
5 stars 4 forks source link

AD review #73

Closed ioggstream closed 1 year ago

ioggstream commented 1 year ago

I would suggest adding some text to clarify these are used but not registered (in accordance with https://www.rfc-editor.org/rfc/rfc6838#section-3.4).

I am a bit conflicted about this section. I do like that it provides context around some choices. I understand that it is to be removed before publication, but seeing it there makes me wonder: why have the wg (or the authors) felt the need to add this section? Is this adding some clarification/justification that is missing from the document? In that case, why was the content not included in the text that will be published, rather than exiling it at the end?

FAQ is useful to track closed discussion. Relevant parts have been added to the spec

ioggstream commented 1 year ago

@darrelmiller @eemeli Do you think we should use normative language to address the yaml vs yml issue?

eemeli commented 1 year ago

The proposed addition of "so only one SHOULD be used" sounds good to me.

ioggstream commented 1 year ago

The following statement

so only one SHOULD be used

could conflict with

.yaml is preferred.

If we want to use normative language (which we avoided), we can just say .yaml is RECOMMENDED (but we decided to avoid normative language).

ioggstream commented 1 year ago

@eemeli wdyt on .yaml RECOMMENDED?

richsalz commented 1 year ago

Uppercase RECOMMENDED? Isn't that normative? How about just lowercase should ?

ioggstream commented 1 year ago

The AD suggestion is to use normative language @richsalz. If we don't want to do it, I think that the current text is ok and that we can just avoid normative language.

richsalz commented 1 year ago

I do have two concerns:

  1. That using normative language here means the whole document needs to be checked for other possible uses.
  2. That this then has to go through another WGLC.
eemeli commented 1 year ago

I do not have any strong opinions here, and tbh would be fine with any of the options proposed so far. This sounds like a conversation that ought to be happening on a PR.

ioggstream commented 1 year ago

@eemeli if it's ok for you, we can just confirm that we agree to avoid normative statements here, like we decided in #68

eemeli commented 1 year ago

Avoiding normative statements here is ok with me.