Skip to content

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

Merged
merged 2 commits into from
Sep 28, 2017

Conversation

handrews
Copy link
Contributor

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".

@handrews handrews added this to the draft-07 (wright-*-02) milestone Sep 15, 2017
@@ -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
Copy link
Member

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.)

Copy link
Contributor Author

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".
@handrews handrews requested a review from awwright September 19, 2017 15:00
Copy link
Member

@awwright awwright left a 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.

@handrews handrews merged commit ce4966c into json-schema-org:master Sep 28, 2017
@handrews handrews deleted the mtype branch September 28, 2017 05:50
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

Successfully merging this pull request may close these issues.

4 participants