solid / solid/specification

Fine tune wording of the requirement for including Content-Type in the response

Open
#565 8 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

status: Waiting for Commenter
Dominant language
HTML
Stars
563
Forks
108
Avg merge
4d 13h
Merged PRs (30d)
3

Description

Extracting from: https://github.com/solid/specification/pull/561#discussion_r1305914478

In short, we want to make sure that the work makes it clear that it also applies when responding to HEAD requests.

@woutermont proposed

Server MUST generate a Content-Type header field in a message that contains a representation, even if that representation only consists of representation metadata, as in a HEAD request.

I think this is clear and concise. Maybe adjusting the last sentence to , as in a response to HEAD request

Since the wording in the spec includes nuances like

In a response to a HEAD request, the representation header fields describe the representation data that would have been enclosed in the content if the same request had been a GET

we should triple-check if we use all the terms strictly as intended by the RFC.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the specification text containing the Content-Type requirement and the cited wording about responses to HEAD requests. Compare the terminology with the referenced RFC discussion, then update the requirement so its scope and HEAD-request applicability are explicit and technically consistent.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.