Add operationId to openapi spec#1978
Merged
Merged
Conversation
Signed-off-by: Peter Hicks <peter@datakin.com>
Codecov Report
@@ Coverage Diff @@
## main #1978 +/- ##
=========================================
Coverage 78.23% 78.23%
Complexity 955 955
=========================================
Files 194 194
Lines 5293 5293
Branches 420 420
=========================================
Hits 4141 4141
Misses 706 706
Partials 446 446 📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
wslulciuc
approved these changes
May 6, 2022
wslulciuc
left a comment
Member
There was a problem hiding this comment.
Nice! I have some minor naming simplification suggestions for the operation IDs:
- Anything with
createOrUpdate*(with some exceptions) I'd useput*(ex:putNamespace). We are planning to apply the same naming conventions to ourjava/pyclients createOrUpdateRun->createRun, the endpoint is apostand only create runscreateLineage->recordLineage
Otherwise, 💯
added 2 commits
May 6, 2022 14:06
Signed-off-by: Peter Hicks <peter@datakin.com>
…oject/marquez into feature/doc-operations
jonathanpmoraes
referenced
this pull request
in nubank/NuMarquez
Feb 6, 2025
* Adds `operationId` to Marquez endpoints for client generation purposes. Signed-off-by: Peter Hicks <peter@datakin.com> * Code Review feedback. Signed-off-by: Peter Hicks <peter@datakin.com> Co-authored-by: Peter Hicks <peter@datakin.com> Co-authored-by: Willy Lulciuc <willy@datakin.com>
This file contains hidden or 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
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.
Signed-off-by: Peter Hicks peter@datakin.com
Problem
This adds a property to endpoints in our
openapi.ymlfile to allow clients to be generated with reasonable human-readable function names.Checklist
CHANGELOG.mdwith details about your change under the "Unreleased" section (if relevant, depending on the change, this may not be necessary).sqldatabase schema migration according to Flyway's naming convention (if relevant)