feat: Add operations information to gen.lock for change reporting #64
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
This change adds a `gen.lock` (`LockFile`) type `Operations` field for API and SDK change reporting. This is intentionally a subset of operation data for prioritizing important information to present to API producers and consumers, while not exposing more of the generator internals. This information is intended to be self-contained to prevent the need for the generator or OAS-based tooling when generating API and SDK change reports, e.g. comparing the prior snapshot with a new one should contain everything necessary. The operation representation metadata can be enhanced over time if additional SDK change reporting, such as new arguments, is desired.
bflad
force-pushed
the
bflad/lockfile-operations
branch
from
4c46715 to
d231c1a
Compare
ThomasRooney
approved these changes
Nov 19, 2024
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.
Reference: https://www.notion.so/speakeasyapi/RFC-Improved-SDK-Changelogs-and-PR-Descriptions-135726c497cc80ecbd1bec3dcad8e85b?pvs=4
This change adds a
Lockfile(gen.lock) typeOperationsfield for API and SDK change reporting. This is intentionally a subset of operation data for prioritizing important information to present to API producers and consumers, while not exposing more of the generator internals. This information is intended to be self-contained to prevent the need for the generator or OAS-based tooling when generating API and SDK change reports, e.g. comparing the prior snapshot with a new one should contain everything necessary.The operation representation metadata can be enhanced over time if additional SDK change reporting, such as new arguments, is desired.