-
-
Notifications
You must be signed in to change notification settings - Fork 322
Name media type keywords consistently. #411
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
Conversation
jsonschema-hyperschema.xml
Outdated
@@ -425,7 +425,7 @@ | |||
<section title="Submitting data for processing"> | |||
<t> | |||
The <xref target="submissionSchema">"submissionSchema"</xref> and | |||
<xref target="submissionEncType">"submissionEncType"</xref> keywords | |||
<xref target="submissionMediaType">"submissionMediaType"</xref> keywords | |||
describe the domain of the processing function implemented by the target | |||
resource. Otherwise, as noted above, the submission schema and encoding are |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The line above still talks about "encoding". Maybe change to media type. (This is the only place in the document where "encoding" is used, AFAICT.)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. I'd mostly done search-and-replace with a bit of skimming, it did not occur to me to search for "encoding" for some reason.
This addresses issue json-schema-org#409. "submissionEncType" is actually a media type, not an encoding, so name it accordingly. Rename "mediaType" to "targetMediaType" to make it unambiguous and fit with "target" and "targetHints".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Normally I'd be worried about changing names, but this probably hasn't gotten much use.
This addresses issue #409. Which I just filed, so if the whole thing
gets rejected, no worries. I can also remove the
targetMediaType
part if that is more controversial.
"submissionEncType" is actually a media type, not an encoding,
so name it accordingly. Rename "mediaType" to "targetMediaType"
to make it unambiguous and fit with "target" and "targetHints".