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

Structure questionable - 6.5 vs. 6.6 #10

Open
hrennau opened this issue May 2, 2020 · 0 comments
Open

Structure questionable - 6.5 vs. 6.6 #10

hrennau opened this issue May 2, 2020 · 0 comments

Comments

@hrennau
Copy link

hrennau commented May 2, 2020

Section 6.6 Link Input starts with this sentence:

There are four ways to use client input with a link, and each is addressed by a separate link description object keyword.

The keywords referred to are presumably:

  • hrefSchema
  • headerSchema
  • targetSchema
  • submissionSchema

I think the sentence is misleading: while hrefSchema is about client input, the other schemas are about interaction with the link, but not about user input.

My suggestion goes beyond editing the sentence, it is a reconsideration of the current structure. A key principle is - and doubtless should be - alignment with the generic link model from RFC 8288. There we have the link property "target attributes", reflected here by section 6.5 Link Target Attributes. It includes 6.5.3. targetMediaType and 6.5.4 targetSchema. All very well.

The issue is that

  • 6.6.2 header Schema
  • 6.6.4.1. submissionMediatype
  • 6.6.4.2. submissionSchema

should also be part of 6.5 Link Target Attributes, as they clearly give information about the target, more precisely, how to interact with it. The contents of

  • 6.6.3 Manipulating the Target Resource Representation

finally, might be merged into 6.5.3 and 6.5.4.

How uneasy the current structure is, becomes obvious when trying to relate the sentence quoted in the beginning of this posting ("four ways to use client input ...") to the subsections following it: you would expect four matching subsections, but the third is more like a reference into contents found in 6.5.

@handrews handrews transferred this issue from json-schema-org/json-schema-spec May 2, 2020
@handrews handrews changed the title [JSON Hyper-Schema] Structure questionable - 6.5 vs. 6.6 Structure questionable - 6.5 vs. 6.6 May 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant