[Draft] API Documentation Updates for v1.181.0#1671
Draft
github-actions[bot] wants to merge 3 commits into
Draft
[Draft] API Documentation Updates for v1.181.0#1671github-actions[bot] wants to merge 3 commits into
github-actions[bot] wants to merge 3 commits into
Conversation
- New base spec: seqera-api-1.181.0.yaml - Comparison overlay generated - Analysis report created - Claude-generated overlays ready for review
llewellyn-sl
changed the base branch from
codex/isolate-api-docs-version-checkout
to
master
July 20, 2026 17:58
tcrespog
approved these changes
Jul 21, 2026
tcrespog
left a comment
tcrespog
left a comment
Contributor
There was a problem hiding this comment.
Reviewed audit logs content: looks good to me overall.
Unrelated question regarding these "overlays": couldn't the edits present in the overlays be applied at the source Platform OpenAPI model/definition directly? Ideally, handling a single source of truth would make it easier to maintain (say, we introduce a new actor type for audit logs).
At least for API v2, now that it is going to start being implemented, perhaps we want to minimize our reliance on overlays.
| @@ -0,0 +1,1614 @@ | |||
| I'll generate the OpenAPI overlay files for version 1.181.0, organized by controller/tag. I'll create operations, parameters, and schemas overlays for each affected area. | |||
Contributor
There was a problem hiding this comment.
Perhaps this statement is not meant to be part of the document.
| update: "Filter logs with timestamp on or before this date in ISO 8601 format." | ||
|
|
||
| - target: "$.paths['/admin/audit-logs-v2/{auditLogId}'].get.parameters[?(@.name=='attributes')].description" | ||
| update: "Additional attribute values to include in the response. Accepts `state` for pre/post change images. Returns an empty value if omitted." |
Contributor
There was a problem hiding this comment.
Returns an empty value if omitted
If omitted, the state images content is not present.
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
2 participants
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.
API Version: 1.181.0
This PR was automatically generated by the API docs workflow.
What's included
Source Information
Next steps
claude-generated-overlays.mdpython scripts/validate_overlay.py <file>overlays-approvedto trigger Phase 3Analysis Summary
See analysis JSON file for detailed breakdown of changes.