docs: add custom auth contract review guidance#48
Merged
Conversation
Coverage —
|
| File | Stmts | Miss | Cover | Missing |
|---|---|---|---|---|
src/autohive_integrations_sdk/__init__.py |
2 | 0 | 100% | |
src/autohive_integrations_sdk/integration.py |
358 | 0 | 100% |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4d66314ee2
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Olwiba
approved these changes
Jun 23, 2026
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
Updates the source
reviewing-integration-prsskill in the SDK repo with custom-auth contract review guidance.Changes
Adds a custom-auth review checklist that asks reviewers to verify:
auth.fieldsdescribes the same auth object shape the SDK/platform passes tocontext.authat execution time.auth.fields.required, when present, matches that runtime auth shape and covers credentials that must be present before handlers run.requiredarrays are valid when they match the SDK/platform contract.auth.fields.propertiesdeclares every credential field read fromcontext.auth, including nested credential fields if the runtime contract is wrapped.integration.execute_action(...)with the expected SDK/platform auth shape.auth.fields.required.Also adds the review prompt: “Does this PR test the same SDK/platform contract that production will use?”
Validation
git diff --checkNo SDK source/API files were changed, so API docs regeneration and SDK test-suite execution were not needed.