docs(openapi): document branchName/prCreationFailed in fix changeDetails#2782
Open
rpapani wants to merge 2 commits into
Open
docs(openapi): document branchName/prCreationFailed in fix changeDetails#2782rpapani wants to merge 2 commits into
rpapani wants to merge 2 commits into
Conversation
Document the code-patch fix changeDetails keys (pullRequestUrl, issueUrl, issueNumber, patchType) and add the new branchName + prCreationFailed fields set by spacecat-autofix-worker when a branch is pushed but PR creation fails. Docs-only; changeDetails stays additionalProperties: true. Co-Authored-By: Claude <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
…gedetails-branch-fields
|
This PR will trigger no release when merged. |
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
1 participant
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
Documents the fix-entity
changeDetailsfields used by the code-patch (CWV) autofix path in the OpenAPI schema, including two new keys:branchName(string) — the branch pushed to the repository when a PR could not be created.prCreationFailed(boolean) —truewhen the branch was pushed but PR creation failed.changeDetailsremains free-form (additionalProperties: true); this adds adescriptionenumerating the common code-patch keys so consumers (ASO UI) know what to expect.Why
Follows up the cross-repo change that surfaces a pushed branch when PR creation fails:
branchName/prCreationFailedintochangeDetails)Notes
Docs-only change.
npm run docs:lintpasses (pre-existing warnings only).🤖 Generated with Claude Code