Skip to content

Fix HMAC auth docs (Base64, Pro URL, URL-safe secrets) - #13

Closed
guiviaje wants to merge 1 commit into
anbotolabs:mainfrom
guiviaje:fix/api-auth-docs-bac944
Closed

Fix HMAC auth docs (Base64, Pro URL, URL-safe secrets)#13
guiviaje wants to merge 1 commit into
anbotolabs:mainfrom
guiviaje:fix/api-auth-docs-bac944

Conversation

@guiviaje

Copy link
Copy Markdown

Summary

Updates the OpenAPI info.description shown on https://anbotolabs.github.io/anboto-api-docs/

  • Fix typo Base664Base64
  • Clarify X-SIGN for HMAC is standard Base64, not hex
  • Document secret decode: standard Base64 (legacy) vs URL-safe Base64 (new keys)
  • Add Pro base URL: https://api.pro.anboto.xyz and settings link
  • Add YAML document start (---) for yamllint

After merge

Redeploy GitHub Pages (existing deploy.sh / CI) so the site picks up the new intro text.

Related

Made with Cursor

Correct Base64 typo, document standard vs URL-safe secret decode, state that
X-SIGN for HMAC is standard Base64 (not hex), and add api.pro.anboto.xyz.

Co-authored-by: Cursor <cursoragent@cursor.com>
guiviaje added a commit that referenced this pull request Jul 6, 2026
@guiviaje

guiviaje commented Jul 6, 2026

Copy link
Copy Markdown
Author

Superseded by #14. All of this PR's content is preserved — but moved to the source of truth: the OpenAPI description is generated from the api-gw code annotations (kapt), so hand-edits to the yml get overwritten on regeneration. The Base664→Base64 typo, the hex→Base64 X-SIGN fix, the standard-vs-URL-safe secret decoding note (matching ApiSignatureValidator.decodeSignKey) and the Pro base URL + settings link are now in Application.kt on the GitLab api-docs-refresh branch, and #14 carries the regenerated spec. yamllint doc-start is handled there too.

🤖 Generated with Claude Code

@guiviaje guiviaje closed this Jul 6, 2026
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