Remove deprecated what_format and why_format from JSON API petition example #148
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lavaturtle
added
the
merge-candidate
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Historically, some effort petitions were formatted by including Markdown syntax in the text. To let JSON API users know how the text should be interpreted, the response for the
/petitions/foo.jsonendpoint included fieldswhat_formatandwhy_format, which could be either "plain" or "markdown".Now that we have migrated all efforts to rich-text defaults, these fields are always returning "plain", which is not useful and may be misleading for rich text with HTML markup in it. So we are deprecating the
what_formatandwhy_formatfields in the API response, and will remove them in a little while.As a first step, this PR removes
what_formatandwhy_formatfrom the example response in the API documentation.