Remove embedded API doc #2343
Merged
Remove embedded API doc #2343
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
taniki
approved these changes
Oct 23, 2019
|
I've waited a bit for the community to chime in since this is breaking. Almost a month w/o comment -> merge. |
|
@abulte we used this embedded API doc, do you have any suggestions on how to go about it after these changes? |
|
@kojicz983 we use a static page that displays the swagger doc. It should only require a few lines of code. https://github.com/etalab/doc.data.gouv.fr/blob/master/articles/_api/reference.md https://doc.data.gouv.fr/api/reference/. You may even be able to create a static page in your theme for this if you don't want another domain/server as we do and link to it via |
|
@abulte Thank you for your help! |
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 removes the embedded API doc. There is now a
API_DOC_EXTERNAL_LINKsetting that we simply link to. For data.gouv.fr it will be https://doc.data.gouv.fr/api/reference/.Context: we do not need to maintain two different versions of the same doc. There was a CVE on
swagger-uinpm package, so it's a good time for removing it.