✨ Add ?formats param to Posts API #8305
Merged
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
|
This works pretty good already. Thanks for pre-work 🙃
Agree, i can see what you mean. A tag doesn't contain a huge data set, just some short strings. Something we can improve in the future, but i wouldn't raise an issue out of it. Let me know if you would like to 👍 |
kirrg001
force-pushed
the
formats
branch
3 times, most recently
from
bd92417
to
14444b8
Compare
refs TryGhost#8275 - Adds support for formats param - Returns html by default - Can optionally return other formats by providing a comma-separated list
kirrg001
changed the title
kevinansfield
added a commit
to kevinansfield/Ghost-Admin
that referenced
this pull request
May 30, 2017
refs TryGhost#718, TryGhost/Ghost#8305 - meta description preview in the PSM was relying on the `html` field which is no longer queried - see TryGhost#718 and TryGhost/Ghost#8305 - restores live preview that was in LTS but removed whilst implementing mobiledoc because we had no quick way of rendering mobiledoc->text - adds a boolean argument to the `formatMarkdown` util that can disable the replacement of `<script>` and `<iframe>` tags so that the inserted text isn't rendered when converting HTML to text
kevinansfield
added a commit
to kevinansfield/Ghost-Admin
that referenced
this pull request
May 30, 2017
refs TryGhost#718, TryGhost/Ghost#8305 - meta description preview in the PSM was relying on the `html` field which is no longer queried - see TryGhost#718 and TryGhost/Ghost#8305 - restores live preview that was in LTS but removed whilst implementing mobiledoc because we had no quick way of rendering mobiledoc->text - adds a boolean argument to the `formatMarkdown` util that can disable the replacement of `<script>` and `<iframe>` tags so that the inserted text isn't rendered when converting HTML to text
kevinansfield
approved these changes
May 30, 2017
kirrg001
pushed a commit
to TryGhost/Admin
that referenced
this pull request
May 30, 2017
refs #718, refs TryGhost/Ghost#8305 - meta description preview in the PSM was relying on the `html` field which is no longer queried - see #718 and TryGhost/Ghost#8305 - restores live preview that was in LTS but removed whilst implementing mobiledoc because we had no quick way of rendering mobiledoc->text - adds a boolean argument to the `formatMarkdown` util that can disable the replacement of `<script>` and `<iframe>` tags so that the inserted text isn't rendered when converting HTML to text
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.
This PR is a bit weird, and very lacking in tests.
I'm not particularly happy with the implementation - there's duplication of the properties at the API and model layer. I think this is a symptom of a much larger problem with regard to separation of concerns between the model & API layer - and one that's not worth fixing right now.
Note: I've implemented this such that if you did something like:
/posts/?formats=mobiledoc,html&fields=id,titleYou'd get all 4 fields returned, and don't have to specify the formats in both formats and fields. This is a little bit inconsistent with what happens if you did:
/posts/?include=tags&fields=id,titleWhere you'd only get the id and title fields, despite having requested tags.
I thought about this, and came to the conclusion that the concepts are different enough that it makes sense. Having to duplicate formats in a fields request is weird because they're both column names.
However,
include=tagsrepresents a whole object, not just a single field, and so eventually we want to be able to support something like/posts/?include=tags&fields=id,title,tag.nameor
/posts/?include=tags&fields=id,title,tag.*refs #8275
TODO:
formatsquery param Admin#718)