docs: document authentication token requirement for usage fields#2219
Merged
Conversation
Add documentation that authentication token is required to access usageTotalUsd and usageUsd fields in both Run and Build schemas. These fields contain cost information and require authentication to protect sensitive financial data. Fixes #1145 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Contributor
|
Preview for this PR was built for commit |
4 tasks
marcel-rbro
added a commit
that referenced
this pull request
Feb 3, 2026
## Summary Adds PR title format documentation to `.claude/instructions.md` to prevent AI agents from creating PRs with incorrect titles that fail CI checks. ## Problem PR title format requirements were: - ✅ Documented in `CONTRIBUTING.md:350` (link only, no examples) - ✅ Enforced by `.github/workflows/check-pr-title.yaml` - ❌ **Missing from `.claude/instructions.md`** (where AI looks first) This caused all 4 Phase 1 PRs (#2216, #2217, #2218, #2219) to initially fail CI checks and require manual title corrections. ## Solution Added new "Creating pull requests" section in `.claude/instructions.md` with: - **Format requirements**: Conventional Commits (`docs:`, `fix:`, `feat:`, etc.) - **Clear examples**: Both correct (✅) and incorrect (❌) formats - **Enforcement notice**: GitHub Actions validation - **References**: Links to `CONTRIBUTING.md` and workflow file ## Location Added after line 130 in the "Before submitting" section to keep all pre-submission requirements together. ## Benefits 1. **Prevents errors**: AI agents know correct format upfront 2. **Faster workflow**: No manual fixes needed after PR creation 3. **Self-documenting**: Instructions where AI looks first 4. **Consistent**: Aligns with other pre-submission checks ## Testing - [x] Section added to correct location - [x] Markdown formatting correct (no linting errors) - [x] Examples are clear and actionable - [x] Consistent with existing documentation style --- 🤖 Generated with Claude Code <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Documentation-only change with no code or workflow logic modifications; risk is limited to potential confusion if the guidance is inaccurate. > > **Overview** > Adds a new **“Creating pull requests”** section to `.claude/instructions.md` that documents the required **Conventional Commits** PR title format, with accepted type prefixes, good/bad examples, and a note that CI enforces this via the PR title check workflow (with references to `CONTRIBUTING.md` and `.github/workflows/check-pr-title.yaml`). > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit c816d24. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
danpoletaev
force-pushed
the
fix/issue-1145-document-token-requirement
branch
from
c128590 to
313af83
Compare
Contributor
|
Preview for this PR was built for commit |
B4nan
force-pushed
the
fix/issue-1145-document-token-requirement
branch
from
313af83 to
c128590
Compare
Contributor
|
Preview for this PR was built for commit |
TC-MO
approved these changes
Apr 15, 2026
TC-MO
left a comment
TC-MO
left a comment
Contributor
There was a problem hiding this comment.
Somehow this PR eluded me O.o. Either way, 2 minor nits since PPR has been removed, we can nuke mention of it from here and I'll make separate issue to go over whole reference to prune it
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
|
Preview for this PR was built for commit |
Contributor
|
A PR to update the Python client models has been created: apify/apify-client-python#739 This was automatically triggered by OpenAPI specification changes in this PR. |
vdusek
pushed a commit
to apify/apify-client-python
that referenced
this pull request
Apr 18, 2026
This PR updates the auto-generated Pydantic models based on OpenAPI specification changes in [apify-docs PR #2219](apify/apify-docs#2219).
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
3 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.
Fixes #1145
Changes
Added documentation that authentication token is required to access
usageTotalUsdandusageUsdfields.Fields updated:
In Run schema (
apify-api/openapi/components/schemas/actor-runs/Run.yaml):usageTotalUsd: Added "Requires authentication token to access."usageUsd: Added "Requires authentication token to access."In Build schema (
apify-api/openapi/components/schemas/actor-builds/Build.yaml):usageTotalUsd: Added description with token requirementusageUsd: Added description with token requirementWhy
These fields contain sensitive cost information and require authentication to access via the API. This was not previously documented, causing confusion for API users.
Testing
🤖 Generated with Claude Code
Note
Low Risk
Low risk because it only changes OpenAPI documentation strings and does not affect runtime behavior or API responses.
Overview
Updates the OpenAPI schemas for Actor
RunandBuildto explicitly document that cost-related fieldsusageTotalUsdandusageUsdrequire an authentication token to access.This is a documentation-only change to schema field descriptions to reduce confusion around missing/unauthorized cost data.
Written by Cursor Bugbot for commit c128590. Configure here.