-
Notifications
You must be signed in to change notification settings - Fork 0
docs: build complete MAVULA API portal #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
EstandarMustaq
merged 1 commit into
rfc-0002-legacy-batch-guides
from
docs/complete-use-case-portal
Jul 16, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,9 @@ | ||
| node_modules/ | ||
| dist/ | ||
| .astro/ | ||
| .playwright/ | ||
| playwright-report/ | ||
| test-results/ | ||
| .redocly/ | ||
| *.log | ||
| .env | ||
|
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| import { defineConfig } from 'astro/config'; | ||
| import starlight from '@astrojs/starlight'; | ||
|
|
||
| const sidebar = [ | ||
| { label: 'Home', link: '/' }, | ||
| { | ||
| label: 'Get started', | ||
| items: [ | ||
| { label: 'Overview', link: '/v1/' }, | ||
| { label: 'Quickstart', link: '/v1/getting-started/quickstart/' }, | ||
| { label: 'Authentication', link: '/v1/getting-started/authentication/' }, | ||
| { label: 'Roles and permissions', link: '/v1/getting-started/roles-permissions/' }, | ||
| { label: 'Request reliability', link: '/v1/getting-started/request-reliability/' }, | ||
| { label: 'Postman collection', link: '/v1/resources/code-examples/#postman' }, | ||
| ], | ||
| }, | ||
| { | ||
| label: 'Guides', | ||
| items: [ | ||
| { label: 'Account setup', link: '/v1/guides/account-setup/' }, | ||
| { label: 'Financial controls', link: '/v1/guides/account-lifecycle/' }, | ||
| { label: 'Adjustments', link: '/v1/guides/financial-adjustments/' }, | ||
| { label: 'Configuration', link: '/v1/guides/configuration/' }, | ||
| { label: 'Payment jobs', link: '/v1/guides/payment-jobs/' }, | ||
| { label: 'Legacy batches', link: '/v1/guides/legacy-batches/' }, | ||
| ], | ||
| }, | ||
| { | ||
| label: 'Concepts', | ||
| items: [ | ||
| { label: 'Tenant isolation', link: '/v1/concepts/tenant-isolation/' }, | ||
| { label: 'Idempotency and retries', link: '/v1/concepts/idempotency/' }, | ||
| { label: 'Errors', link: '/v1/concepts/errors/' }, | ||
| { label: 'Projections', link: '/v1/concepts/projections/' }, | ||
| ], | ||
| }, | ||
| { | ||
| label: 'Reference', | ||
| items: [ | ||
| { label: 'Identity Access API', link: '/v1/api/identity-access/' }, | ||
| { label: 'Ledger Core API', link: '/v1/api/ledger-core/' }, | ||
| { label: 'Workbench API', link: '/v1/api/workbench/' }, | ||
| { label: 'Current limitations', link: '/v1/resources/limitations/' }, | ||
| ], | ||
| }, | ||
| { | ||
| label: 'Resources', | ||
| items: [ | ||
| { label: 'Code examples', link: '/v1/resources/code-examples/' }, | ||
| { label: 'GitHub', link: 'https://github.com/mavulahq' }, | ||
| { label: 'Support', link: 'https://github.com/orgs/mavulahq/discussions' }, | ||
| ], | ||
| }, | ||
| ]; | ||
|
|
||
| export default defineConfig({ | ||
| site: 'https://mavulahq.github.io', | ||
| base: '/developer-docs', | ||
| integrations: [ | ||
| starlight({ | ||
| title: 'MAVULA Developer Docs', | ||
| description: 'Integration guides and public API reference for MAVULA financial infrastructure.', | ||
| customCss: ['./src/styles/custom.css'], | ||
| favicon: '/favicon.svg', | ||
| social: [ | ||
| { icon: 'github', label: 'GitHub', href: 'https://github.com/mavulahq/developer-docs' }, | ||
| ], | ||
| sidebar, | ||
| pagination: true, | ||
| lastUpdated: true, | ||
| editLink: { | ||
| baseUrl: 'https://github.com/mavulahq/developer-docs/edit/main/', | ||
| }, | ||
| head: [ | ||
| { tag: 'meta', attrs: { name: 'theme-color', content: '#071a45' } }, | ||
| { tag: 'meta', attrs: { property: 'og:site_name', content: 'MAVULA Developer Docs' } }, | ||
| ], | ||
| }), | ||
| ], | ||
| }); |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| { | ||
| "info": { | ||
| "name": "MAVULA API v1", | ||
| "description": "Public identity, ledger and workbench integration workflows.", | ||
| "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" | ||
| }, | ||
| "variable": [ | ||
| { "key": "identity_base_url", "value": "https://identity.mavula.io" }, | ||
| { "key": "ledger_base_url", "value": "https://ledger.mavula.io" }, | ||
| { "key": "workbench_base_url", "value": "https://workbench.mavula.io" }, | ||
| { "key": "access_token", "value": "" }, | ||
| { "key": "account_id", "value": "" }, | ||
| { "key": "request_id", "value": "" } | ||
| ], | ||
| "item": [ | ||
| { | ||
| "name": "Identity", | ||
| "item": [ | ||
| { | ||
| "name": "Effective identity", | ||
| "request": { | ||
| "method": "GET", | ||
| "header": [{ "key": "Authorization", "value": "Bearer {{access_token}}" }], | ||
| "url": "{{identity_base_url}}/api/v1/me" | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "Accounts", | ||
| "item": [ | ||
| { | ||
| "name": "Create account", | ||
| "request": { | ||
| "method": "POST", | ||
| "header": [ | ||
| { "key": "Authorization", "value": "Bearer {{access_token}}" }, | ||
| { "key": "Content-Type", "value": "application/json" }, | ||
| { "key": "Idempotency-Key", "value": "{{$guid}}" }, | ||
| { "key": "X-Correlation-ID", "value": "{{$guid}}" } | ||
| ], | ||
| "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"customer_001\",\n \"product_id\": \"current_account_mzn\",\n \"name\": \"Operating account\",\n \"currency\": \"MZN\"\n}" }, | ||
| "url": "{{ledger_base_url}}/api/accounts" | ||
| } | ||
| }, | ||
| { | ||
| "name": "Submit freeze request", | ||
| "request": { | ||
| "method": "POST", | ||
| "header": [ | ||
| { "key": "Authorization", "value": "Bearer {{access_token}}" }, | ||
| { "key": "Content-Type", "value": "application/json" }, | ||
| { "key": "Idempotency-Key", "value": "{{$guid}}" }, | ||
| { "key": "X-Correlation-ID", "value": "{{$guid}}" } | ||
| ], | ||
| "body": { "mode": "raw", "raw": "{\n \"transition\": \"FREEZE\",\n \"reason\": \"Suspected fraud\"\n}" }, | ||
| "url": "{{ledger_base_url}}/api/accounts/{{account_id}}/status-transitions" | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "name": "Workbench", | ||
| "item": [ | ||
| { | ||
| "name": "Read platform status", | ||
| "request": { | ||
| "method": "GET", | ||
| "header": [{ "key": "Authorization", "value": "Bearer {{access_token}}" }], | ||
| "url": "{{workbench_base_url}}/api/status" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Postman dynamic variables such as
{{$guid}}are generated when the request runs, so clicking Send again after a timeout creates a differentIdempotency-Keyfor the same logical account/freeze command. That bypasses the retry receipt semantics documented elsewhere and can create duplicate mutations; store the key in a collection/environment variable instead of using{{$guid}}directly on mutating requests.Useful? React with 👍 / 👎.