feat: report OpenAPI x-cli extension effects#348
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds visibility into behavior-changing OpenAPI x-cli-* extensions so users can see how remote specs affect generated Restish commands.
Changes:
- Adds
XCLIExtensionReportgeneration, summary formatting, caching, and doctor API output. - Prints compact extension summaries during
api connectandapi sync. - Documents the reporting behavior and trust-boundary decision.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
internal/spec/xcli_extensions.go |
Adds extension report extraction and summary generation. |
internal/spec/xcli_extensions_test.go |
Adds unit tests for report extraction and ignored path behavior. |
internal/spec/operation.go |
Adds extension report data to OperationSet. |
internal/spec/cache.go |
Persists extension report data in operation cache. |
internal/cli/xcli_extensions.go |
Adds CLI summary and doctor detail rendering helpers. |
internal/cli/doctor.go |
Includes extension details in doctor API text and JSON reports. |
internal/cli/api.go |
Prints extension summaries during connect and sync. |
internal/cli/extensions_test.go |
Tests doctor API extension reporting. |
internal/cli/api_manage_test.go |
Tests connect/sync summary output. |
site/content/en/docs/reference/openapi-cli-integration.md |
Documents extension effect inspection. |
site/content/en/docs/guides/api-setup-and-discovery.md |
Documents connect/sync summary visibility. |
docs/design/030-security-model-and-trust-boundaries.md |
Documents trust-boundary treatment for x-cli-* metadata. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Supersedes and credits the original draft direction in #317.
Tests