Skip to content

docs: Document repository API token creation and scope OD-395 - #2725

Draft
pedrobpereira wants to merge 1 commit into
masterfrom
doc/repo-tokens-product-page-OD-395
Draft

docs: Document repository API token creation and scope OD-395#2725
pedrobpereira wants to merge 1 commit into
masterfrom
doc/repo-tokens-product-page-OD-395

Conversation

@pedrobpereira

@pedrobpereira pedrobpereira commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Changes

  • docs/codacy-api/api-tokens.md: document repository API token name rules, mandatory 1-year-max expiry (no never-expire option), that the token value stays fully visible after creation (not masked), grandfathered legacy tokens without an expiry, the distinct "token expired" error, and the full list of 13 operations a repository token can authorize (own repository only).
  • docs/codacy-api/using-the-codacy-api.md: correct the auth section's outdated claim that all API v3 endpoints require an account token, and add a note on repository-token expiry/error behavior.

👀 Live preview

https://doc-repo-tokens-product-page-od-395--docs-codacy.netlify.app

🚧 To do

  • If relevant, include the Jira issue key at the end of the pull request title
  • Perform a self-review of the changes
  • Fix any issues reported by the CI/CD

Manual Testing

Add manual testing evidence here (steps, screenshots, environment).

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Overall readability score: 53.98 (🟢 +0.05)

File Readability
using-the-codacy-api.md 55.65 (🔴 -0.08)
api-tokens.md 67.15 (🔴 -0.99)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
using-the-codacy-api.md 55.65 42.41 11.2 13.1 11.84 7.19
  🔴 -0.08 🔴 -0.2 🔴 -0.08 🔴 -0.1 🟢 +0.05 🟢 +0.05
api-tokens.md 67.15 31.68 8.61 9.5 10.61 6.61
  🔴 -0.99 🔴 -8.56 🟢 +0.06 🟢 +0 🟢 +0.05 🟢 +0.08

Averages:

  Readability FRE GF ARI CLI DCRS
Average 53.98 42.95 10.93 12.34 12.28 8.04
  🟢 +0.05 🟢 +0.1 🟢 +0 🟢 +0 🟢 +0.01 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@github-actions
github-actions Bot temporarily deployed to Netlify August 6, 2026 13:22 Inactive
@codacy-production

Copy link
Copy Markdown
Contributor

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

AI Reviewer: first review requested successfully. AI can make mistakes. Always validate suggestions.

Run reviewer

TIP This summary will be updated as you push new changes.

@pedrobpereira
pedrobpereira force-pushed the doc/repo-tokens-product-page-OD-395 branch from fd791d7 to 5234b79 Compare August 6, 2026 13:28
@pedrobpereira
pedrobpereira force-pushed the doc/repo-tokens-product-page-OD-395 branch from 5234b79 to 8b7d7ba Compare August 6, 2026 13:32
@github-actions
github-actions Bot temporarily deployed to Netlify August 6, 2026 13:34 Inactive
Cover name rules, mandatory 1-year expiry, the 13 allowed operations, and expired-token handling for repository tokens.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@pedrobpereira
pedrobpereira force-pushed the doc/repo-tokens-product-page-OD-395 branch from 8b7d7ba to fdebbb4 Compare August 6, 2026 13:35
@github-actions
github-actions Bot temporarily deployed to Netlify August 6, 2026 13:36 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant