Skip to content
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

Simplify process to create dataset-specific openapi docs #261

Merged
merged 6 commits into from
Nov 27, 2019

Conversation

thierrydallacroce
Copy link
Contributor

@thierrydallacroce thierrydallacroce commented Nov 27, 2019

This PR proposes a refactoring of the WebServiceApiDocs class, where a couple things seemed awkward:

  1. Having to know the complete list of paths and operations we did not want. Adding new paths to our API would break the dataset-specific doc or require these new paths to be removed as well, which seemed repetitive. We simplify the logic by flipping it: chose only what to keep, discarding anything else.
  2. API paths and operations where treated and removed individually. It removed a verb everywhere, without allowing to keep a verb in one path but not another. Now paths and verbs are treated as a unit to describe one endpoint. More combinations are possible.

@thierrydallacroce thierrydallacroce merged commit feb033d into master Nov 27, 2019
@thierrydallacroce thierrydallacroce deleted the simplify-dataset-specific-docs branch November 28, 2019 04:20
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.

1 participant