Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

digest: editorial remarks on Appendix A #2178

Closed
7 tasks done
reschke opened this issue Jun 22, 2022 · 5 comments · Fixed by #2184
Closed
7 tasks done

digest: editorial remarks on Appendix A #2178

reschke opened this issue Jun 22, 2022 · 5 comments · Fixed by #2184

Comments

@reschke
Copy link
Contributor

reschke commented Jun 22, 2022

I tried to follow the examples but found them slightly confusing.

The following examples show how representation metadata, payload transformations and method impacts on the message and content. When the content contains non-printable characters (e.g. when it is compressed) it is shown as a Base64-encoded string.

  1. payload -> content, right?
  2. I think it would be easier to use hex encoding, because it would make it easier to follow what happens with ranges.

Now the same content conveys a malformed JSON object, because the request does not indicate a content coding.

  1. Maybe: "removing the content coding from the same request causes the content to become malformed"

A Range-Request alters the content, conveying a partial representation.

  1. "alters the content" is technically correct, but can easily be read as somehow affecting the server state. Maybe "affects the transferred message content"

Figure 5: Partial response from a gzip-encoded representation

  1. To which server state does this refer? The one after executing the PUT in figure 3?

The method can also alter the content.

  1. (see above)

Finally, the semantics of an HTTP response might decouple the effective request URI from the enclosed representation.

  1. We removed "effective request URI" in RFC 9110, see end of https://www.rfc-editor.org/rfc/rfc9110.html#section-7.1)
@reschke
Copy link
Contributor Author

reschke commented Jun 22, 2022

"effective request URI" appears again in B.9. Digest with PATCH

@ioggstream
Copy link
Contributor

@reschke is "target URI" ok?

@reschke
Copy link
Contributor Author

reschke commented Jun 22, 2022

Yes.

@ioggstream
Copy link
Contributor

Hex encoding will be ~ 100 chars. I agree that it can be easier to understand
but it will be noisy too. Ideas?

@reschke
Copy link
Contributor Author

reschke commented Jun 29, 2022

Hex encoding will be ~ 100 chars. I agree that it can be easier to understand but it will be noisy too. Ideas?

Given the fact that the spec already has to deal with long lines in examples I don't think that's a problem.

LPardue added a commit that referenced this issue Jul 7, 2022
* Fix #2178. Editorial improvements on examples.

* Suggestion from code revision.

* Julian's revision

* fix encoded representation

* Update draft-ietf-httpbis-digest-headers.md

Co-authored-by: Lucas Pardue <lucaspardue.24.7@gmail.com>

* trim that trailinggit add draft-ietf-httpbis-digest-headers.md 1

Co-authored-by: Lucas Pardue <lucaspardue.24.7@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

2 participants