Rename /accounts endpoint to /ais - #5
Draft
claude[bot] wants to merge 1 commit into
Draft
Conversation
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 >
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.
Closes #3
Summary
Issue #3 asks to rename the
/accountsendpoint to/aisfor the Account API (AIS) due to a standard change. The issue's "Affected endpoints and components" list names onlyGET /accounts, and the As-Is/To-Be diff shows a single path (/accounts→/ais), so this PR renames only that path key insrc/accountAPI.yaml:paths./accounts(thelistAccountsGET operation) →paths./aisNo other change:
/accounts/{accountId},/accounts/{accountId}/balance,/accounts/{accountId}/transactions,/accounts/{accountId}/transactions/{entryId}, the/accountsendpoint inpaymentAPI.yaml(issue scopes this to AIS only), example strings in shared schemas (AccountItem,AccountBalanceItem,AccountTransactionReport,EventNotification, etc.),operationId, tags, andinfo.versionare all left untouched.Assumptions / open points
GET /accountsas 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/aiswhile 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.info.versionwas not touched — versioning is handled by the release process.yamllint -c github/.github/.yamllint -f github src/— only pre-existing findings in unrelated files (confirmed identical onmain);src/accountAPI.yamlitself 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 theSFTI BundleCI workflow).npx @redocly/cli@2.15.0 bundle --config .github/redocly.yamlcannot be run: this repository has no.github/redocly.yamlfile (git log --all -- .github/redocly.yamlshows it has never existed on any branch, includingmain). That's a pre-existing repository/CI configuration gap, unrelated to this change, and it's why theSFTI Bundle/bundle-specscheck 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.yamlwas 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