Generate OperatorService API docs and remove operationId prefixes #356
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
stephanos
approved these changes
Feb 21, 2024
Quinn-With-Two-Ns
approved these changes
Feb 21, 2024
tdeebswihart
force-pushed
the
tds/openapi-fixes
branch
from
fc369e3
to
91ebcea
Compare
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.
What changed?
We didn't generate the necessary docs for the OperatorService because our needs differ from how
protogenworks, so we now resort to callingprotocmanually just to generate HTTP docs.We also no longer prefix operations with their service's name.
Why?
We discussed it and decided we didn't want those cluttering up our api docs (cc @lorensr)
Breaking changes
Nope!