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

Add operationId to openapi spec #1978

Merged
merged 4 commits into from
May 6, 2022
Merged

Add operationId to openapi spec #1978

merged 4 commits into from
May 6, 2022

Conversation

phixMe
Copy link
Member

@phixMe phixMe commented May 6, 2022

Signed-off-by: Peter Hicks peter@datakin.com

Problem

This adds a property to endpoints in our openapi.yml file to allow clients to be generated with reasonable human-readable function names.

Checklist

  • You've signed-off your work
  • Your changes are accompanied by tests (if relevant)
  • Your change contains a small diff and is self-contained
  • You've updated any relevant documentation (if relevant)
  • You've updated the CHANGELOG.md with details about your change under the "Unreleased" section (if relevant, depending on the change, this may not be necessary)
  • You've versioned your .sql database schema migration according to Flyway's naming convention (if relevant)

Signed-off-by: Peter Hicks <peter@datakin.com>
@phixMe phixMe added the review Ready for review label May 6, 2022
@phixMe phixMe requested a review from wslulciuc May 6, 2022 16:02
@codecov
Copy link

codecov bot commented May 6, 2022

Codecov Report

Merging #1978 (7792fd5) into main (47cb6f9) will not change coverage.
The diff coverage is n/a.

@@            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

Copy link
Member

@wslulciuc wslulciuc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I have some minor naming simplification suggestions for the operation IDs:

  • Anything with createOrUpdate* (with some exceptions) I'd use put* (ex: putNamespace). We are planning to apply the same naming conventions to our java / pyclients
  • createOrUpdateRun -> createRun, the endpoint is a post and only create runs
  • createLineage -> recordLineage

Otherwise, 💯

@wslulciuc wslulciuc removed the review Ready for review label May 6, 2022
Peter Hicks added 2 commits May 6, 2022 14:06
Signed-off-by: Peter Hicks <peter@datakin.com>
@phixMe phixMe merged commit 5459179 into main May 6, 2022
@phixMe phixMe deleted the feature/doc-operations branch May 6, 2022 21:15
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.

2 participants