Skip to content

Rename /accounts endpoint to /ais - #5

Draft
claude[bot] wants to merge 1 commit into
mainfrom
issue/3-rename-account-endpoint
Draft

Rename /accounts endpoint to /ais#5
claude[bot] wants to merge 1 commit into
mainfrom
issue/3-rename-account-endpoint

Conversation

@claude

@claude claude Bot commented Aug 17, 2026

Copy link
Copy Markdown

Closes #3

Summary

Issue #3 asks to rename the /accounts endpoint to /ais for the Account API (AIS) due to a standard change. The issue's "Affected endpoints and components" list names only GET /accounts, and the As-Is/To-Be diff shows a single path (/accounts/ais), so this PR renames only that path key in src/accountAPI.yaml:

  • paths./accounts (the listAccounts GET operation) → paths./ais

No other change: /accounts/{accountId}, /accounts/{accountId}/balance, /accounts/{accountId}/transactions, /accounts/{accountId}/transactions/{entryId}, the /accounts endpoint in paymentAPI.yaml (issue scopes this to AIS only), example strings in shared schemas (AccountItem, AccountBalanceItem, AccountTransactionReport, EventNotification, etc.), operationId, tags, and info.version are all left untouched.

Assumptions / open points

  • Scope of the rename: the issue only lists GET /accounts as affected and gives a single-path As-Is/To-Be, so only that one path was renamed. Note this creates a small inconsistency: the account list now lives at /ais while the single-account and sub-resource endpoints stay under /accounts/{accountId}/.... If the intent was actually to rename the whole /accounts/* subtree (and update the path examples inside shared AIS schemas accordingly) to keep the collection and its sub-resources under the same base path, please confirm and this can be extended in a follow-up commit on this branch.
  • This is a breaking path rename; per repo rules info.version was not touched — versioning is handled by the release process.
  • Validation:
    • yamllint -c github/.github/.yamllint -f github src/ — only pre-existing findings in unrelated files (confirmed identical on main); src/accountAPI.yaml itself has zero findings.
    • yamllint -d "{extends: github/.github/.yamllint, rules: {line-length: {max: 170}}}" -f github accountAPI.yaml paymentAPI.yaml accountAPI-eventNotificationWebhook.yaml paymentAPI-eventNotificationWebhook.yaml — passes clean.
    • npx @redocly/cli@2.15.0 lint --config=github/.github/redocly.yaml accountAPI.yaml paymentAPI.yaml accountAPI-eventNotificationWebhook.yaml paymentAPI-eventNotificationWebhook.yaml — passes clean (these root files aren't regenerated yet; that happens via the SFTI Bundle CI workflow).
    • npx @redocly/cli@2.15.0 bundle --config .github/redocly.yaml cannot be run: this repository has no .github/redocly.yaml file (git log --all -- .github/redocly.yaml shows it has never existed on any branch, including main). That's a pre-existing repository/CI configuration gap, unrelated to this change, and it's why the SFTI Bundle / bundle-specs check on this PR fails ("Missing redocly config file at .github/redocly.yaml"). Per repo rules this agent may not create or edit anything under .github/, so this needs to be added separately by a maintainer. As a substitute, npx @redocly/cli@2.15.0 bundle src/accountAPI.yaml was run directly, confirming all $refs in the split source still resolve correctly after the rename.

Co-Authored-By: sfti-agent ai-agent@common-api.ch

Issue #3 requests renaming the /accounts list endpoint to /ais due to
standard changes. Scope per the issue is limited to this single
endpoint (accountAPI/AIS only); /accounts/{accountId} and its
sub-resources are unaffected.

Co-Authored-By: sfti-agent <ai-agent@common-api.ch >
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.

Rename /account endpoint

1 participant