From 667bee3b2552f3fba6abedf1ff55351f4cf48b6c Mon Sep 17 00:00:00 2001 From: Hongwei Date: Fri, 13 Nov 2026 00:44:50 +0100 Subject: [PATCH 1/6] test: list every OBP-API call of the apps in obp-api-contract/contract.json --- obp-api-contract/contract.json | 10404 +++++++++++++++++++++++++++++++ 1 file changed, 10404 insertions(+) create mode 100644 obp-api-contract/contract.json diff --git a/obp-api-contract/contract.json b/obp-api-contract/contract.json new file mode 100644 index 00000000..94fe5004 --- /dev/null +++ b/obp-api-contract/contract.json @@ -0,0 +1,10404 @@ +{ + "about": "Every OBP-API call that the Portal, API Manager, Cohort and the shared package make from their source code. Each entry gives the verb, the path (OBP placeholders in capitals), the source file, the text in that file that makes the call (needles) and the response fields the code reads. packages/shared/src/lib/server/obp/obpApiContract.test.ts checks this list against the source and against snapshot.json, which obp-api-contract/snapshot.py writes from an OBP-API's resource docs. not_calls lists source lines that name an OBP-API path without calling it, such as help text, example code and path helpers whose calls are listed at their callers. Not listed: calls through the generic proxy (/proxy/obp/...) whose path the browser or the route chooses at run time, records of the Dynamic Entities the apps define themselves (/obp/dynamic-entity/... and their v7.0.0 bank-level form), and dynamic endpoints. Not covered yet: the Berlin Group and UK Open Banking calls of the Portal, because snapshot.py reads only OBP resource docs.", + "calls": [ + { + "verb": "GET", + "path": "/obp/v6.0.0/root", + "source": "apps/api-manager/src/hooks.server.ts", + "needles": [ + "`${publicEnv.PUBLIC_OBP_BASE_URL}/obp/v6.0.0/root`" + ], + "reads": [], + "note": "Registered as the 'OBP API (REST)' health check; the shared HealthCheckService GETs the URL and only looks at the HTTP status." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings", + "source": "apps/api-manager/src/lib/components/DynamicEndpointOperationsTable.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/banks/${encodeURIComponent(bankId)}/endpoint-mappings`" + ], + "reads": [], + "note": "mappingsBase is the bank-level path when bankId is set; POST creates a mapping when none exists for the operation. Only response.ok is checked." + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings/ENDPOINT_MAPPING_ID", + "source": "apps/api-manager/src/lib/components/DynamicEndpointOperationsTable.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/banks/${encodeURIComponent(bankId)}/endpoint-mappings`", + "`${mappingsBase}/${encodeURIComponent(existing.endpoint_mapping_id)}`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings/ENDPOINT_MAPPING_ID", + "source": "apps/api-manager/src/lib/components/DynamicEndpointOperationsTable.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/banks/${encodeURIComponent(bankId)}/endpoint-mappings`", + "`${mappingsBase}/${encodeURIComponent(existing.endpoint_mapping_id)}`" + ], + "reads": [], + "note": "Updates an existing mapping under the bank-level mappingsBase. Only response.ok is checked." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/endpoint-mappings", + "source": "apps/api-manager/src/lib/components/DynamicEndpointOperationsTable.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/endpoint-mappings`" + ], + "reads": [], + "note": "mappingsBase is the system-level path when no bankId is set; POST creates a mapping when none exists for the operation. Only response.ok is checked." + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID", + "source": "apps/api-manager/src/lib/components/DynamicEndpointOperationsTable.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/endpoint-mappings`", + "`${mappingsBase}/${encodeURIComponent(existing.endpoint_mapping_id)}`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID", + "source": "apps/api-manager/src/lib/components/DynamicEndpointOperationsTable.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/endpoint-mappings`", + "`${mappingsBase}/${encodeURIComponent(existing.endpoint_mapping_id)}`" + ], + "reads": [], + "note": "Updates an existing mapping under the system-level mappingsBase. Only response.ok is checked." + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "source": "apps/api-manager/src/lib/components/DynamicEndpointOperationsTable.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/json-schema-validations/${encodeURIComponent(op.operationId)}`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "source": "apps/api-manager/src/lib/components/DynamicEndpointOperationsTable.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/json-schema-validations/${encodeURIComponent(op.operationId)}`" + ], + "reads": [], + "note": "POST when no validation exists yet for the operation, otherwise PUT (computed method); the page only checks response.ok and reloads." + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "source": "apps/api-manager/src/lib/components/DynamicEndpointOperationsTable.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/json-schema-validations/${encodeURIComponent(op.operationId)}`" + ], + "reads": [], + "note": "PUT when a validation already exists for the operation (computed method); the page only checks response.ok and reloads." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/dynamic-resource-docs/endpoint-code", + "source": "apps/api-manager/src/lib/components/DynamicResourceDocForm.svelte", + "needles": [ + "\"/proxy/obp/v5.1.0/management/dynamic-resource-docs/endpoint-code\"" + ], + "reads": [ + "code" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/dynamic-resource-docs/compile", + "source": "apps/api-manager/src/lib/components/DynamicResourceDocForm.svelte", + "needles": [ + "\"/proxy/obp/v7.0.0/management/dynamic-resource-docs/compile\"" + ], + "reads": [ + "compiles", + "duration_ms", + "errors", + "errors[].line", + "errors[].column", + "errors[].message", + "dependency_error" + ], + "undocumented_fields": [ + "dependency_error" + ], + "note": "dependency_error is read as data.dependency_error and shown next to the compiler errors." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/dynamic-resource-docs/explain", + "source": "apps/api-manager/src/lib/components/DynamicResourceDocForm.svelte", + "needles": [ + "\"/proxy/obp/v7.0.0/management/dynamic-resource-docs/explain\"" + ], + "reads": [ + "caller_may_run", + "explained_for", + "space", + "refusal", + "entities", + "entities[].entity", + "entities[].read_role", + "entities[].bank_id", + "entities[].public_access", + "entities[].row_level_access", + "entities[].caller_may_read", + "restricted_fields", + "restricted_fields[].entity", + "restricted_fields[].field", + "restricted_fields[].restriction", + "restricted_fields[].read_role", + "restricted_fields[].caller_may_read", + "rules", + "rules[]", + "steps", + "steps[].step", + "steps[].purpose", + "steps[].backend", + "steps[].sql", + "steps[].parameter_count", + "steps[].notes", + "steps[].notes[]" + ], + "undocumented_fields": [ + "restricted_fields[].entity", + "restricted_fields[].field", + "restricted_fields[].restriction", + "restricted_fields[].read_role", + "restricted_fields[].caller_may_read" + ], + "note": "The page renders restricted_fields as objects (entity, field, restriction, read_role, caller_may_read); the docs list restricted_fields[] without sub-fields." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/email/USER_EMAIL/terminator", + "source": "apps/api-manager/src/lib/components/UserSearchPickerWidget.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/users/email/${encodeURIComponent(trimmed)}/terminator`" + ], + "reads": [ + "users", + "users[].username", + "users[].email", + "users[].user_id", + "users[].provider" + ], + "note": "Used when the search text looks like an email address." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/providers", + "source": "apps/api-manager/src/lib/components/UserSearchPickerWidget.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/providers\"" + ], + "reads": [ + "providers", + "providers[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users", + "source": "apps/api-manager/src/lib/components/UserSearchPickerWidget.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/users?${params.toString()}`" + ], + "reads": [ + "users", + "users[].username", + "users[].email", + "users[].user_id", + "users[].provider" + ], + "note": "Username search with username and optional provider query parameters." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user-id/USER_ID", + "source": "apps/api-manager/src/lib/components/UserSearchPickerWidget.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/users/user-id/${encodeURIComponent(trimmed)}`" + ], + "reads": [ + "user_id", + "username", + "email", + "provider" + ], + "note": "Used when the search text is a UUID; the single user object is wrapped into a one-element list." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/well-known", + "source": "apps/api-manager/src/lib/oauth/providerManager.ts", + "needles": [ + "\"/obp/v6.0.0/well-known\"" + ], + "reads": [ + "well_known_uris", + "well_known_uris[].provider", + "well_known_uris[].url" + ], + "undocumented_fields": [ + "well_known_uris", + "well_known_uris[].provider", + "well_known_uris[].url" + ], + "note": "The path is handed to the shared OAuth2ProviderManager (packages/shared/src/lib/server/oauth/providerManager.ts), which GETs it with obp_requests and reads well_known_uris[].provider and .url to set up the login providers." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/app-directory", + "source": "apps/api-manager/src/lib/obp/appDirectory.ts", + "needles": [ + "\"/obp/v7.0.0/app-directory\"" + ], + "reads": [ + "app_directory", + "app_directory[].name", + "app_directory[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/method_routings", + "source": "apps/api-manager/src/lib/server/activeConnector.ts", + "needles": [ + "\"/obp/v5.1.0/management/method_routings\"", + "obp_requests.get(METHOD_ROUTINGS_PATH" + ], + "reads": [ + "method_routings", + "method_routings[].connector_name" + ], + "note": "Only read when the connector prop is star." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/config-props", + "source": "apps/api-manager/src/lib/server/activeConnector.ts", + "needles": [ + "\"/obp/v6.0.0/management/config-props\"", + "obp_requests.get(CONFIG_PROPS_PATH" + ], + "reads": [ + "config_props", + "config_props[].name", + "config_props[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/api-manager/src/lib/server/domainApis.ts", + "needles": [ + "\"/obp/v6.0.0/banks\"" + ], + "reads": [ + "banks", + "banks[].bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/api-manager/src/lib/server/domainApis.ts", + "needles": [ + "dynamicEntityDefinitionsPath(bankId)" + ], + "reads": [ + "dynamic_entities", + "dynamic_entities[].entity_name" + ], + "note": "Path built by dynamicEntityDefinitionsPath in packages/shared/src/lib/obp/dynamicEntitySpace.ts." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/dynamic-code-approval-config", + "source": "apps/api-manager/src/lib/server/dynamicCodeApproval.ts", + "needles": [ + "\"/obp/v7.0.0/management/dynamic-code-approval-config\"", + "obp_requests.get(DYNAMIC_CODE_APPROVAL_CONFIG_PATH" + ], + "reads": [ + "requires_approval", + "target_types", + "target_types[]", + "dynamic_code_execution_enabled", + "delete_requires_approval", + "request_ttl_hours", + "approval_role" + ], + "note": "The exported constant is used only in this file; loadDynamicCodeApprovalConfig is called by the dynamic-resource-docs create and help pages." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/api-manager/src/lib/server/dynamicEntities/definitions.ts", + "needles": [ + "dynamicEntityDefinitionsPath(bankId)" + ], + "reads": [ + "dynamic_entities", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name" + ], + "note": "findDynamicEntityDefinition returns the matching definition; the backend data routes read its entity_name, and the dynamic-entities pages (another chunk) read more of it." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/api-manager/src/lib/server/dynamicEntityWebhooks.ts", + "needles": [ + "dynamicEntityDefinitionsPath(spaceOf(bankId))" + ], + "reads": [ + "dynamic_entities", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].bank_id", + "dynamic_entities[].schema.properties" + ], + "note": "Reads each property's type under schema.properties to type webhook field conditions." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/api/glossary", + "source": "apps/api-manager/src/lib/server/glossaryCache.ts", + "needles": [ + "\"/obp/v5.1.0/api/glossary\"", + "obp_requests.get(GLOSSARY_PATH, accessToken)" + ], + "reads": [ + "glossary_items", + "glossary_items[].title", + "glossary_items[].description.markdown" + ], + "note": "Cached for 30 minutes; findGlossaryItem matches title, and the help pages and platformApps.ts render description.markdown." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/api/glossary", + "source": "apps/api-manager/src/lib/server/glossaryItems.ts", + "needles": [ + "\"/obp/v7.0.0/api/glossary\"", + "`${GLOSSARY_PATH}?${query}`" + ], + "reads": [ + "glossary_items", + "total_count", + "glossary_items[].title", + "glossary_items[].description.markdown", + "glossary_items[].overrides_static_item", + "glossary_items[].shadows_static_glossary_item", + "glossary_items[].glossary_item_id", + "glossary_items[].updated_at" + ], + "undocumented_fields": [ + "glossary_items[].glossary_item_id", + "glossary_items[].updated_at" + ], + "note": "Called with ?source=dynamic; the glossary-items list page keys rows by glossary_item_id and shows updated_at. The exported GLOSSARY_PATH also builds GET /obp/v7.0.0/api/glossary/TITLE at apps/api-manager/src/routes/(protected)/glossary-items/[title]/+page.server.ts (another chunk)." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/api-manager/src/lib/server/opey/opeyNotebook.ts", + "needles": [ + "const response = await obp_requests.get(", + "dynamicEntityDefinitionsPath(DYNAMIC_ENTITY_SYSTEM_SPACE_BANK_ID)" + ], + "reads": [ + "dynamic_entities", + "dynamic_entities[].entity_name" + ], + "note": "System space (SYS), with the application token at startup, to see whether the Opey notebook entity exists." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/api-manager/src/lib/server/opey/opeyNotebook.ts", + "needles": [ + "await obp_requests.post(", + "dynamicEntityDefinitionsPath(DYNAMIC_ENTITY_SYSTEM_SPACE_BANK_ID)" + ], + "reads": [], + "note": "Creates the Opey notebook entity definition in the system space (SYS) when it is missing." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/platform-apps", + "source": "apps/api-manager/src/lib/server/platformApps.ts", + "needles": [ + "\"/obp/v7.0.0/management/platform-apps\"" + ], + "reads": [ + "platform_apps", + "platform_apps[].consumer_id", + "platform_apps[].consumer_name", + "platform_apps[].label", + "platform_apps[].state", + "platform_apps[].version", + "platform_apps[].declared_at", + "platform_apps[].required_scopes", + "platform_apps[].required_scopes[].role_name", + "platform_apps[].required_scopes[].bank_id", + "platform_apps[].required_scopes[].needed_for", + "platform_apps[].required_scopes[].optional", + "platform_apps[].required_scopes[].held" + ], + "note": "Returned to routes/(protected)/consumers/platform-apps, whose page renders these fields." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis", + "source": "apps/api-manager/src/lib/services/domainApis.ts", + "needles": [ + "`/obp/v7.0.0/management/banks/${encodeURIComponent(spaceOf(bankId))}/domain-apis`", + "`/proxy${domainApisPath(bankId)}`" + ], + "reads": [], + "note": "The create page ignores the returned Domain API and navigates away." + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis/DOMAIN_API_ID", + "source": "apps/api-manager/src/lib/services/domainApis.ts", + "needles": [ + "`/obp/v7.0.0/management/banks/${encodeURIComponent(spaceOf(bankId))}/domain-apis`", + "`/proxy${domainApisPath(bankId, domainApiId)}`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis/DOMAIN_API_ID", + "source": "apps/api-manager/src/lib/services/domainApis.ts", + "needles": [ + "`/obp/v7.0.0/management/banks/${encodeURIComponent(spaceOf(bankId))}/domain-apis`", + "`/proxy${domainApisPath(bankId, domainApiId)}`" + ], + "reads": [], + "note": "The detail page ignores the returned Domain API." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks", + "source": "apps/api-manager/src/lib/services/dynamicEntityWebhooks.ts", + "needles": [ + "`/obp/v7.0.0/management/banks/${encodeURIComponent(spaceOf(bankId))}/dynamic-entities/${encodeURIComponent(dynamicEntityId)}/web-hooks`", + "send(\"POST\", webhooksPath(bankId, dynamicEntityId)" + ], + "reads": [ + "bank_id", + "dynamic_entity_id", + "webhook_id" + ], + "note": "The create page builds the new webhook's page link from these fields (webhookPageHref)." + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID", + "source": "apps/api-manager/src/lib/services/dynamicEntityWebhooks.ts", + "needles": [ + "`/obp/v7.0.0/management/banks/${encodeURIComponent(spaceOf(bankId))}/dynamic-entities/${encodeURIComponent(dynamicEntityId)}/web-hooks`", + "send(\"DELETE\", webhooksPath(bankId, dynamicEntityId, webhookId)" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID", + "source": "apps/api-manager/src/lib/services/dynamicEntityWebhooks.ts", + "needles": [ + "`/obp/v7.0.0/management/banks/${encodeURIComponent(spaceOf(bankId))}/dynamic-entities/${encodeURIComponent(dynamicEntityId)}/web-hooks`", + "send(\"PUT\", webhooksPath(bankId, dynamicEntityId, webhookId)" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID/deliveries", + "source": "apps/api-manager/src/lib/services/dynamicEntityWebhooks.ts", + "needles": [ + "`/obp/v7.0.0/management/banks/${encodeURIComponent(spaceOf(bankId))}/dynamic-entities/${encodeURIComponent(dynamicEntityId)}/web-hooks`", + "`${webhooksPath(bankId, dynamicEntityId, webhookId)}/deliveries?${query}`" + ], + "reads": [ + "deliveries" + ], + "note": "getDeliveries is exported but has no caller in the app at present; the webhook page loads deliveries server side instead." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID/deliveries/EVENT_ID/retry", + "source": "apps/api-manager/src/lib/services/dynamicEntityWebhooks.ts", + "needles": [ + "`/obp/v7.0.0/management/banks/${encodeURIComponent(spaceOf(bankId))}/dynamic-entities/${encodeURIComponent(dynamicEntityId)}/web-hooks`", + "`${webhooksPath(bankId, dynamicEntityId, webhookId)}/deliveries/${encodeURIComponent(eventId)}/retry`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID/test", + "source": "apps/api-manager/src/lib/services/dynamicEntityWebhooks.ts", + "needles": [ + "`/obp/v7.0.0/management/banks/${encodeURIComponent(spaceOf(bankId))}/dynamic-entities/${encodeURIComponent(dynamicEntityId)}/web-hooks`", + "`${webhooksPath(bankId, dynamicEntityId, webhookId)}/test`" + ], + "reads": [ + "event_id" + ], + "note": "The webhook page shows the queued delivery's event_id." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/api/glossary", + "source": "apps/api-manager/src/lib/services/glossaryItems.ts", + "needles": [ + "\"/proxy/obp/v7.0.0/api/glossary\"", + "isUpdate ? `${BASE}/${encodeURIComponent(title)}` : BASE" + ], + "reads": [], + "note": "saveGlossaryItem posts to BASE when creating; the create page ignores the result." + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/api/glossary/TITLE", + "source": "apps/api-manager/src/lib/services/glossaryItems.ts", + "needles": [ + "\"/proxy/obp/v7.0.0/api/glossary\"", + "fetch(`${BASE}/${encodeURIComponent(title)}`, { method: \"DELETE\"" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/api/glossary/TITLE", + "source": "apps/api-manager/src/lib/services/glossaryItems.ts", + "needles": [ + "\"/proxy/obp/v7.0.0/api/glossary\"", + "isUpdate ? `${BASE}/${encodeURIComponent(title)}` : BASE" + ], + "reads": [], + "note": "saveGlossaryItem puts to BASE/TITLE when updating; the page ignores the result." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/json-schema-validations", + "source": "apps/api-manager/src/lib/services/jsonSchemaValidations.ts", + "needles": [ + "\"/proxy/obp/v5.1.0/management/json-schema-validations\"", + "fetch(BASE, { credentials: \"include\" })" + ], + "reads": [ + "json_schema_validations" + ], + "note": "fetchJsonSchemaValidations is exported but has no caller in the app at present." + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "source": "apps/api-manager/src/lib/services/jsonSchemaValidations.ts", + "needles": [ + "\"/proxy/obp/v5.1.0/management/json-schema-validations\"", + "fetch(`${BASE}/${encodeURIComponent(operationId)}`, { method: \"DELETE\"" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "source": "apps/api-manager/src/lib/services/jsonSchemaValidations.ts", + "needles": [ + "\"/proxy/obp/v5.1.0/management/json-schema-validations\"", + "fetch(`${BASE}/${encodeURIComponent(operationId)}`, { credentials: \"include\" })" + ], + "reads": [], + "note": "fetchJsonSchemaValidation returns the response as is and has no caller in the app at present." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "source": "apps/api-manager/src/lib/services/jsonSchemaValidations.ts", + "needles": [ + "\"/proxy/obp/v5.1.0/management/json-schema-validations\"", + "`${BASE}/${encodeURIComponent(values.operation_id)}`" + ], + "reads": [], + "note": "POST when creating (isUpdate false); the create page ignores the result." + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "source": "apps/api-manager/src/lib/services/jsonSchemaValidations.ts", + "needles": [ + "\"/proxy/obp/v5.1.0/management/json-schema-validations\"", + "`${BASE}/${encodeURIComponent(values.operation_id)}`" + ], + "reads": [], + "note": "PUT when updating (isUpdate true); the page ignores the result." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/api-manager/src/lib/services/methodRoutings.ts", + "needles": [ + "\"/proxy/obp/v6.0.0/banks\"" + ], + "reads": [ + "banks", + "banks[].bank_id" + ], + "note": "Also accepts a bare array of banks." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/connector-method-names", + "source": "apps/api-manager/src/lib/services/methodRoutings.ts", + "needles": [ + "\"/proxy/obp/v6.0.0/system/connector-method-names\"" + ], + "reads": [ + "method_names|connector_method_names" + ], + "note": "Accepts a bare array, method_names or connector_method_names; the docs name connector_method_names." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/api-manager/src/lib/stores/currentBank.svelte.ts", + "needles": [ + "\"/proxy/obp/v6.0.0/banks\"" + ], + "reads": [ + "banks", + "banks[].bank_id", + "banks[].full_name|banks[].short_name" + ], + "note": "The store's banks are shown across the app as full_name, falling back to short_name (dynamic-entities system and diagnostics pages)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "source": "apps/api-manager/src/lib/stores/rolesCache.svelte.ts", + "needles": [ + "\"/proxy/obp/v6.0.0/roles\"" + ], + "reads": [ + "roles", + "roles[].role", + "roles[].requires_bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/abac-rules", + "source": "apps/api-manager/src/routes/(protected)/abac/rules/+page.server.ts", + "needles": [ + "\"/obp/v6.0.0/management/abac-rules\"" + ], + "reads": [ + "abac_rules[].abac_rule_id", + "abac_rules[].rule_name", + "abac_rules[].description", + "abac_rules[].rule_code", + "abac_rules[].policy", + "abac_rules[].is_active", + "abac_rules[].created_at" + ], + "undocumented_fields": [ + "abac_rules[].created_at" + ], + "note": "The load returns abac_rules (falling back to a top-level rules array or a bare array) and the page lists each rule; created_at is shown when present." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/abac-rules/ABAC_RULE_ID", + "source": "apps/api-manager/src/routes/(protected)/abac/rules/[rule_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/abac-rules/${ruleId}`" + ], + "reads": [ + "rule_name", + "rule_code", + "description", + "policy", + "is_active" + ], + "note": "The edit page pre-fills its form from the returned rule." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/abac-rules-schema", + "source": "apps/api-manager/src/routes/(protected)/abac/rules/[rule_id]/edit/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/management/abac-rules-schema\"" + ], + "reads": [ + "parameters[].name", + "parameters[].type", + "parameters[].required", + "parameters[].description", + "parameters[].category", + "object_types[].name", + "object_types[].description", + "object_types[].properties[].name", + "object_types[].properties[].type", + "object_types[].properties[].description", + "examples[].description", + "examples[].category", + "examples[].title", + "examples[].code", + "available_operators[]", + "notes[]" + ], + "undocumented_fields": [ + "examples[].category", + "examples[].title", + "examples[].code" + ], + "note": "Examples are grouped by category and inserted by their code; the docs describe examples with rule_name/rule_code/policy instead." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/abac-rules/validate", + "source": "apps/api-manager/src/routes/(protected)/abac/rules/[rule_id]/edit/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/management/abac-rules/validate\"" + ], + "reads": [ + "valid", + "message" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/abac-rules/ABAC_RULE_ID", + "source": "apps/api-manager/src/routes/(protected)/abac/rules/[rule_id]/test/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/abac-rules/${ruleId}`" + ], + "reads": [ + "rule_name", + "rule_code", + "description", + "is_active" + ], + "note": "The test page shows the rule and pre-fills the rule code." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/account-directory", + "source": "apps/api-manager/src/routes/(protected)/account-access/account-directory/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/account-directory?limit=200`" + ], + "reads": [ + "accounts[].account_id", + "accounts[].bank_id", + "accounts[].label", + "accounts[].account_number", + "accounts[].account_type", + "accounts[].branch_id", + "accounts[].account_routings[].scheme", + "accounts[].account_routings[].address" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts", + "source": "apps/api-manager/src/routes/(protected)/account-access/accounts/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/accounts`" + ], + "reads": [ + "accounts[].id|accounts[].account_id", + "accounts[].label", + "accounts[].views_available", + "accounts[].views_available[].id|accounts[].views_available[].view_id" + ], + "note": "The page counts views_available and links to the first view; it reads id before account_id and id before view_id." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/products/PRODUCT_CODE/attribute", + "source": "apps/api-manager/src/routes/(protected)/account-access/accounts/[bank_id]/[account_id]/[view_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/banks/${encodeURIComponent(bankId)}/accounts/${encodeURIComponent(accountId)}/products/${encodeURIComponent(productCode)}/attribute`" + ], + "reads": [ + "name", + "product_code", + "value", + "type" + ], + "note": "The created attribute is appended to account_attributes and rendered like the others." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account", + "source": "apps/api-manager/src/routes/(protected)/account-access/accounts/[bank_id]/[account_id]/[view_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/accounts/${encodeURIComponent(accountId)}/${encodeURIComponent(viewId)}/account`" + ], + "reads": [ + "id", + "bank_id", + "number", + "label", + "account_id", + "product_code", + "type", + "balance.amount", + "balance.currency", + "owners[].display_name", + "owners[].provider", + "account_routings[].scheme", + "account_routings[].address", + "account_attributes[].name", + "account_attributes[].product_code", + "account_attributes[].value", + "account_attributes[].type", + "tags[].value", + "views_available[].id|views_available[].view_id", + "views_available[].is_system", + "views_available[].is_public" + ], + "undocumented_fields": [ + "account_id", + "type" + ], + "note": "The page shows the account, uses product_code for the add-attribute call, and fetches users-with-access for each entry of views_available; account_id is a fallback for the label and the view id is read as id before view_id." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/has-account-access", + "source": "apps/api-manager/src/routes/(protected)/account-access/accounts/[bank_id]/[account_id]/[view_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/accounts/${encodeURIComponent(accountId)}/views/${encodeURIComponent(viewId)}/has-account-access`" + ], + "reads": [ + "has_account_access", + "access_source", + "abac_rule_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/users-with-access", + "source": "apps/api-manager/src/routes/(protected)/account-access/accounts/[bank_id]/[account_id]/[view_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/accounts/${encodeURIComponent(accountId)}/views/${encodeURIComponent(vid)}/users-with-access`" + ], + "reads": [ + "users[].username", + "users[].user_id", + "users[].access_source" + ], + "note": "Called once per view in views_available; users are grouped as direct or ABAC by access_source." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/abac-rules", + "source": "apps/api-manager/src/routes/(protected)/account-access/accounts/[bank_id]/[account_id]/[view_id]/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/management/abac-rules\"" + ], + "reads": [ + "abac_rules[].abac_rule_id", + "abac_rules[].rule_name", + "abac_rules[].description", + "abac_rules[].rule_code", + "abac_rules[].policy", + "abac_rules[].is_active" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/TARGET_VIEW_ID/users/TARGET_USER_ID/account-access-trace", + "source": "apps/api-manager/src/routes/(protected)/account-access/accounts/[bank_id]/[account_id]/[view_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v7.0.0/banks/${encodeURIComponent(bankId)}/accounts/${encodeURIComponent(accountId)}/views/${encodeURIComponent(targetView)}/users/${encodeURIComponent(targetUser)}/account-access-trace`" + ], + "reads": [ + "has_access", + "access_source", + "account_access_trace.has_account_access_for_view", + "account_access_trace.account_access_view_ids", + "entitlement_trace.has_can_execute_abac_rule", + "abac_trace.policy", + "abac_trace.allow_abac_account_access", + "abac_trace.standalone_abac_result", + "abac_trace.rules_evaluated[].rule_name", + "abac_trace.rules_evaluated[].result", + "abac_trace.rules_evaluated[].is_active", + "abac_trace.rules_evaluated[].error_message" + ], + "undocumented_fields": [ + "abac_trace.rules_evaluated[].rule_name", + "abac_trace.rules_evaluated[].result", + "abac_trace.rules_evaluated[].is_active", + "abac_trace.rules_evaluated[].error_message" + ], + "note": "The trace panel renders these fields and also shows the whole response as JSON; the docs list rules_evaluated without item fields." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties", + "source": "apps/api-manager/src/routes/(protected)/account-access/accounts/[bank_id]/[account_id]/[view_id]/counterparties/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/accounts/${encodeURIComponent(accountId)}/${encodeURIComponent(viewId)}/counterparties`" + ], + "reads": [ + "counterparties[].counterparty_id", + "counterparties[].name", + "counterparties[].description", + "counterparties[].currency", + "counterparties[].is_beneficiary", + "counterparties[].other_account_routing_scheme", + "counterparties[].other_account_routing_address", + "counterparties[].other_bank_routing_scheme", + "counterparties[].other_bank_routing_address" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID", + "source": "apps/api-manager/src/routes/(protected)/account-access/accounts/[bank_id]/[account_id]/[view_id]/counterparties/[counterparty_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/banks/${encodeURIComponent(bankId)}/accounts/${encodeURIComponent(accountId)}/${encodeURIComponent(viewId)}/counterparties/${encodeURIComponent(counterpartyId)}`" + ], + "reads": [ + "name", + "counterparty_id", + "created_by_user_id", + "currency", + "description", + "is_beneficiary", + "this_bank_id", + "this_account_id", + "this_view_id", + "other_account_routing_scheme", + "other_account_routing_address", + "other_account_secondary_routing_scheme", + "other_account_secondary_routing_address", + "other_bank_routing_scheme", + "other_bank_routing_address", + "other_branch_routing_scheme", + "other_branch_routing_address", + "bespoke[].key", + "bespoke[].value", + "metadata.public_alias", + "metadata.private_alias", + "metadata.more_info", + "metadata.url", + "metadata.image_url", + "metadata.open_corporates_url", + "metadata.corporate_location.latitude", + "metadata.corporate_location.longitude", + "metadata.physical_location.latitude", + "metadata.physical_location.longitude" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions", + "source": "apps/api-manager/src/routes/(protected)/account-access/accounts/[bank_id]/[account_id]/[view_id]/transactions/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/accounts/${encodeURIComponent(accountId)}/${encodeURIComponent(viewId)}/transactions?limit=50&offset=0&sort_direction=ASC`" + ], + "reads": [ + "transactions[].details.value.amount", + "transactions[].details.value.currency", + "transactions[].details.new_balance.amount", + "transactions[].details.new_balance.currency", + "transactions[].details.completed", + "transactions[].details.description", + "transactions[].other_account.holder.name", + "transactions[].other_account.metadata.public_alias" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/custom-views", + "source": "apps/api-manager/src/routes/(protected)/account-access/custom-views/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/custom-views`" + ], + "reads": [ + "views[].view_id", + "views[].bank_id", + "views[].account_id", + "views[].description" + ], + "undocumented_fields": [ + "views[].view_id", + "views[].bank_id", + "views[].account_id", + "views[].description" + ], + "note": "The page lists and filters the views; the docs describe views[] with no item fields." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID", + "source": "apps/api-manager/src/routes/(protected)/account-access/custom-views/[bank_id]/[account_id]/[view_id]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/banks/${bank_id}/accounts/${account_id}/views/${view_id}`" + ], + "reads": [ + "short_name", + "description", + "view_id", + "is_public", + "alias", + "hide_metadata_if_alias_used", + "allowed_actions[]" + ], + "undocumented_fields": [ + "short_name" + ], + "note": "The detail page uses short_name as the title; the docs name the field view_name." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/view-permissions", + "source": "apps/api-manager/src/routes/(protected)/account-access/custom-views/create/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/view-permissions`" + ], + "reads": [ + "permissions[].category", + "permissions[].permission" + ], + "note": "Permissions are grouped by category for the checkboxes." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/account-directory", + "source": "apps/api-manager/src/routes/(protected)/account-access/custom-views/create/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/account-directory?limit=20`" + ], + "reads": [ + "accounts[].account_id", + "accounts[].label", + "accounts[].account_number" + ], + "note": "Used for the account search dropdown." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/system-views", + "source": "apps/api-manager/src/routes/(protected)/account-access/system-views/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/system-views`" + ], + "reads": [ + "views[].short_name", + "views[].description", + "views[].view_id", + "views[].is_public" + ], + "undocumented_fields": [ + "views[].short_name" + ], + "note": "The page filters by short_name; the docs name the field view_name." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/system-views/SYS_VIEW_ID", + "source": "apps/api-manager/src/routes/(protected)/account-access/system-views/[view_id]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/system-views/${view_id}`" + ], + "reads": [ + "short_name", + "description", + "view_id", + "is_public", + "alias", + "hide_metadata_if_alias_used", + "allowed_actions[]", + "can_grant_access_to_views[]", + "can_revoke_access_to_views[]" + ], + "undocumented_fields": [ + "short_name" + ], + "note": "The detail page uses short_name as the title; the docs name the field view_name." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/system-views/SYS_VIEW_ID", + "source": "apps/api-manager/src/routes/(protected)/account-access/system-views/[view_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/system-views/${view_id}`" + ], + "reads": [ + "short_name", + "description", + "view_id", + "is_public", + "alias", + "hide_metadata_if_alias_used", + "allowed_actions[]", + "can_grant_access_to_views[]", + "can_revoke_access_to_views[]", + "metadata_view" + ], + "undocumented_fields": [ + "short_name" + ], + "note": "The edit form is pre-filled from the view; short_name is the docs' view_name." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/view-permissions", + "source": "apps/api-manager/src/routes/(protected)/account-access/system-views/[view_id]/edit/+page.server.ts", + "needles": [ + "\"/obp/v6.0.0/management/view-permissions\"" + ], + "reads": [ + "permissions[].permission|permissions[].name", + "permissions[].category" + ], + "note": "Each permission may also be a plain string or carry name instead of permission." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/view-permissions", + "source": "apps/api-manager/src/routes/(protected)/account-access/system-views/create/+page.server.ts", + "needles": [ + "\"/obp/v6.0.0/management/view-permissions\"" + ], + "reads": [ + "permissions[].permission|permissions[].name", + "permissions[].category" + ], + "note": "Each permission may also be a plain string or carry name instead of permission." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/view-permissions", + "source": "apps/api-manager/src/routes/(protected)/account-access/view-permissions/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/view-permissions`" + ], + "reads": [ + "permissions[].category", + "permissions[].permission" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/metrics", + "source": "apps/api-manager/src/routes/(protected)/aggregate-metrics-live/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/metrics?${queryParams.toString()}`" + ], + "reads": [ + "metrics" + ], + "note": "The load only counts the metrics array and returns it; the page never renders it (it loads its table from /backend/aggregate-metrics)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections", + "source": "apps/api-manager/src/routes/(protected)/api-collections/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/my/api-collections`" + ], + "reads": [ + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description", + "api_collections[].is_sharable" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints", + "source": "apps/api-manager/src/routes/(protected)/api-collections/[collection_id]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/my/api-collection-ids/${collection_id}/api-collection-endpoints`" + ], + "reads": [ + "api_collection_endpoints[].api_collection_endpoint_id", + "api_collection_endpoints[].operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "source": "apps/api-manager/src/routes/(protected)/api-collections/[collection_id]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/my/api-collections/${collection_id}`" + ], + "reads": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable", + "user_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoint-ids/API_COLLECTION_ENDPOINT_ID", + "source": "apps/api-manager/src/routes/(protected)/api-collections/[collection_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/my/api-collection-ids/${collection.api_collection_id}/api-collection-endpoint-ids/${endpointId}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "source": "apps/api-manager/src/routes/(protected)/api-collections/[collection_id]/delete/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/my/api-collections/${collection_id}`" + ], + "reads": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "source": "apps/api-manager/src/routes/(protected)/api-collections/[collection_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/my/api-collections/${collection_id}`" + ], + "reads": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/api-manager/src/routes/(protected)/app-studio/help/+page.server.ts", + "needles": [ + "dynamicEntityDefinitionsPath(DYNAMIC_ENTITY_SYSTEM_SPACE_BANK_ID)" + ], + "reads": [ + "dynamic_entities[].entity_name", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].record_count" + ], + "note": "The path comes from dynamicEntityDefinitionsPath in packages/shared (BANK_ID is SYS here); the page shows whether the portal page entity exists and its record count." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/consumers", + "source": "apps/api-manager/src/routes/(protected)/app-studio/help/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/management/consumers?limit=500&offset=0&from_date=1970-01-01T00:00:00.000Z\"" + ], + "reads": [ + "consumers[].consumer_id", + "consumers[].app_name", + "consumers[].developer_email", + "consumers[].enabled" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/platform-apps", + "source": "apps/api-manager/src/routes/(protected)/app-studio/help/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/management/platform-apps\"" + ], + "reads": [ + "platform_apps[].consumer_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/consumers/CONSUMER_ID/scopes", + "source": "apps/api-manager/src/routes/(protected)/app-studio/help/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/consumers/${encodeURIComponent(consumerId)}/scopes`" + ], + "reads": [ + "list[].role_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/api-manager/src/routes/(protected)/app-studio/starters.ts", + "needles": [ + "'/obp/v6.0.0/banks'" + ], + "reads": [ + "banks[].full_name", + "banks[].bank_id" + ], + "note": "Source of the default starter app; it runs in the App Studio preview and calls OBP-API through the obp.get bridge and the API Manager proxy." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/api-manager/src/routes/(protected)/banks/+page.server.ts", + "needles": [ + "\"/obp/v6.0.0/banks\"" + ], + "reads": [ + "banks[].full_name", + "banks[].bank_id", + "banks[].bank_code", + "banks[].logo", + "banks[].website", + "banks[].bank_routings" + ], + "note": "Sorted by full_name; the page only counts bank_routings." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID", + "source": "apps/api-manager/src/routes/(protected)/banks/[bankId]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/banks/${bankId}`" + ], + "reads": [ + "bank_id", + "full_name", + "bank_code", + "logo", + "website", + "bank_routings[].scheme", + "bank_routings[].address", + "attributes[].name|attributes[].bank_attribute_name", + "attributes[].value|attributes[].bank_attribute_value", + "bank_attributes" + ], + "undocumented_fields": [ + "bank_attributes" + ], + "note": "The page also counts bank_attributes for its summary and falls back to bank_attribute_name/bank_attribute_value for each attribute." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/attribute", + "source": "apps/api-manager/src/routes/(protected)/banks/[bankId]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${bank.bank_id}/attribute`" + ], + "reads": [], + "note": "On success the page reloads its data; the response body is not read." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks", + "source": "apps/api-manager/src/routes/(protected)/banks/create/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/banks\"" + ], + "reads": [ + "bank_id" + ], + "note": "The created bank_id is checked and used to navigate to the new bank." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/currencies", + "source": "apps/api-manager/src/routes/(protected)/banks/fx-rates/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/currencies`" + ], + "reads": [ + "currencies[].alphanumeric_code" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/fx/FROM_CURRENCY_CODE/TO_CURRENCY_CODE", + "source": "apps/api-manager/src/routes/(protected)/banks/fx-rates/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(currentBank.bankId)}/fx/${encodeURIComponent(fromCurrency)}/${encodeURIComponent(toCurrency)}`" + ], + "reads": [ + "conversion_value", + "inverse_conversion_value", + "from_currency_code", + "to_currency_code", + "effective_date" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/[chat_room_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/chat-rooms/${encodeURIComponent(chatRoomId)}${bankParam}`" + ], + "reads": [ + "is_open_room" + ], + "note": "The system path is used for every level; a bank room adds bank_id as a query parameter." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/[chat_room_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/chat-rooms/${encodeURIComponent(chatRoomId)}/participants?user_id=${encodeURIComponent(userId)}&level=${level}${bankParam}`" + ], + "reads": [], + "undocumented_endpoint": "OBP-API documents removing a participant only as DELETE /obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants/USER_ID (user id in the path, also in v7.0.0); the code sends it as a query parameter instead.", + "note": "The user id is sent as the user_id query parameter." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/[chat_room_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/chat-rooms/${encodeURIComponent(chatRoomId)}/participants?level=${level}${bankParam}`" + ], + "reads": [ + "participants[].participant_id", + "participants[].user_id", + "participants[].username", + "participants[].provider", + "participants[].consumer_id", + "participants[].consumer_name", + "participants[].is_muted", + "participants[].joined_at", + "participants[].permissions[]" + ], + "note": "The system path is used for every level; level and bank_id go in the query string." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/joining-key", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/[chat_room_id]/add-participant/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/chat-rooms/${encodeURIComponent(chatRoomId)}/joining-key`" + ], + "reads": [], + "note": "Bank branch of a ternary; the room is fetched again afterwards instead of reading the response." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/[chat_room_id]/add-participant/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/chat-rooms/${encodeURIComponent(chatRoomId)}${bankParam}`" + ], + "reads": [ + "joining_key", + "is_open_room" + ], + "note": "The joining key builds the portal join link and can be copied." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/joining-key", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/[chat_room_id]/add-participant/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/chat-rooms/${encodeURIComponent(chatRoomId)}/joining-key`" + ], + "reads": [], + "note": "System branch of a ternary; the room is fetched again afterwards instead of reading the response." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/[chat_room_id]/add-participant/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/chat-rooms/${encodeURIComponent(chatRoomId)}/participants?level=${level}${bankParam}`" + ], + "reads": [], + "note": "The system path is used for every level; level and bank_id go in the query string. The response body is not read." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/open-room", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/[chat_room_id]/edit/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/chat-rooms/${encodeURIComponent(chatRoomId)}/open-room`" + ], + "reads": [ + "is_open_room", + "name", + "description" + ], + "note": "Bank branch of a ternary sent with method PUT (the script guessed GET); the updated room replaces the shown one." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/[chat_room_id]/edit/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/chat-rooms/${encodeURIComponent(chatRoomId)}${bankParam}`" + ], + "reads": [ + "is_open_room", + "name", + "description" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/open-room", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/[chat_room_id]/edit/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/chat-rooms/${encodeURIComponent(chatRoomId)}/open-room`" + ], + "reads": [ + "is_open_room", + "name", + "description" + ], + "note": "System branch of a ternary sent with method PUT (the script guessed GET); the updated room replaces the shown one." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/bank/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/chat-rooms`" + ], + "reads": [ + "chat_rooms[].chat_room_id", + "chat_rooms[].name", + "chat_rooms[].description", + "chat_rooms[].created_at", + "chat_rooms[].created_by_username|chat_rooms[].created_by", + "chat_rooms[].created_by_provider", + "chat_rooms[].is_archived", + "chat_rooms[].is_open_room", + "chat_rooms[].joining_key" + ], + "note": "Sorted by created_at; created_by is a fallback for the creator name and is also searched." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/bank/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(currentBank.bankId)}/chat-rooms`" + ], + "reads": [], + "note": "The list is fetched again afterwards; the response body is not read." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/bank/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(currentBank.bankId)}/chat-rooms/${encodeURIComponent(chatRoomId)}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/system/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/chat-rooms`" + ], + "reads": [ + "chat_rooms[].chat_room_id", + "chat_rooms[].name", + "chat_rooms[].description", + "chat_rooms[].created_at", + "chat_rooms[].created_by_username|chat_rooms[].created_by", + "chat_rooms[].created_by_provider", + "chat_rooms[].is_archived", + "chat_rooms[].is_open_room", + "chat_rooms[].joining_key" + ], + "note": "Sorted by created_at; created_by is a fallback for the creator name and is also searched." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/system/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/chat-rooms`" + ], + "reads": [], + "note": "The created room is returned in the action result but the page does not read it." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "source": "apps/api-manager/src/routes/(protected)/chat-rooms/system/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/chat-rooms/${chatRoomId}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/connector/metrics/counts", + "source": "apps/api-manager/src/routes/(protected)/connector-counts/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/management/connector/metrics/counts`" + ], + "reads": [ + "connector_counts[].connector_name", + "connector_counts[].method_name", + "connector_counts[].per_hour_outbound_count", + "connector_counts[].per_hour_inbound_success_count", + "connector_counts[].per_hour_inbound_failure_count", + "connector_counts[].ttl_seconds" + ], + "note": "The raw response is also shown as JSON." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/connector/traces", + "source": "apps/api-manager/src/routes/(protected)/connector-traces/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/management/connector/traces?${currentQueryString}`" + ], + "reads": [ + "correlation_id", + "connector_traces[].connector_trace_id", + "connector_traces[].correlation_id", + "connector_traces[].date", + "connector_traces[].duration", + "connector_traces[].bank_id", + "connector_traces[].connector_name", + "connector_traces[].function_name", + "connector_traces[].http_verb", + "connector_traces[].url", + "connector_traces[].user_id", + "connector_traces[].is_successful", + "connector_traces[].inbound_message", + "connector_traces[].outbound_message" + ], + "undocumented_fields": [ + "correlation_id" + ], + "note": "A top-level correlation_id is read for the status line; the raw response is also shown as JSON." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/consumers", + "source": "apps/api-manager/src/routes/(protected)/consumers/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/management/consumers?limit=500&offset=0&from_date=${encodeURIComponent(fromDate)}${toDateSuffix}`" + ], + "reads": [ + "consumers[].consumer_id", + "consumers[].app_name", + "consumers[].app_type", + "consumers[].company", + "consumers[].created", + "consumers[].description", + "consumers[].developer_email", + "consumers[].enabled", + "consumers[].redirect_url" + ], + "note": "consumer_key is stripped before the list reaches the browser; the list is sorted by created." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/metrics/consumer-last-calls", + "source": "apps/api-manager/src/routes/(protected)/consumers/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/management/metrics/consumer-last-calls\"," + ], + "reads": [ + "tracked_since", + "consumer_last_calls[].consumer_id", + "consumer_last_calls[].last_call_at" + ], + "note": "Only requested when the user has CanReadMetrics." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/banks`" + ], + "reads": [ + "banks[].bank_id", + "banks[].short_name" + ], + "undocumented_fields": [ + "banks[].short_name" + ], + "note": "The load maps banks to bank_id and short_name (falling back to bank_id), but the page never renders the list." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/consumers/CONSUMER_ID/scope/SCOPE_ID", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/consumers/${consumerId}/scope/${scope_id}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/consumers/CONSUMER_ID/scopes", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/consumers/${consumerId}/scopes`" + ], + "reads": [ + "list[].scope_id", + "list[].role_name", + "list[].bank_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/consumers/CONSUMER_ID/scopes", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/consumers/${consumerId}/scopes`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/consumers/current", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/consumers/current`" + ], + "reads": [ + "consumer_id" + ], + "note": "Compared with the page's consumer id to flag the current consumer." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/active-rate-limits", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}/active-rate-limits`" + ], + "reads": [ + "active_per_second_rate_limit", + "active_per_minute_rate_limit", + "active_per_hour_rate_limit", + "active_per_day_rate_limit", + "active_per_week_rate_limit", + "active_per_month_rate_limit" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/rate-limiting", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/rate-limiting`" + ], + "reads": [ + "enabled", + "is_active", + "service_available", + "technology" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/roles`" + ], + "reads": [ + "roles[].role", + "roles[].requires_bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/consumers/CONSUMER_ID", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/management/consumers/${consumerId}`" + ], + "reads": [ + "consumer_id", + "app_name", + "app_type", + "company", + "created", + "description", + "developer_email", + "enabled", + "logo_url", + "redirect_url", + "certificate_pem", + "call_counters.per_second.calls_made", + "call_counters.per_second.reset_in_seconds", + "call_counters.per_second.status", + "call_counters.per_minute.calls_made", + "call_counters.per_minute.reset_in_seconds", + "call_counters.per_minute.status", + "call_counters.per_hour.calls_made", + "call_counters.per_hour.reset_in_seconds", + "call_counters.per_hour.status", + "call_counters.per_day.calls_made", + "call_counters.per_day.reset_in_seconds", + "call_counters.per_day.status", + "call_counters.per_week.calls_made", + "call_counters.per_week.reset_in_seconds", + "call_counters.per_week.status", + "call_counters.per_month.calls_made", + "call_counters.per_month.reset_in_seconds", + "call_counters.per_month.status" + ], + "note": "consumer_key is stripped before the consumer reaches the browser." + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/certificate", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/management/consumers/${consumerId}/consumer/certificate`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/logo_url", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/management/consumers/${consumerId}/consumer/logo_url`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/name", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/management/consumers/${consumerId}/consumer/name`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/redirect_url", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/management/consumers/${consumerId}/consumer/redirect_url`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}`" + ], + "reads": [ + "consumer_id", + "app_name", + "app_type", + "enabled" + ], + "note": "enabled decides whether call-counters is requested." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/active-rate-limits", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}/active-rate-limits`" + ], + "reads": [ + "active_at_date", + "active_per_second_rate_limit", + "active_per_minute_rate_limit", + "active_per_hour_rate_limit", + "active_per_day_rate_limit", + "active_per_week_rate_limit", + "active_per_month_rate_limit" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/call-counters", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}/call-counters`" + ], + "reads": [ + "per_second.calls_made", + "per_minute.calls_made", + "per_hour.calls_made", + "per_day.calls_made", + "per_week.calls_made", + "per_month.calls_made" + ], + "note": "Only requested when the consumer is enabled." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}/consumer/rate-limits`" + ], + "reads": [ + "limits[].rate_limiting_id", + "limits[].from_date", + "limits[].to_date", + "limits[].per_second_call_limit", + "limits[].per_minute_call_limit", + "limits[].per_hour_call_limit", + "limits[].per_day_call_limit", + "limits[].per_week_call_limit", + "limits[].per_month_call_limit" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/rate-limiting", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/rate-limiting`" + ], + "reads": [ + "enabled", + "is_active", + "service_available", + "technology" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/[rate_limiting_id]/delete/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}`" + ], + "reads": [ + "consumer_id", + "app_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/[rate_limiting_id]/delete/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}/consumer/rate-limits`" + ], + "reads": [ + "limits[].rate_limiting_id", + "limits[].from_date", + "limits[].to_date", + "limits[].per_second_call_limit", + "limits[].per_minute_call_limit", + "limits[].per_hour_call_limit", + "limits[].per_day_call_limit", + "limits[].per_week_call_limit", + "limits[].per_month_call_limit" + ], + "note": "The rate limit with the page's rate_limiting_id is picked from the list." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits/RATE_LIMITING_ID", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/[rate_limiting_id]/delete/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}/consumer/rate-limits/${rateLimitingId}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/[rate_limiting_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}`" + ], + "reads": [ + "consumer_id", + "app_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/[rate_limiting_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}/consumer/rate-limits`" + ], + "reads": [ + "limits[].rate_limiting_id", + "limits[].from_date", + "limits[].to_date", + "limits[].per_second_call_limit", + "limits[].per_minute_call_limit", + "limits[].per_hour_call_limit", + "limits[].per_day_call_limit", + "limits[].per_week_call_limit", + "limits[].per_month_call_limit" + ], + "note": "The rate limit with the page's rate_limiting_id is picked from the list." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits/RATE_LIMITING_ID", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/[rate_limiting_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}/consumer/rate-limits/${rateLimitingId}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/create/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}`" + ], + "reads": [ + "consumer_id", + "app_name" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits", + "source": "apps/api-manager/src/routes/(protected)/consumers/[consumer_id]/rate-limits/create/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/consumers/${consumerId}/consumer/rate-limits`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/consumers/CONSUMER_ID/scopes", + "source": "apps/api-manager/src/routes/(protected)/consumers/platform-apps/+page.svelte", + "needles": [ + "`/proxy/obp/v7.0.0/consumers/${encodeURIComponent(app.consumer_id)}/scopes`" + ], + "reads": [], + "note": "Sent through the local call() helper with method POST." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/platform-apps", + "source": "apps/api-manager/src/routes/(protected)/consumers/platform-apps/+page.svelte", + "needles": [ + "\"/proxy/obp/v7.0.0/management/platform-apps\"" + ], + "reads": [], + "note": "Sent through the local call() helper with method POST; on success the page data is reloaded." + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/platform-apps/CONSUMER_ID", + "source": "apps/api-manager/src/routes/(protected)/consumers/platform-apps/+page.svelte", + "needles": [ + "`/proxy/obp/v7.0.0/management/platform-apps/${encodeURIComponent(app.consumer_id)}`" + ], + "reads": [], + "note": "Sent through the local call() helper with method DELETE." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/attribute", + "source": "apps/api-manager/src/routes/(protected)/customers/[bank_id]/[customer_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/banks/${encodeURIComponent(bankId)}/customers/${encodeURIComponent(customerId)}/attribute`" + ], + "reads": [ + "customer_attribute_id", + "name", + "type", + "value" + ], + "note": "The created attribute is appended to the customer's attribute list and rendered there." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID", + "source": "apps/api-manager/src/routes/(protected)/customers/[bank_id]/[customer_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/customers/${encodeURIComponent(customerId)}`" + ], + "reads": [ + "bank_id", + "branch_id", + "credit_limit.amount", + "credit_limit.currency", + "credit_rating.rating", + "credit_rating.source", + "customer_attributes", + "customer_attributes[].customer_attribute_id", + "customer_attributes[].name", + "customer_attributes[].type", + "customer_attributes[].value", + "customer_id", + "customer_number", + "customer_type", + "date_of_birth", + "dependants", + "dob_of_dependants", + "email", + "employment_status", + "highest_education_attained", + "kyc_status", + "last_ok_date", + "legal_name", + "mobile_phone_number", + "name_suffix", + "parent_customer_id", + "relationship_status", + "title" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/retail-customers", + "source": "apps/api-manager/src/routes/(protected)/customers/account-links/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/retail-customers?limit=200`" + ], + "reads": [ + "customers", + "customers[].customer_id", + "customers[].customer_number", + "customers[].legal_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/corporate-customers", + "source": "apps/api-manager/src/routes/(protected)/customers/corporate/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/corporate-customers?limit=200`" + ], + "reads": [ + "customers", + "customers[].bank_id", + "customers[].customer_id", + "customers[].customer_number", + "customers[].customer_type", + "customers[].email", + "customers[].kyc_status", + "customers[].legal_name", + "customers[].mobile_phone_number" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links/customers/CUSTOMER_ID", + "source": "apps/api-manager/src/routes/(protected)/customers/graph/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/banks/${encodeURIComponent(bankId)}/user_customer_links/customers/${encodeURIComponent(customerId)}`" + ], + "reads": [ + "user_customer_links", + "user_customer_links[].is_active", + "user_customer_links[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/owner/account", + "source": "apps/api-manager/src/routes/(protected)/customers/graph/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(accountNode.bank_id)}/accounts/${encodeURIComponent(accountNode.account_id)}/owner/account`" + ], + "reads": [ + "account_routings", + "account_routings[].address" + ], + "note": "The view is the literal owner view; only the first routing address is used as the account label." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/owner/transactions", + "source": "apps/api-manager/src/routes/(protected)/customers/graph/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(node.bank_id)}/accounts/${encodeURIComponent(node.account_id)}/owner/transactions?limit=10&sort_direction=DESC`" + ], + "reads": [ + "transactions", + "transactions[].transaction_id", + "transactions[].details", + "transactions[].details.value.amount|transactions[].details.amount", + "transactions[].details.value.currency|transactions[].details.currency", + "transactions[].details.completed", + "transactions[].details.description", + "transactions[].other_account", + "transactions[].other_account.account_id", + "transactions[].other_account.bank_id", + "transactions[].other_account.account_routings" + ], + "note": "The view is the literal owner view; amount and currency fall back to details.amount and details.currency, which OBP-API does not return." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers", + "source": "apps/api-manager/src/routes/(protected)/customers/graph/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/customers?limit=200`" + ], + "reads": [ + "customers", + "customers[].bank_id", + "customers[].customer_id", + "customers[].customer_number", + "customers[].legal_name", + "customers[].parent_customer_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID/children", + "source": "apps/api-manager/src/routes/(protected)/customers/graph/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/customers/${encodeURIComponent(customerId)}/children`" + ], + "reads": [ + "customers", + "customers[].bank_id", + "customers[].customer_id", + "customers[].legal_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user-id/USER_ID", + "source": "apps/api-manager/src/routes/(protected)/customers/graph/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/users/user-id/${encodeURIComponent(l.user_id)}`" + ], + "reads": [ + "email", + "username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/retail-customers", + "source": "apps/api-manager/src/routes/(protected)/customers/individual/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/retail-customers?limit=200`" + ], + "reads": [ + "customers", + "customers[].bank_id", + "customers[].customer_id", + "customers[].customer_number", + "customers[].date_of_birth", + "customers[].email", + "customers[].kyc_status", + "customers[].legal_name", + "customers[].mobile_phone_number" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/system/diagnostics/deployment", + "source": "apps/api-manager/src/routes/(protected)/deployment-checks/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/management/system/diagnostics/deployment\"" + ], + "reads": [ + "api_instance_id", + "checked_at", + "checks", + "checks[].area", + "checks[].basis", + "checks[].evidence", + "checks[].evidence[].name", + "checks[].evidence[].value", + "checks[].id", + "checks[].message", + "checks[].props", + "checks[].props[]", + "checks[].status", + "checks[].title", + "errors", + "warnings", + "window_minutes" + ], + "note": "The response is returned to +page.svelte, which renders the fields listed." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis", + "source": "apps/api-manager/src/routes/(protected)/domain-apis/+page.server.ts", + "needles": [ + "obp_requests.get(domainApisPath(bankId), token)" + ], + "reads": [ + "domain_apis", + "domain_apis[].bank_id", + "domain_apis[].base_path", + "domain_apis[].description", + "domain_apis[].domain_api_id", + "domain_apis[].openapi_url", + "domain_apis[].title", + "domain_apis[].url", + "domain_apis[].version" + ], + "note": "The path is built by domainApisPath in apps/api-manager/src/lib/services/domainApis.ts; the list is rendered by +page.svelte." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis/DOMAIN_API_ID", + "source": "apps/api-manager/src/routes/(protected)/domain-apis/[bank_id]/[domain_api_id]/+page.server.ts", + "needles": [ + "obp_requests.get(domainApisPath(params.bank_id, params.domain_api_id), token)" + ], + "reads": [ + "bank_id", + "base_path", + "created_at", + "created_by_user_id", + "description", + "domain_api_id", + "is_publicly_discoverable", + "openapi_url", + "title", + "updated_at", + "url", + "version" + ], + "note": "The path is built by domainApisPath in apps/api-manager/src/lib/services/domainApis.ts; the object is rendered by +page.svelte." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/resource-docs/v7.0.0/obp", + "source": "apps/api-manager/src/routes/(protected)/domain-apis/help/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/resource-docs/v7.0.0/obp?functions=${FUNCTIONS.join(\",\")}`" + ], + "reads": [ + "resource_docs", + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].roles", + "resource_docs[].roles[].role" + ], + "undocumented_fields": [ + "resource_docs", + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].roles", + "resource_docs[].roles[].role" + ], + "note": "The resource docs response schema is not described in the docs field list, so every read is listed as undocumented." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/bank/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/management/banks/${bankId}/dynamic-endpoints`" + ], + "reads": [ + "dynamic_endpoints", + "dynamic_endpoints[].dynamic_endpoint_id", + "dynamic_endpoints[].user_id", + "dynamic_endpoints[].swagger_string", + "dynamic_endpoints[].swagger_string.paths" + ], + "note": "swagger_string is the stored Swagger document: the code walks its paths map (dynamic path and method keys) for summary and operationId." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/bank/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/management/banks/${selectedBankId}/dynamic-endpoints/${endpointId}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/bank/[bank_id]/[id]/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/management/banks/${bank_id}/endpoint-mappings`" + ], + "reads": [ + "endpoint-mappings", + "endpoint-mappings[].endpoint_mapping_id", + "endpoint-mappings[].operation_id", + "endpoint-mappings[].request_mapping", + "endpoint-mappings[].response_mapping" + ], + "note": "Read by DynamicEndpointOperationsTable, which matches entries to the Swagger operations by operation_id." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/json-schema-validations", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/bank/[bank_id]/[id]/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/management/json-schema-validations`" + ], + "reads": [ + "json_schema_validations", + "json_schema_validations[].operation_id", + "json_schema_validations[].json_schema" + ], + "note": "Read by DynamicEndpointOperationsTable, which matches entries to the Swagger operations by operation_id." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/bank/[bank_id]/[id]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/banks/${bank_id}/dynamic-endpoints/${id}`" + ], + "reads": [ + "dynamic_endpoint_id", + "user_id", + "swagger_string", + "swagger_string.info.title", + "swagger_string.info.description", + "swagger_string.info.version", + "swagger_string.host", + "swagger_string.basePath", + "swagger_string.paths" + ], + "undocumented_fields": [ + "swagger_string.info.description", + "swagger_string.basePath" + ], + "note": "Rendered by +page.svelte and DynamicEndpointOperationsTable; swagger_string is the stored Swagger document, whose info.description and basePath the docs example leaves out." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/bank/[bank_id]/[id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/management/banks/${bankId}/dynamic-endpoints/${endpoint.dynamic_endpoint_id}`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/bank/[bank_id]/create/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/management/banks/${bankId}/dynamic-endpoints`" + ], + "reads": [], + "note": "Only the status is checked; the page then navigates to the list." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/dynamic-endpoints", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/system/+page.server.ts", + "needles": [ + "\"/obp/v6.0.0/management/dynamic-endpoints\"" + ], + "reads": [ + "dynamic_endpoints", + "dynamic_endpoints[].dynamic_endpoint_id", + "dynamic_endpoints[].user_id", + "dynamic_endpoints[].swagger_string", + "dynamic_endpoints[].swagger_string.paths" + ], + "note": "Rendered by +page.svelte; swagger_string is the stored Swagger document: the code walks its paths map (dynamic path and method keys) for summary and operationId." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/system/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/management/dynamic-endpoints/${endpointId}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/endpoint-mappings", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/system/[id]/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/management/endpoint-mappings`" + ], + "reads": [ + "endpoint-mappings", + "endpoint-mappings[].endpoint_mapping_id", + "endpoint-mappings[].operation_id", + "endpoint-mappings[].request_mapping", + "endpoint-mappings[].response_mapping" + ], + "note": "Read by DynamicEndpointOperationsTable, which matches entries to the Swagger operations by operation_id." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/json-schema-validations", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/system/[id]/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/management/json-schema-validations`" + ], + "reads": [ + "json_schema_validations", + "json_schema_validations[].operation_id", + "json_schema_validations[].json_schema" + ], + "note": "Read by DynamicEndpointOperationsTable, which matches entries to the Swagger operations by operation_id." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/system/[id]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/dynamic-endpoints/${id}`" + ], + "reads": [ + "dynamic_endpoint_id", + "user_id", + "swagger_string", + "swagger_string.info.title", + "swagger_string.info.description", + "swagger_string.info.version", + "swagger_string.host", + "swagger_string.basePath", + "swagger_string.paths" + ], + "undocumented_fields": [ + "swagger_string.info.description", + "swagger_string.basePath" + ], + "note": "Rendered by +page.svelte and DynamicEndpointOperationsTable; swagger_string is the stored Swagger document, whose info.description and basePath the docs example leaves out." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/system/[id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/management/dynamic-endpoints/${endpoint.dynamic_endpoint_id}`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/dynamic-endpoints", + "source": "apps/api-manager/src/routes/(protected)/dynamic-endpoints/system/create/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/management/dynamic-endpoints`" + ], + "reads": [], + "note": "Only the status is checked; the page then navigates to the list." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/diagnostics/dynamic-entities", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/diagnostics/+page.server.ts", + "needles": [ + "\"/obp/v6.0.0/management/diagnostics/dynamic-entities\"" + ], + "reads": [ + "orphaned_entities", + "orphaned_entities[].entity_name", + "orphaned_entities[].bank_id", + "orphaned_entities[].record_count" + ], + "note": "Only orphaned_entities is kept and the page renders its entity_name, bank_id and record_count." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/diagnostics/+page.server.ts", + "needles": [ + "dynamicEntityDefinitionsPath(DYNAMIC_ENTITY_SYSTEM_SPACE_BANK_ID)" + ], + "reads": [ + "dynamic_entities", + "dynamic_entities[].entity_name", + "dynamic_entities[].schema", + "dynamic_entities[].schema.properties", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].record_count", + "dynamic_entities[].bank_id" + ], + "note": "The path comes from dynamicEntityDefinitionsPath in packages/shared (system space SYS); the page counts schema.properties and shows the rest." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/diagnostics/dynamic-entities/orphaned-records", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/diagnostics/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/management/diagnostics/dynamic-entities/orphaned-records\"" + ], + "reads": [ + "total_records_deleted", + "deleted_orphaned_entities", + "deleted_orphaned_entities[].entity_name", + "deleted_orphaned_entities[].records_deleted" + ], + "undocumented_fields": [ + "deleted_orphaned_entities[].records_deleted" + ], + "note": "The page shows deleted.records_deleted per entity, while the docs name that field record_count." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/diagnostics/+page.svelte", + "needles": [ + "`/proxy${dynamicEntityDefinitionsPath(bankId)}`" + ], + "reads": [ + "dynamic_entities", + "dynamic_entities[].entity_name", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].bank_id", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.properties" + ], + "note": "Bank-level definitions for the current bank, fetched in the browser through the proxy." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/personal-dynamic-entities/available", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/personal/+page.server.ts", + "needles": [ + "\"/obp/v6.0.0/personal-dynamic-entities/available\"" + ], + "reads": [ + "dynamic_entities", + "dynamic_entities[].entity_name", + "dynamic_entities[].bank_id", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_public_access", + "dynamic_entities[].dynamic_entity_id" + ], + "undocumented_fields": [ + "dynamic_entities[].bank_id" + ], + "note": "The list is returned to +page.svelte, which filters and shows bank_id although the docs do not list it for this endpoint." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/personal-dynamic-entities/available", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/personal/[entityName]/+page.server.ts", + "needles": [ + "\"/obp/v6.0.0/personal-dynamic-entities/available\"," + ], + "reads": [ + "dynamic_entities", + "dynamic_entities[].entity_name", + "dynamic_entities[].bank_id", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.required" + ], + "undocumented_fields": [ + "dynamic_entities[].bank_id" + ], + "note": "The entity matching the route's entityName is returned to +page.svelte; has_public_access and has_community_access are only written to a log line, and the per-property fields under schema.properties belong to each entity's own schema." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/system/+page.server.ts", + "needles": [ + "dynamicEntityDefinitionsPath(DYNAMIC_ENTITY_SYSTEM_SPACE_BANK_ID)" + ], + "reads": [ + "dynamic_entities", + "dynamic_entities[].entity_name", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].bank_id", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.required" + ], + "note": "System-space definitions (SYS) returned to +page.svelte, which shows name, id, bank_id, record_count, schema description and counts of properties and required fields." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/system/+page.svelte", + "needles": [ + "`/proxy${dynamicEntityDefinitionsPath(bankId)}`" + ], + "reads": [ + "dynamic_entities", + "dynamic_entities[].entity_name", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].bank_id", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.required" + ], + "note": "Bank-level definitions for the current bank, fetched in the browser through the proxy and shown next to the system ones." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/system/create/+page.svelte", + "needles": [ + "`/proxy${dynamicEntityDefinitionsPath(" + ], + "reads": [], + "note": "Creates a definition in SYS or the current bank; only the status is checked." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/OBPv6.0.0/openapi", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/system/openapi-json/+page.server.ts", + "needles": [ + "`${OBP_API_URL}/resource-docs/OBPv6.0.0/openapi?content=dynamic`" + ], + "reads": [], + "note": "OBP_API_URL is ${PUBLIC_OBP_BASE_URL}/obp/v6.0.0 (apps/api-manager/src/lib/config.ts); the OpenAPI document is pretty-printed and shown whole, so no field is read." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/OBPv6.0.0/openapi.yaml", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/system/openapi-yaml/+page.server.ts", + "needles": [ + "`${OBP_API_URL}/resource-docs/OBPv6.0.0/openapi.yaml?content=dynamic`" + ], + "reads": [], + "undocumented_endpoint": "OBP-API documents only /resource-docs/API_VERSION/openapi (v5.1.0, v6.0.0, v7.0.0), not the openapi.yaml variant, in any cached version.", + "note": "OBP_API_URL is ${PUBLIC_OBP_BASE_URL}/obp/v6.0.0 (apps/api-manager/src/lib/config.ts); the YAML text is shown whole." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entity-web-hooks", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entity-webhooks/+page.server.ts", + "needles": [ + "webhooksAtBankPath(bankId)" + ], + "reads": [ + "web_hooks", + "web_hooks[].dynamic_entity_id", + "web_hooks[].webhook_id", + "web_hooks[].bank_id", + "web_hooks[].entity_name", + "web_hooks[].url", + "web_hooks[].description", + "web_hooks[].events", + "web_hooks[].field_conditions", + "web_hooks[].field_conditions[].field", + "web_hooks[].field_conditions[].from", + "web_hooks[].field_conditions[].to", + "web_hooks[].is_active", + "web_hooks[].deactivated_reason" + ], + "undocumented_fields": [ + "web_hooks[].deactivated_reason" + ], + "note": "Path from webhooksAtBankPath in apps/api-manager/src/lib/services/dynamicEntityWebhooks.ts; the list is rendered by +page.svelte, which shows deactivated_reason for webhooks that are off (the type marks it present only while inactive)." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entity-webhooks/[bank_id]/[dynamic_entity_id]/[webhook_id]/+page.server.ts", + "needles": [ + "webhooksPath(params.bank_id, params.dynamic_entity_id, params.webhook_id)" + ], + "reads": [ + "webhook_id", + "bank_id", + "dynamic_entity_id", + "entity_name", + "url", + "description", + "events", + "field_conditions", + "field_conditions[].field", + "field_conditions[].from", + "field_conditions[].to", + "is_active", + "deactivated_reason", + "signature_status", + "created_at", + "created_by_user_id", + "updated_at" + ], + "undocumented_fields": [ + "deactivated_reason" + ], + "note": "Path from webhooksPath in apps/api-manager/src/lib/services/dynamicEntityWebhooks.ts; the webhook is rendered by +page.svelte and its edit form, which shows deactivated_reason while the webhook is off." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID/deliveries", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entity-webhooks/[bank_id]/[dynamic_entity_id]/[webhook_id]/+page.server.ts", + "needles": [ + "`${webhooksPath(webhook.bank_id, webhook.dynamic_entity_id, webhook.webhook_id)}/deliveries?${query}`" + ], + "reads": [ + "deliveries", + "deliveries[].event_id", + "deliveries[].event_name", + "deliveries[].record_id", + "deliveries[].status", + "deliveries[].attempts", + "deliveries[].last_http_status", + "deliveries[].last_error", + "deliveries[].created_at" + ], + "note": "The deliveries are rendered by +page.svelte and passed to the assistant as context." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/resource-docs/v7.0.0/obp", + "source": "apps/api-manager/src/routes/(protected)/dynamic-entity-webhooks/help/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/resource-docs/v7.0.0/obp?functions=${FUNCTIONS.join(\",\")}`" + ], + "reads": [ + "resource_docs", + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].roles", + "resource_docs[].roles[].role" + ], + "undocumented_fields": [ + "resource_docs", + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].roles", + "resource_docs[].roles[].role" + ], + "note": "Fills the documented API_VERSION placeholder with the literal v7.0.0; the docs give no response field list for getResourceDocsObp, so every read is listed as undocumented." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/resource-docs/v7.0.0/obp", + "source": "apps/api-manager/src/routes/(protected)/dynamic-resource-docs/help/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/resource-docs/v7.0.0/obp?tags=${CHANGE_REQUEST_TAG}`" + ], + "reads": [ + "resource_docs", + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].roles", + "resource_docs[].roles[].role" + ], + "undocumented_fields": [ + "resource_docs", + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].roles", + "resource_docs[].roles[].role" + ], + "note": "Asks for the v7.0.0 resource docs tagged Dynamic-Change-Request. OBP-API's resource docs give no response fields for the resource-docs endpoint, so every field read is listed as undocumented." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/dynamic-resource-docs", + "source": "apps/api-manager/src/routes/(protected)/dynamic-resource-docs/system/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/management/dynamic-resource-docs`" + ], + "reads": [ + "dynamic-resource-docs", + "dynamic-resource-docs[].dynamic_resource_doc_id", + "dynamic-resource-docs[].partial_function_name", + "dynamic-resource-docs[].request_verb", + "dynamic-resource-docs[].request_url", + "dynamic-resource-docs[].summary", + "dynamic-resource-docs[].tags", + "dynamic-resource-docs[].roles" + ], + "note": "The list is rendered by the matching +page.svelte table and filter." + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID", + "source": "apps/api-manager/src/routes/(protected)/dynamic-resource-docs/system/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/dynamic-resource-docs/${encodeURIComponent(id)}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID", + "source": "apps/api-manager/src/routes/(protected)/dynamic-resource-docs/system/[id]/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/management/dynamic-resource-docs/${encodeURIComponent(id)}`" + ], + "reads": [ + "bank_id", + "dynamic_resource_doc_id", + "partial_function_name", + "request_verb", + "request_url", + "summary", + "description", + "method_body", + "example_request_body", + "success_response_body", + "error_response_bodies", + "tags", + "roles", + "programming_lang" + ], + "note": "The doc is returned to +page.svelte, which shows it and passes it to DynamicResourceDocForm as initial values." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/resource-docs/v7.0.0/obp", + "source": "apps/api-manager/src/routes/(protected)/dynamic-resource-docs/system/[id]/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/resource-docs/${RESOURCE_DOCS_VERSION}/obp?content=dynamic`", + "const RESOURCE_DOCS_VERSION = \"v7.0.0\"" + ], + "reads": [ + "resource_docs", + "resource_docs[].request_verb", + "resource_docs[].specified_url", + "resource_docs[].request_url", + "resource_docs[].operation_id" + ], + "undocumented_fields": [ + "resource_docs", + "resource_docs[].request_verb", + "resource_docs[].specified_url", + "resource_docs[].request_url", + "resource_docs[].operation_id" + ], + "note": "Asks for the v7.0.0 dynamic resource docs (RESOURCE_DOCS_VERSION is v7.0.0) to find this doc's entry. OBP-API's resource docs give no response fields for the resource-docs endpoint, so every field read is listed as undocumented." + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID", + "source": "apps/api-manager/src/routes/(protected)/dynamic-resource-docs/system/[id]/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/dynamic-resource-docs/${encodeURIComponent(docId)}`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID", + "source": "apps/api-manager/src/routes/(protected)/dynamic-resource-docs/system/[id]/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/dynamic-resource-docs/${encodeURIComponent(docId)}`" + ], + "reads": [ + "dynamic_change_request_id" + ], + "undocumented_fields": [ + "dynamic_change_request_id" + ], + "note": "Only a 202 answer (maker/checker on) is read, for the id of the queued change request." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/dynamic-resource-docs", + "source": "apps/api-manager/src/routes/(protected)/dynamic-resource-docs/system/create/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/management/dynamic-resource-docs`" + ], + "reads": [ + "dynamic_resource_doc_id", + "dynamic_change_request_id", + "expires_at", + "payload_hash", + "request_verb", + "request_path" + ], + "undocumented_fields": [ + "dynamic_change_request_id", + "expires_at", + "payload_hash", + "request_path" + ], + "note": "On 201 it reads dynamic_resource_doc_id; on 202 (maker/checker on) the body is a change request whose id, expiry, payload hash, verb and path are shown." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/files", + "source": "apps/api-manager/src/routes/(protected)/files/+page.svelte", + "needles": [ + "`/proxy/obp/v7.0.0/management/banks/${encodeURIComponent(bank)}/files?limit=${data.pageSize}&offset=${from}`" + ], + "reads": [ + "files", + "files[].file_id", + "files[].file_name", + "files[].media_type", + "files[].size_in_bytes", + "files[].is_public", + "files[].owner_user_id", + "files[].created_at", + "pagination.total" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/banks/BANK_ID/files", + "source": "apps/api-manager/src/routes/(protected)/files/create/+page.svelte", + "needles": [ + "`/proxy/obp/v7.0.0/banks/${encodeURIComponent(bankId)}/files`" + ], + "reads": [], + "note": "The created file is not read; only the error message on failure." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/api/glossary/TITLE", + "source": "apps/api-manager/src/routes/(protected)/glossary-items/[title]/+page.server.ts", + "needles": [ + "`${GLOSSARY_PATH}/${encodeURIComponent(title)}?expanded=false`" + ], + "reads": [ + "is_dynamic", + "title", + "description.markdown", + "glossary_item_id", + "overrides_static_item", + "shadows_static_glossary_item", + "updated_at" + ], + "note": "GLOSSARY_PATH is imported from $lib/server/glossaryItems, where it is \"/obp/v7.0.0/api/glossary\"; the item is rendered by the matching +page.svelte." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/resource-docs/v7.0.0/obp", + "source": "apps/api-manager/src/routes/(protected)/glossary-items/help/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/resource-docs/v7.0.0/obp?tags=${TAG}`" + ], + "reads": [ + "resource_docs", + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].roles", + "resource_docs[].roles[].role" + ], + "undocumented_fields": [ + "resource_docs", + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].roles", + "resource_docs[].roles[].role" + ], + "note": "Asks for the v7.0.0 resource docs tagged Documentation. OBP-API's resource docs give no response fields for the resource-docs endpoint, so every field read is listed as undocumented." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/json-schema-validations", + "source": "apps/api-manager/src/routes/(protected)/json-schema-validations/+page.server.ts", + "needles": [ + "\"/obp/v5.1.0/management/json-schema-validations\"" + ], + "reads": [ + "json_schema_validations", + "json_schema_validations[].operation_id", + "json_schema_validations[].json_schema", + "json_schema_validations[].json_schema.title", + "json_schema_validations[].json_schema.properties", + "json_schema_validations[].json_schema.required" + ], + "note": "Rows are rendered by the matching +page.svelte (title, property count, required fields)." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "source": "apps/api-manager/src/routes/(protected)/json-schema-validations/[operation_id]/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/management/json-schema-validations/${encodeURIComponent(operationId)}`" + ], + "reads": [ + "operation_id", + "json_schema" + ], + "note": "The page shows the whole json_schema as JSON text in the edit form." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/customers/CUSTOMER_ID/accounts-minimal", + "source": "apps/api-manager/src/routes/(protected)/mandates/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/customers/${encodeURIComponent(customerId)}/accounts-minimal`" + ], + "reads": [ + "accounts[].bank_id", + "accounts[].account_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts", + "source": "apps/api-manager/src/routes/(protected)/mandates/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/accounts`" + ], + "reads": [ + "accounts[].id", + "accounts[].label" + ], + "undocumented_fields": [ + "accounts[].id" + ], + "note": "Fills the account picker; the code reads id, which the documented response names account_id." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates", + "source": "apps/api-manager/src/routes/(protected)/mandates/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/accounts/${encodeURIComponent(accountId)}/mandates`", + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(acct.bank_id)}/accounts/${encodeURIComponent(acct.account_id)}/mandates`" + ], + "reads": [ + "mandates[].mandate_id", + "mandates[].bank_id", + "mandates[].account_id", + "mandates[].mandate_name", + "mandates[].mandate_reference", + "mandates[].status", + "mandates[].valid_from", + "mandates[].valid_to" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers", + "source": "apps/api-manager/src/routes/(protected)/mandates/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/customers?limit=200`" + ], + "reads": [ + "customers[].customer_id", + "customers[].legal_name", + "customers[].customer_number" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates", + "source": "apps/api-manager/src/routes/(protected)/mandates/[bank_id]/[account_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bId)}/accounts/${encodeURIComponent(aId)}/mandates`" + ], + "reads": [ + "mandates[].mandate_id", + "mandates[].mandate_name", + "mandates[].mandate_reference", + "mandates[].status", + "mandates[].valid_from", + "mandates[].valid_to" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates/MANDATE_ID", + "source": "apps/api-manager/src/routes/(protected)/mandates/[bank_id]/[account_id]/[mandate_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bId)}/accounts/${encodeURIComponent(aId)}/mandates/${encodeURIComponent(mId)}`" + ], + "reads": [ + "mandate_name", + "mandate_reference", + "status", + "customer_id", + "valid_from", + "valid_to", + "description", + "legal_text" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/provisions", + "source": "apps/api-manager/src/routes/(protected)/mandates/[bank_id]/[account_id]/[mandate_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bId)}/mandates/${encodeURIComponent(mId)}/provisions`" + ], + "reads": [ + "provisions[].provision_id", + "provisions[].provision_name", + "provisions[].provision_type", + "provisions[].is_active", + "provisions[].provision_description", + "provisions[].legal_reference", + "provisions[].conditions", + "provisions[].signatory_requirements[].panel_id", + "provisions[].signatory_requirements[].required_count", + "provisions[].linked_view_id", + "provisions[].linked_abac_rule_id", + "provisions[].linked_challenge_type" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/provisions", + "source": "apps/api-manager/src/routes/(protected)/mandates/[bank_id]/[account_id]/[mandate_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/mandates/${encodeURIComponent(mandateId)}/provisions`" + ], + "reads": [ + "provision_id", + "provision_name", + "provision_type", + "is_active", + "provision_description", + "legal_reference", + "conditions", + "signatory_requirements[].panel_id", + "signatory_requirements[].required_count", + "linked_view_id", + "linked_abac_rule_id", + "linked_challenge_type" + ], + "note": "The created provision is appended to the list and rendered like the listed provisions." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels", + "source": "apps/api-manager/src/routes/(protected)/mandates/[bank_id]/[account_id]/[mandate_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bId)}/mandates/${encodeURIComponent(mId)}/signatory-panels`" + ], + "reads": [ + "signatory_panels[].panel_id", + "signatory_panels[].panel_name", + "signatory_panels[].description", + "signatory_panels[].user_ids[]" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels", + "source": "apps/api-manager/src/routes/(protected)/mandates/[bank_id]/[account_id]/[mandate_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bankId)}/mandates/${encodeURIComponent(mandateId)}/signatory-panels`" + ], + "reads": [ + "panel_id", + "panel_name", + "description", + "user_ids[]" + ], + "note": "The created panel is appended to the list and rendered like the listed panels." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates", + "source": "apps/api-manager/src/routes/(protected)/mandates/[bank_id]/[account_id]/create/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${encodeURIComponent(bank_id)}/accounts/${encodeURIComponent(account_id)}/mandates`" + ], + "reads": [ + "mandate_id" + ], + "note": "Uses the new mandate_id to redirect to the mandate page." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/system/diagnostics/metrics/run", + "source": "apps/api-manager/src/routes/(protected)/metrics-archive-run/+page.svelte", + "needles": [ + "\"/proxy/obp/v7.0.0/management/system/diagnostics/metrics/run\"" + ], + "reads": [ + "status", + "message", + "run", + "run.run_id", + "run.api_instance_id", + "run.started_at", + "run.ended_at", + "run.duration_ms", + "run.rows_moved_to_archive", + "run.rows_deleted_from_archive", + "run.success", + "run.remark" + ], + "note": "RUN_ENDPOINT holds the path and is fetched with method POST." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/system/diagnostics/metrics", + "source": "apps/api-manager/src/routes/(protected)/metrics-diagnostics/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/management/system/diagnostics/metrics\"" + ], + "reads": [ + "config", + "everything_as_expected", + "checks", + "checks[].name", + "checks[].status", + "checks[].message", + "metric.table_name", + "metric.count", + "metric.oldest_record_date", + "metric.oldest_record_age_days", + "metric.newest_record_date", + "metric.newest_record_age_days", + "metric_archive.table_name", + "metric_archive.count", + "metric_archive.oldest_record_date", + "metric_archive.oldest_record_age_days", + "metric_archive.newest_record_date", + "metric_archive.newest_record_age_days", + "last_run.run_id", + "last_run.api_instance_id", + "last_run.started_at", + "last_run.ended_at", + "last_run.duration_ms", + "last_run.rows_moved_to_archive", + "last_run.rows_deleted_from_archive", + "last_run.success", + "last_run.remark", + "last_successful_run.run_id", + "last_successful_run.api_instance_id", + "last_successful_run.started_at", + "last_successful_run.ended_at", + "last_successful_run.duration_ms", + "last_successful_run.rows_moved_to_archive", + "last_successful_run.rows_deleted_from_archive", + "last_successful_run.success", + "last_successful_run.remark" + ], + "note": "Returned to the matching +page.svelte; config is shown key by key with Object.entries." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/metrics", + "source": "apps/api-manager/src/routes/(protected)/metrics/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/metrics?${queryParams.toString()}`" + ], + "reads": [ + "metrics", + "metrics[].date", + "metrics[].duration", + "metrics[].username", + "metrics[].app_name", + "metrics[].consumer_id", + "metrics[].verb", + "metrics[].url", + "metrics[].correlation_id", + "metrics[].status_code", + "metrics[].operation_id", + "metrics[].api_instance_id", + "metrics[].consent_reference_id", + "metrics[].source_ip", + "metrics[].forwarded_for" + ], + "note": "Called with obp_requests.getResponse; the records are rendered by the metrics table in the matching +page.svelte." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/system/diagnostics/deployment", + "source": "apps/api-manager/src/routes/(protected)/metrics/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/management/system/diagnostics/deployment\"" + ], + "reads": [ + "checks", + "checks[].id", + "checks[].status", + "checks[].message", + "checks[].evidence", + "checks[].evidence[].name", + "checks[].evidence[].value" + ], + "note": "Only the check_api_metrics entry is used, when no metrics came back and the user has CanGetConfig." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products", + "source": "apps/api-manager/src/routes/(protected)/products/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${bankId}/api-products`" + ], + "reads": [ + "api_products[].api_product_code", + "api_products[].name", + "api_products[].description", + "api_products[].parent_api_product_code", + "api_products[].category", + "api_products[].family", + "api_products[].super_family", + "api_products[].tags[]", + "api_products[].more_info_url", + "api_products[].attributes[].name", + "api_products[].attributes[].value" + ], + "undocumented_fields": [ + "api_products[].family", + "api_products[].super_family" + ], + "note": "The list filters and shows family and super_family, which the documented API product response does not have." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "source": "apps/api-manager/src/routes/(protected)/products/[bank_id]/[product_code]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${bankId}/api-products/${encodeURIComponent(productCode)}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "source": "apps/api-manager/src/routes/(protected)/products/[bank_id]/[product_code]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${bankId}/api-products/${encodeURIComponent(productCode)}`" + ], + "reads": [ + "name", + "api_product_code", + "parent_api_product_code", + "tags[]", + "description", + "collection_id", + "monthly_subscription_amount", + "monthly_subscription_currency", + "category", + "per_second_call_limit", + "per_minute_call_limit", + "per_hour_call_limit", + "per_day_call_limit", + "per_week_call_limit", + "per_month_call_limit", + "more_info_url", + "terms_and_conditions_url", + "attributes[].name", + "attributes[].type", + "attributes[].value", + "fees[].name", + "fees[].type", + "fees[].amount", + "fees[].currency", + "fees[].frequency", + "meta.license.id", + "meta.license.name" + ], + "undocumented_fields": [ + "fees[].name", + "fees[].type", + "fees[].amount", + "fees[].currency", + "fees[].frequency", + "meta.license.id", + "meta.license.name" + ], + "note": "The page renders fees and meta.license sections that the documented API product response does not have." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "source": "apps/api-manager/src/routes/(protected)/products/[bank_id]/[product_code]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/banks/${bankId}/api-products/${productCode}`" + ], + "reads": [ + "name", + "description", + "parent_api_product_code", + "category", + "more_info_url", + "terms_and_conditions_url", + "collection_id", + "monthly_subscription_amount", + "monthly_subscription_currency", + "per_second_call_limit", + "per_minute_call_limit", + "per_hour_call_limit", + "per_day_call_limit", + "per_week_call_limit", + "per_month_call_limit", + "tags", + "attributes[].name", + "attributes[].type", + "attributes[].value" + ], + "note": "Returned to the edit page, which pre-fills the product form from these fields." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections", + "source": "apps/api-manager/src/routes/(protected)/products/[bank_id]/[product_code]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/my/api-collections`" + ], + "reads": [ + "api_collections[].api_collection_id", + "api_collections[].api_collection_name" + ], + "note": "Returned to the edit page as the collection picker of ProductForm." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "source": "apps/api-manager/src/routes/(protected)/products/[bank_id]/[product_code]/edit/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${bankId}/api-products/${encodeURIComponent(productCode)}`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE/attribute", + "source": "apps/api-manager/src/routes/(protected)/products/[bank_id]/[product_code]/edit/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${bankId}/api-products/${encodeURIComponent(productCode)}/attribute`" + ], + "reads": [] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "source": "apps/api-manager/src/routes/(protected)/products/bootstrap/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${selectedBankId}/api-products/${product.product_code}`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "source": "apps/api-manager/src/routes/(protected)/products/bootstrap/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${selectedBankId}/api-products/${product.product_code}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections/name/API_COLLECTION_NAME", + "source": "apps/api-manager/src/routes/(protected)/products/bootstrap/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/my/api-collections/name/${encodeURIComponent(collection.collection_name)}`" + ], + "reads": [ + "api_collection_id" + ], + "note": "Checks whether the collection already exists before creating it through /backend/api-collections." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/product-collections/COLLECTION_CODE", + "source": "apps/api-manager/src/routes/(protected)/products/collections/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${selectedBankId}/product-collections/${encodeURIComponent(collectionCode.trim())}`" + ], + "reads": [ + "collection_code", + "products[].code|products[].product_code", + "products[].name", + "products[].description", + "products[].product_attributes[].name", + "products[].product_attributes[].value" + ], + "note": "Accepts code or product_code for a product; only code is documented." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections", + "source": "apps/api-manager/src/routes/(protected)/products/create/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/my/api-collections`" + ], + "reads": [ + "api_collections[].api_collection_id", + "api_collections[].api_collection_name" + ], + "note": "Returned to the create page as the collection picker of ProductForm." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "source": "apps/api-manager/src/routes/(protected)/products/create/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${selectedBankId}/api-products/${formData.productCode}`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE/attribute", + "source": "apps/api-manager/src/routes/(protected)/products/create/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${selectedBankId}/api-products/${formData.productCode}/attribute`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/products", + "source": "apps/api-manager/src/routes/(protected)/products/financial/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${bankId}/products`" + ], + "reads": [ + "products[].code|products[].product_code", + "products[].name", + "products[].description", + "products[].parent_product_code", + "products[].category", + "products[].family", + "products[].super_family", + "products[].tags[]", + "products[].more_info_url", + "products[].attributes[].name", + "products[].attributes[].value" + ], + "undocumented_fields": [ + "products[].category", + "products[].family", + "products[].super_family", + "products[].attributes[].name", + "products[].attributes[].value" + ], + "note": "Accepts code or product_code; also filters and shows category, family, super_family and attributes, which the documented v6.0.0 product list does not have." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE", + "source": "apps/api-manager/src/routes/(protected)/products/financial/[bank_id]/[product_code]/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/banks/${bankId}/products/${encodeURIComponent(productCode)}`" + ], + "reads": [ + "name", + "product_code", + "parent_product_code", + "description", + "more_info_url", + "terms_and_conditions_url", + "attributes[].name", + "attributes[].type", + "attributes[].value", + "fees[].product_fee_id", + "fees[].name", + "fees[].value.amount", + "fees[].value.currency", + "fees[].value.frequency", + "fees[].is_active", + "meta.license.id", + "meta.license.name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/products/PRODUCT_CODE/tags", + "source": "apps/api-manager/src/routes/(protected)/products/financial/[bank_id]/[product_code]/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${bankId}/products/${encodeURIComponent(productCode)}/tags`" + ], + "reads": [ + "tags[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE", + "source": "apps/api-manager/src/routes/(protected)/products/financial/[bank_id]/[product_code]/edit/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/banks/${bankId}/products/${encodeURIComponent(productCode)}`" + ], + "reads": [ + "name", + "parent_product_code", + "description", + "more_info_url", + "terms_and_conditions_url", + "attributes[].product_attribute_id", + "attributes[].name", + "attributes[].type", + "attributes[].value" + ] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE", + "source": "apps/api-manager/src/routes/(protected)/products/financial/[bank_id]/[product_code]/edit/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/banks/${bankId}/products/${encodeURIComponent(productCode)}`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attribute", + "source": "apps/api-manager/src/routes/(protected)/products/financial/[bank_id]/[product_code]/edit/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/banks/${bankId}/products/${encodeURIComponent(productCode)}/attribute`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID", + "source": "apps/api-manager/src/routes/(protected)/products/financial/[bank_id]/[product_code]/edit/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/banks/${bankId}/products/${encodeURIComponent(productCode)}/attributes/${attr.product_attribute_id}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/products/PRODUCT_CODE/tags", + "source": "apps/api-manager/src/routes/(protected)/products/financial/[bank_id]/[product_code]/edit/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${bankId}/products/${encodeURIComponent(productCode)}/tags`" + ], + "reads": [ + "tags[]" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/products/PRODUCT_CODE/tags", + "source": "apps/api-manager/src/routes/(protected)/products/financial/[bank_id]/[product_code]/edit/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/banks/${bankId}/products/${encodeURIComponent(productCode)}/tags`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/products", + "source": "apps/api-manager/src/routes/(protected)/products/financial/all-banks/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/products${tagQuery}`" + ], + "reads": [ + "products[].bank_id", + "products[].product_code|products[].code", + "products[].name", + "products[].description", + "products[].parent_product_code", + "products[].category", + "products[].family", + "products[].super_family", + "products[].tags[]", + "products[].more_info_url" + ], + "undocumented_fields": [ + "products[].category", + "products[].family", + "products[].super_family" + ], + "note": "Optional ?tag=featured query; accepts product_code or code and also shows category, family and super_family, which the documented response does not have." + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE", + "source": "apps/api-manager/src/routes/(protected)/products/financial/create/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/banks/${bankId}/products/${encodeURIComponent(code)}`" + ], + "reads": [ + "product_code" + ], + "note": "Checks that the response carries a non-empty product_code." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attribute", + "source": "apps/api-manager/src/routes/(protected)/products/financial/create/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/banks/${bankId}/products/${encodeURIComponent(code)}/attribute`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/api-manager/src/routes/(protected)/rbac/banks/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/banks`" + ], + "reads": [ + "banks[].bank_id", + "banks[].short_name", + "banks[].full_name", + "banks[].logo", + "banks[].website", + "banks[].bank_routings[].scheme", + "banks[].bank_routings[].address" + ], + "undocumented_fields": [ + "banks[].short_name" + ], + "note": "The page sorts and searches the banks by bank_id, short_name and full_name and shows logo, website and routings; v6.0.0 documents bank_code instead of short_name." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/entitlement-requests", + "source": "apps/api-manager/src/routes/(protected)/rbac/entitlement-requests/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/entitlement-requests?limit=${limit}&offset=${offset}&sort_direction=${sortDirection}`" + ], + "reads": [ + "entitlement_requests[].entitlement_request_id", + "entitlement_requests[].role_name", + "entitlement_requests[].bank_id", + "entitlement_requests[].created", + "entitlement_requests[].user.user_id", + "entitlement_requests[].user.username", + "entitlement_requests[].user.email" + ], + "note": "The list goes to the page, which shows, searches and accepts or declines each request." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/entitlement-requests/ENTITLEMENT_REQUEST_ID", + "source": "apps/api-manager/src/routes/(protected)/rbac/entitlement-requests/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/entitlement-requests/${requestId}`" + ], + "reads": [], + "note": "Called after accepting (granting the role) or on decline; only the status and the error message are used." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/entitlements", + "source": "apps/api-manager/src/routes/(protected)/rbac/entitlements/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/entitlements`" + ], + "reads": [ + "list[].entitlement_id", + "list[].role_name", + "list[].bank_id", + "list[].user_id", + "list[].username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID", + "source": "apps/api-manager/src/routes/(protected)/rbac/entitlements/[entitlement_id]/delete/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/banks/${entitlement.bank_id}`" + ], + "reads": [ + "short_name", + "full_name" + ], + "undocumented_fields": [ + "short_name" + ], + "note": "The delete page shows short_name or full_name; v6.0.0 documents bank_code instead of short_name." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/entitlements", + "source": "apps/api-manager/src/routes/(protected)/rbac/entitlements/[entitlement_id]/delete/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/entitlements`" + ], + "reads": [ + "list[].entitlement_id", + "list[].user_id", + "list[].bank_id", + "list[].role_name", + "list[].created_date" + ], + "undocumented_fields": [ + "list[].created_date" + ], + "note": "Finds the entitlement by id; the delete page also shows created_date when present, a field the docs do not list." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user_id/USER_ID", + "source": "apps/api-manager/src/routes/(protected)/rbac/entitlements/[entitlement_id]/delete/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users/user_id/${entitlement.user_id}`" + ], + "reads": [ + "username", + "email" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "source": "apps/api-manager/src/routes/(protected)/rbac/entitlements/bulk-grant/+page.server.ts", + "needles": [ + "\"/obp/v6.0.0/roles\"" + ], + "reads": [ + "roles[].role", + "roles[].requires_bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/USER_ID/entitlements", + "source": "apps/api-manager/src/routes/(protected)/rbac/entitlements/bulk-revoke/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/users/${encodeURIComponent(uid)}/entitlements`" + ], + "reads": [ + "list[].entitlement_id", + "list[].role_name", + "list[].bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "source": "apps/api-manager/src/routes/(protected)/rbac/entitlements/create/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/roles`" + ], + "reads": [ + "roles[].role", + "roles[].requires_bank_id" + ], + "note": "The roles go to RoleSearchWidget, which reads role and requires_bank_id." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups", + "source": "apps/api-manager/src/routes/(protected)/rbac/groups/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/groups`" + ], + "reads": [ + "groups[].group_id", + "groups[].group_name", + "groups[].group_description", + "groups[].bank_id", + "groups[].is_enabled", + "groups[].list_of_roles[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups/GROUP_ID", + "source": "apps/api-manager/src/routes/(protected)/rbac/groups/[group_id]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/groups/${group_id}`" + ], + "reads": [ + "group_id", + "group_name", + "group_description", + "bank_id", + "is_enabled", + "list_of_roles[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups/GROUP_ID/entitlements", + "source": "apps/api-manager/src/routes/(protected)/rbac/groups/[group_id]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/groups/${group_id}/entitlements`" + ], + "reads": [ + "entitlements[].role_name", + "entitlements[].bank_id", + "entitlements[].user_id", + "entitlements[].username" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/groups/GROUP_ID/sync-members", + "source": "apps/api-manager/src/routes/(protected)/rbac/groups/[group_id]/+page.svelte", + "needles": [ + "`/proxy/obp/v7.0.0/management/groups/${group.group_id}/sync-members${dryRun ? \"?dry_run=true\" : \"\"}`" + ], + "reads": [ + "dry_run", + "members[].user_id", + "members[].username", + "members[].entitlements_created[]", + "members[].entitlements_deleted[]", + "members[].entitlements_moved[].role_name", + "members[].entitlements_moved[].to_group_id" + ], + "note": "With dry_run=true it only previews; the page lists the members whose entitlements were or would be created, deleted or moved." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups/GROUP_ID", + "source": "apps/api-manager/src/routes/(protected)/rbac/groups/[group_id]/delete/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/groups/${group_id}`" + ], + "reads": [ + "group_id", + "group_name", + "group_description", + "bank_id", + "is_enabled", + "list_of_roles[]" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/groups/GROUP_ID", + "source": "apps/api-manager/src/routes/(protected)/rbac/groups/[group_id]/delete/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/management/groups/${group.group_id}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups/GROUP_ID", + "source": "apps/api-manager/src/routes/(protected)/rbac/groups/[group_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/groups/${group_id}`" + ], + "reads": [ + "group_id", + "group_name", + "group_description", + "bank_id", + "is_enabled", + "list_of_roles[]" + ], + "note": "Fills the edit form." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "source": "apps/api-manager/src/routes/(protected)/rbac/groups/[group_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/roles`" + ], + "reads": [ + "roles[].role", + "roles[].requires_bank_id" + ], + "note": "The roles go to RoleSearchWidget, which reads role and requires_bank_id." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/groups/GROUP_ID", + "source": "apps/api-manager/src/routes/(protected)/rbac/groups/[group_id]/edit/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/management/groups/${group.group_id}`" + ], + "reads": [], + "note": "Only the status and the error message are used." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "source": "apps/api-manager/src/routes/(protected)/rbac/groups/create/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/roles`" + ], + "reads": [ + "roles[].role", + "roles[].requires_bank_id" + ], + "note": "The roles go to RoleSearchWidget, which reads role and requires_bank_id." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups", + "source": "apps/api-manager/src/routes/(protected)/rbac/memberships/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/groups`" + ], + "reads": [ + "groups[].group_id", + "groups[].group_name", + "groups[].group_description", + "groups[].bank_id", + "groups[].is_enabled", + "groups[].list_of_roles[]" + ], + "note": "Each group is fetched again for its entitlements and shown with them." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups/GROUP_ID/entitlements", + "source": "apps/api-manager/src/routes/(protected)/rbac/memberships/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/groups/${group.group_id}/entitlements`" + ], + "reads": [ + "entitlements[].role_name", + "entitlements[].bank_id", + "entitlements[].user_id", + "entitlements[].username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups", + "source": "apps/api-manager/src/routes/(protected)/rbac/memberships/create/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/groups`" + ], + "reads": [ + "groups[].group_id", + "groups[].group_name", + "groups[].group_description", + "groups[].bank_id", + "groups[].is_enabled", + "groups[].list_of_roles[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users", + "source": "apps/api-manager/src/routes/(protected)/rbac/memberships/create/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users`" + ], + "reads": [ + "users" + ], + "note": "The list is returned to the page, but the page never uses it; users are picked through UserSearchPickerWidget." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/roles-with-entitlement-counts", + "source": "apps/api-manager/src/routes/(protected)/rbac/roles/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/roles-with-entitlement-counts`" + ], + "reads": [ + "roles[].role", + "roles[].bank_id", + "roles[].entitlement_count" + ], + "undocumented_fields": [ + "roles[].bank_id" + ], + "note": "The page groups the roles by bank_id, which the docs do not list for this endpoint." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/entitlements", + "source": "apps/api-manager/src/routes/(protected)/rbac/roles/[role]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/entitlements?role=${encodeURIComponent(roleName)}`" + ], + "reads": [ + "list[].username", + "list[].user_id", + "list[].entitlement_id", + "list[].bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "source": "apps/api-manager/src/routes/(protected)/rbac/roles/[role]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/roles`" + ], + "reads": [ + "roles[].role", + "roles[].requires_bank_id" + ], + "note": "Only used to find whether the role needs a bank id." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/api-manager/src/routes/(protected)/reports/[id]/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/banks\"" + ], + "reads": [ + "banks[].bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "source": "apps/api-manager/src/routes/(protected)/retention/+page.server.ts", + "needles": [ + "obp_requests.get(retentionPath(bankId, \"retention-policies\")" + ], + "reads": [ + "retention_policies[].retention_policy_id", + "retention_policies[].name", + "retention_policies[].entity_name", + "retention_policies[].resource_type", + "retention_policies[].requires_approval", + "retention_policies[].enabled", + "retention_policies[].condition.field", + "retention_policies[].condition.value", + "retention_policies[].retain_days", + "retention_policies[].date_basis", + "retention_policies[].action", + "retention_policies[].archive_days", + "retention_policies[].cascade" + ], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen. The page and describePolicy() render the fields." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "source": "apps/api-manager/src/routes/(protected)/retention/+page.server.ts", + "needles": [ + "obp_requests.post(retentionPath(bankId, \"retention-policies\")" + ], + "reads": [ + "retention_policy_id" + ], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen. The new policy id is used for the redirect." + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "source": "apps/api-manager/src/routes/(protected)/retention/[bank_id]/[policy_id]/+page.server.ts", + "needles": [ + "obp_requests.delete(policyPath(params.bank_id, params.policy_id)", + "const policyPath = (bankId: string, id: string) => retentionPath(bankId, `retention-policies/${encodeURIComponent(id)}`);" + ], + "reads": [], + "note": "Path built by the local policyPath() on retentionPath() from apps/api-manager/src/lib/services/retention.ts." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "source": "apps/api-manager/src/routes/(protected)/retention/[bank_id]/[policy_id]/+page.server.ts", + "needles": [ + "obp_requests.get(policyPath(bankId, params.policy_id)", + "const policyPath = (bankId: string, id: string) => retentionPath(bankId, `retention-policies/${encodeURIComponent(id)}`);" + ], + "reads": [ + "name", + "description", + "resource_type", + "entity_name", + "condition.field", + "condition.value", + "retain_days", + "date_basis", + "action", + "archive_days", + "cascade", + "requires_approval", + "enabled" + ], + "note": "Path built by the local policyPath() on retentionPath() from apps/api-manager/src/lib/services/retention.ts. Read by the page, describePolicy() and RetentionPolicyForm." + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "source": "apps/api-manager/src/routes/(protected)/retention/[bank_id]/[policy_id]/+page.server.ts", + "needles": [ + "obp_requests.put(policyPath(params.bank_id, params.policy_id)", + "const policyPath = (bankId: string, id: string) => retentionPath(bankId, `retention-policies/${encodeURIComponent(id)}`);" + ], + "reads": [], + "note": "Path built by the local policyPath() on retentionPath() from apps/api-manager/src/lib/services/retention.ts." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID/preview", + "source": "apps/api-manager/src/routes/(protected)/retention/[bank_id]/[policy_id]/+page.server.ts", + "needles": [ + "obp_requests.get(`${policyPath(bankId, params.policy_id)}/preview`", + "const policyPath = (bankId: string, id: string) => retentionPath(bankId, `retention-policies/${encodeURIComponent(id)}`);" + ], + "reads": [ + "due_count", + "count_is_capped", + "max_items_per_run", + "matched_count", + "held_count", + "cutoff_date", + "minimum_retain_days", + "oldest_trigger_date", + "archive_entries_due_count", + "archive_enabled", + "delete_enabled", + "sample_resource_ids", + "can_execute" + ], + "note": "Path built by the local policyPath() on retentionPath() from apps/api-manager/src/lib/services/retention.ts." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID/runs", + "source": "apps/api-manager/src/routes/(protected)/retention/[bank_id]/[policy_id]/+page.server.ts", + "needles": [ + "obp_requests.post(`${policyPath(params.bank_id, params.policy_id)}/runs`", + "const policyPath = (bankId: string, id: string) => retentionPath(bankId, `retention-policies/${encodeURIComponent(id)}`);" + ], + "reads": [ + "status", + "message", + "retention_run_id" + ], + "note": "Path built by the local policyPath() on retentionPath() from apps/api-manager/src/lib/services/retention.ts." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs", + "source": "apps/api-manager/src/routes/(protected)/retention/[bank_id]/[policy_id]/+page.server.ts", + "needles": [ + "obp_requests.get(retentionPath(bankId, \"retention-runs\", { retention_policy_id: params.policy_id, limit: 20 })" + ], + "reads": [ + "retention_runs[].retention_run_id", + "retention_runs[].requested_at", + "retention_runs[].mode", + "retention_runs[].status", + "retention_runs[].archived_count", + "retention_runs[].deleted_count", + "retention_runs[].anonymised_count", + "retention_runs[].held_count", + "retention_runs[].failed_count" + ], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen. Filtered to this policy's runs." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-archive", + "source": "apps/api-manager/src/routes/(protected)/retention/archive/+page.server.ts", + "needles": [ + "obp_requests.get(retentionPath(bankId, \"retention-archive\", { ...filters, limit: PAGE, offset })" + ], + "reads": [ + "retention_archive_entries[].retention_archive_id", + "retention_archive_entries[].archived_at", + "retention_archive_entries[].resource_type", + "retention_archive_entries[].entity_name", + "retention_archive_entries[].resource_id", + "retention_archive_entries[].owner_user_id", + "retention_archive_entries[].delete_after", + "retention_archive_entries[].has_content", + "retention_archive_entries[].content_size_in_bytes" + ], + "undocumented_fields": [ + "retention_archive_entries[].content_size_in_bytes" + ], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen. The page shows content_size_in_bytes for entries that have content." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-archive/RETENTION_ARCHIVE_ID", + "source": "apps/api-manager/src/routes/(protected)/retention/archive/[bank_id]/[archive_id]/+page.server.ts", + "needles": [ + "obp_requests.get(retentionPath(params.bank_id, `retention-archive/${encodeURIComponent(params.archive_id)}`)" + ], + "reads": [ + "resource_type", + "entity_name", + "resource_id", + "owner_user_id", + "parent_resource_type", + "parent_resource_id", + "archived_at", + "retention_run_id", + "delete_after", + "has_content", + "retention_archive_id", + "content_size_in_bytes", + "data" + ], + "undocumented_fields": [ + "parent_resource_type", + "parent_resource_id", + "content_size_in_bytes" + ], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen. The page prints data as JSON, as archived." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-archive/RETENTION_ARCHIVE_ID", + "source": "apps/api-manager/src/routes/(protected)/retention/archive/[bank_id]/[archive_id]/content/+server.ts", + "needles": [ + "obp_requests.get(retentionPath(params.bank_id, `retention-archive/${encodeURIComponent(params.archive_id)}`, { include_content: true })" + ], + "reads": [ + "content_base64", + "data", + "data.file_name", + "resource_id" + ], + "undocumented_fields": [ + "content_base64", + "data.file_name" + ], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen. Called with include_content=true; the base64 content is returned as a file download named after data.file_name." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-holds", + "source": "apps/api-manager/src/routes/(protected)/retention/holds/+page.server.ts", + "needles": [ + "obp_requests.get(retentionPath(bankId, \"retention-holds\", { is_active: active, limit: 200 })" + ], + "reads": [ + "retention_holds[].retention_hold_id", + "retention_holds[].resource_type", + "retention_holds[].entity_name", + "retention_holds[].resource_id", + "retention_holds[].reason", + "retention_holds[].placed_at", + "retention_holds[].placed_by_user_id", + "retention_holds[].released_at", + "retention_holds[].released_by_user_id", + "retention_holds[].is_active" + ], + "undocumented_fields": [ + "retention_holds[].released_at", + "retention_holds[].released_by_user_id" + ], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen. Released holds are shown with who released them and when." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-holds", + "source": "apps/api-manager/src/routes/(protected)/retention/holds/+page.server.ts", + "needles": [ + "retentionPath(retentionSpace(url.searchParams.get(\"bank_id\")), \"retention-holds\")" + ], + "reads": [], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen." + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-holds/RETENTION_HOLD_ID", + "source": "apps/api-manager/src/routes/(protected)/retention/holds/+page.server.ts", + "needles": [ + "obp_requests.delete(retentionPath(retentionSpace(url.searchParams.get(\"bank_id\")), `retention-holds/${encodeURIComponent(id)}`)" + ], + "reads": [], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "source": "apps/api-manager/src/routes/(protected)/retention/runs/+page.server.ts", + "needles": [ + "obp_requests.get(retentionPath(bankId, \"retention-policies\")" + ], + "reads": [ + "retention_policies[].retention_policy_id", + "retention_policies[].name", + "retention_policies[].entity_name", + "retention_policies[].resource_type" + ], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen. Used only to name each run's policy." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs", + "source": "apps/api-manager/src/routes/(protected)/retention/runs/+page.server.ts", + "needles": [ + "obp_requests.get(retentionPath(bankId, \"retention-runs\", { status, limit: 100 })" + ], + "reads": [ + "retention_runs[].retention_run_id", + "retention_runs[].requested_at", + "retention_runs[].requested_by_user_id", + "retention_runs[].retention_policy_id", + "retention_runs[].mode", + "retention_runs[].status", + "retention_runs[].matched_count", + "retention_runs[].archived_count", + "retention_runs[].anonymised_count", + "retention_runs[].deleted_count", + "retention_runs[].held_count", + "retention_runs[].failed_count", + "retention_runs[].message", + "retention_runs[].approval_decision", + "retention_runs[].approval_comment" + ], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen." + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs/RETENTION_RUN_ID/approval", + "source": "apps/api-manager/src/routes/(protected)/retention/runs/+page.server.ts", + "needles": [ + "retentionPath(retentionSpace(url.searchParams.get(\"bank_id\")), `retention-runs/${encodeURIComponent(runId)}/approval`)" + ], + "reads": [ + "status", + "message" + ], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs/RETENTION_RUN_ID", + "source": "apps/api-manager/src/routes/(protected)/retention/runs/[bank_id]/[run_id]/+page.server.ts", + "needles": [ + "obp_requests.get(retentionPath(params.bank_id, `retention-runs/${encodeURIComponent(params.run_id)}`)" + ], + "reads": [ + "status", + "mode", + "retention_policy_id", + "requested_at", + "requested_by_user_id", + "approval_decision", + "approved_by_user_id", + "approval_comment", + "started_at", + "ended_at", + "matched_count", + "archived_count", + "anonymised_count", + "deleted_count", + "held_count", + "failed_count", + "message" + ], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs/RETENTION_RUN_ID/items", + "source": "apps/api-manager/src/routes/(protected)/retention/runs/[bank_id]/[run_id]/+page.server.ts", + "needles": [ + "obp_requests.get(retentionPath(params.bank_id, `retention-runs/${encodeURIComponent(params.run_id)}/items`, { limit: PAGE, offset })" + ], + "reads": [ + "retention_run_items[].retention_run_item_id", + "retention_run_items[].disposed_at", + "retention_run_items[].action", + "retention_run_items[].resource_type", + "retention_run_items[].entity_name", + "retention_run_items[].resource_id", + "retention_run_items[].owner_user_id", + "retention_run_items[].parent_resource_type", + "retention_run_items[].parent_resource_id", + "retention_run_items[].retention_archive_id" + ], + "undocumented_fields": [ + "retention_run_items[].entity_name" + ], + "note": "Path built by retentionPath() in apps/api-manager/src/lib/services/retention.ts; BANK_ID is the space, SYS when no bank is chosen. The page shows each item's Dynamic Entity name when there is one." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/aggregate-metrics", + "source": "apps/api-manager/src/routes/(protected)/system-activity-dashboard/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/aggregate-metrics?${aggregateMetricsQuery(win).toString()}`" + ], + "reads": [ + "count", + "distinct_user_count", + "distinct_consumer_count", + "consent_call_count", + "distinct_consent_count" + ], + "note": "unwrapAggregateMetric() also accepts an array and takes its first element." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users", + "source": "apps/api-manager/src/routes/(protected)/system-activity-dashboard/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users?${query.toString()}`" + ], + "reads": [ + "users[].created_date" + ], + "note": "Pages newest first and counts users created in each window." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/consumers", + "source": "apps/api-manager/src/routes/(protected)/system-activity-dashboard/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/management/consumers?${query.toString()}`" + ], + "reads": [ + "consumers[].created" + ], + "note": "Pages through consumers and counts those created in each window." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/aggregate-metrics", + "source": "apps/api-manager/src/routes/(protected)/system-activity-dashboard/active-consumers/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/aggregate-metrics?${windowQuery.toString()}`" + ], + "reads": [ + "count", + "distinct_consumer_count" + ], + "note": "Consistency check against the dashboard tile." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/metrics/top-consumers", + "source": "apps/api-manager/src/routes/(protected)/system-activity-dashboard/active-consumers/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/management/metrics/top-consumers?${windowQuery.toString()}&limit=${TOP_CONSUMERS_LIMIT}`" + ], + "reads": [ + "top_consumers[].consumer_id", + "top_consumers[].app_name", + "top_consumers[].developer_email", + "top_consumers[].count" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/aggregate-metrics", + "source": "apps/api-manager/src/routes/(protected)/system-activity-dashboard/active-users/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/aggregate-metrics?${windowQuery.toString()}`" + ], + "reads": [ + "count", + "distinct_user_count" + ], + "note": "Consistency check against the dashboard tile." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/metrics/top-users", + "source": "apps/api-manager/src/routes/(protected)/system-activity-dashboard/active-users/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/management/metrics/top-users?${windowQuery.toString()}&limit=${TOP_USERS_LIMIT}`" + ], + "reads": [ + "top_users[].user_id", + "top_users[].username", + "top_users[].count" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users", + "source": "apps/api-manager/src/routes/(protected)/system-activity-dashboard/new-users/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users?${query.toString()}`" + ], + "reads": [ + "users[].created_date", + "users[].user_id", + "users[].username", + "users[].email", + "users[].provider" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/cache/config", + "source": "apps/api-manager/src/routes/(protected)/system/cache/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/system/cache/config\"" + ], + "reads": [ + "instance_id", + "environment", + "global_prefix", + "redis_status.available", + "redis_status.url", + "redis_status.port", + "redis_status.use_ssl", + "in_memory_status.available", + "in_memory_status.current_size" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/cache/info", + "source": "apps/api-manager/src/routes/(protected)/system/cache/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/system/cache/info\"" + ], + "reads": [ + "total_keys", + "redis_available", + "namespaces[].namespace_id", + "namespaces[].description", + "namespaces[].key_count", + "namespaces[].prefix", + "namespaces[].current_version", + "namespaces[].category", + "namespaces[].storage_location", + "namespaces[].ttl_info" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/config-props", + "source": "apps/api-manager/src/routes/(protected)/system/config-props/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/management/config-props`" + ], + "reads": [ + "config_props[].name", + "config_props[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/database/pool", + "source": "apps/api-manager/src/routes/(protected)/system/database-pool/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/system/database/pool\"" + ], + "reads": [ + "pool_name", + "active_connections", + "idle_connections", + "total_connections", + "threads_awaiting_connection", + "maximum_pool_size", + "minimum_idle", + "connection_timeout_ms", + "idle_timeout_ms", + "max_lifetime_ms", + "keepalive_time_ms" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections", + "source": "apps/api-manager/src/routes/(protected)/system/featured-collections/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/api-collections`" + ], + "reads": [ + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description" + ], + "note": "Used to name and describe the featured collections." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections/featured", + "source": "apps/api-manager/src/routes/(protected)/system/featured-collections/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/api-collections/featured`" + ], + "reads": [ + "featured_api_collections[].api_collection_id", + "featured_api_collections[].sort_order" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections", + "source": "apps/api-manager/src/routes/(protected)/system/featured-collections/[collection_id]/delete/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/api-collections`" + ], + "reads": [ + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections/featured", + "source": "apps/api-manager/src/routes/(protected)/system/featured-collections/[collection_id]/delete/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/api-collections/featured`" + ], + "reads": [ + "featured_api_collections[].api_collection_id", + "featured_api_collections[].sort_order" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections", + "source": "apps/api-manager/src/routes/(protected)/system/featured-collections/[collection_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/api-collections`" + ], + "reads": [ + "api_collections[].api_collection_id", + "api_collections[].api_collection_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections/featured", + "source": "apps/api-manager/src/routes/(protected)/system/featured-collections/[collection_id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/api-collections/featured`" + ], + "reads": [ + "featured_api_collections[].api_collection_id", + "featured_api_collections[].sort_order" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections", + "source": "apps/api-manager/src/routes/(protected)/system/featured-collections/add/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/api-collections`" + ], + "reads": [ + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections/featured", + "source": "apps/api-manager/src/routes/(protected)/system/featured-collections/add/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/api-collections/featured`" + ], + "reads": [ + "featured_api_collections[].api_collection_id" + ], + "note": "Used to leave already featured collections out of the choice." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/features", + "source": "apps/api-manager/src/routes/(protected)/system/features/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/features\"" + ], + "reads": [], + "note": "The page lists every key of the response with Object.entries, so no single field is read by name." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/log-cache/all", + "source": "apps/api-manager/src/routes/(protected)/system/log-cache/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/system/log-cache/${level}`" + ], + "reads": [ + "entries[].timestamp", + "entries[].message", + "entries[].level|entries[].log_level" + ], + "undocumented_fields": [ + "entries[].timestamp", + "entries[].message", + "entries[].level|entries[].log_level" + ], + "note": "The level segment is the lower-cased level picker value (ALL, ERROR, WARNING, INFO, DEBUG; empty means all), so the call reaches this one of five documented paths. The code also accepts a bare array instead of entries." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/log-cache/debug", + "source": "apps/api-manager/src/routes/(protected)/system/log-cache/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/system/log-cache/${level}`" + ], + "reads": [ + "entries[].timestamp", + "entries[].message", + "entries[].level|entries[].log_level" + ], + "undocumented_fields": [ + "entries[].timestamp", + "entries[].message", + "entries[].level|entries[].log_level" + ], + "note": "The level segment is the lower-cased level picker value (ALL, ERROR, WARNING, INFO, DEBUG; empty means all), so the call reaches this one of five documented paths. The code also accepts a bare array instead of entries." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/log-cache/error", + "source": "apps/api-manager/src/routes/(protected)/system/log-cache/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/system/log-cache/${level}`" + ], + "reads": [ + "entries[].timestamp", + "entries[].message", + "entries[].level|entries[].log_level" + ], + "undocumented_fields": [ + "entries[].timestamp", + "entries[].message", + "entries[].level|entries[].log_level" + ], + "note": "The level segment is the lower-cased level picker value (ALL, ERROR, WARNING, INFO, DEBUG; empty means all), so the call reaches this one of five documented paths. The code also accepts a bare array instead of entries." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/log-cache/info", + "source": "apps/api-manager/src/routes/(protected)/system/log-cache/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/system/log-cache/${level}`" + ], + "reads": [ + "entries[].timestamp", + "entries[].message", + "entries[].level|entries[].log_level" + ], + "undocumented_fields": [ + "entries[].timestamp", + "entries[].message", + "entries[].level|entries[].log_level" + ], + "note": "The level segment is the lower-cased level picker value (ALL, ERROR, WARNING, INFO, DEBUG; empty means all), so the call reaches this one of five documented paths. The code also accepts a bare array instead of entries." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/log-cache/warning", + "source": "apps/api-manager/src/routes/(protected)/system/log-cache/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/system/log-cache/${level}`" + ], + "reads": [ + "entries[].timestamp", + "entries[].message", + "entries[].level|entries[].log_level" + ], + "undocumented_fields": [ + "entries[].timestamp", + "entries[].message", + "entries[].level|entries[].log_level" + ], + "note": "The level segment is the lower-cased level picker value (ALL, ERROR, WARNING, INFO, DEBUG; empty means all), so the call reaches this one of five documented paths. The code also accepts a bare array instead of entries." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/migrations", + "source": "apps/api-manager/src/routes/(protected)/system/migrations/+page.svelte", + "needles": [ + "fetch(\"/proxy/obp/v6.0.0/system/migrations\")" + ], + "reads": [ + "migration_script_logs[].name", + "migration_script_logs[].is_successful", + "migration_script_logs[].migration_script_log_id", + "migration_script_logs[].created_at|migration_script_logs[].start_date", + "migration_script_logs[].remark" + ], + "note": "The code also accepts a bare array or migrations/entries/logs lists, and falls back to id and description when migration_script_log_id or remark is empty." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/ip-penalties", + "source": "apps/api-manager/src/routes/(protected)/system/rate-limiting/+page.svelte", + "needles": [ + "fetch(\"/proxy/obp/v7.0.0/management/ip-penalties\");" + ], + "reads": [ + "ip_penalties[].ip_address", + "ip_penalties[].per_minute_limit", + "ip_penalties[].expires_at", + "ip_penalties[].reason", + "ip_penalties[].created_by_user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/ip-penalties", + "source": "apps/api-manager/src/routes/(protected)/system/rate-limiting/+page.svelte", + "needles": [ + "fetch(\"/proxy/obp/v7.0.0/management/ip-penalties\", {" + ], + "reads": [], + "note": "Only the status is checked; the list is fetched again afterwards." + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/ip-penalties/IP_ADDRESS", + "source": "apps/api-manager/src/routes/(protected)/system/rate-limiting/+page.svelte", + "needles": [ + "`/proxy/obp/v7.0.0/management/ip-penalties/${encodeURIComponent(ipAddress)}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/rate-limiter-config", + "source": "apps/api-manager/src/routes/(protected)/system/rate-limiting/+page.svelte", + "needles": [ + "\"/proxy/obp/v7.0.0/management/rate-limiter-config\"" + ], + "reads": [ + "rate_limiters[].order", + "rate_limiters[].name", + "rate_limiters[].error_code", + "rate_limiters[].enabled", + "rate_limiters[].keyed_by", + "rate_limiters[].runs", + "rate_limiters[].mode", + "rate_limiters[].props_prefix", + "rate_limiters[].limits[].scope", + "rate_limiters[].limits[].covers", + "rate_limiters[].limits[].mode", + "rate_limiters[].limits[].per_second", + "rate_limiters[].limits[].per_minute", + "rate_limiters[].limits[].per_hour", + "rate_limiters[].limits[].per_day", + "rate_limiters[].limits[].per_week", + "rate_limiters[].limits[].per_month", + "rate_limiters[].limits[].global_per_hour" + ], + "undocumented_fields": [ + "rate_limiters[].limits[].per_second", + "rate_limiters[].limits[].per_week", + "rate_limiters[].limits[].per_month" + ], + "note": "The table shows each window (per_second to per_month, global_per_hour) that at least one limit row reports." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/rate-limits", + "source": "apps/api-manager/src/routes/(protected)/system/rate-limiting/+page.svelte", + "needles": [ + "\"/proxy/obp/v7.0.0/management/rate-limits\"" + ], + "reads": [ + "rate_limits[].rate_limiting_id", + "rate_limits[].is_active", + "rate_limits[].consumer_id", + "rate_limits[].consumer_name", + "rate_limits[].from_date", + "rate_limits[].to_date", + "rate_limits[].per_second_call_limit", + "rate_limits[].per_minute_call_limit", + "rate_limits[].per_hour_call_limit", + "rate_limits[].per_day_call_limit", + "rate_limits[].per_week_call_limit", + "rate_limits[].per_month_call_limit", + "rate_limits[].api_version", + "rate_limits[].api_name", + "rate_limits[].bank_id" + ], + "undocumented_fields": [ + "rate_limits[].api_version", + "rate_limits[].api_name", + "rate_limits[].bank_id" + ], + "note": "scopeOf() describes each row's scope from api_version, api_name and bank_id." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/system/scheduler/job-locks", + "source": "apps/api-manager/src/routes/(protected)/system/scheduler-job-locks/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/management/system/scheduler/job-locks\"" + ], + "reads": [ + "jobs[].job_id", + "jobs[].name", + "jobs[].api_instance_id", + "jobs[].started_at", + "jobs[].age_seconds" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/system/scheduler/job-locks", + "source": "apps/api-manager/src/routes/(protected)/system/scheduler-job-locks/[job_id]/delete/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/management/system/scheduler/job-locks\"" + ], + "reads": [ + "jobs[].job_id", + "jobs[].name", + "jobs[].api_instance_id", + "jobs[].started_at", + "jobs[].age_seconds" + ], + "note": "The lock to delete is found in the list by job_id." + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/system/scheduler/job-locks/JOB_ID", + "source": "apps/api-manager/src/routes/(protected)/system/scheduler-job-locks/[job_id]/delete/+page.svelte", + "needles": [ + "`/proxy/obp/v7.0.0/management/system/scheduler/job-locks/${encodeURIComponent(data.jobId)}`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/self-test-emails", + "source": "apps/api-manager/src/routes/(protected)/system/self-test-emails/+page.svelte", + "needles": [ + "\"/proxy/obp/v7.0.0/management/self-test-emails\"" + ], + "reads": [ + "to", + "from", + "subject", + "message_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/signal-channels/stats", + "source": "apps/api-manager/src/routes/(protected)/system/signal-channels-stats/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/signal-channels/stats\"" + ], + "reads": [ + "total_channels", + "total_messages", + "channels[].channel_name", + "channels[].message_count", + "channels[].ttl_seconds" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/signal-channels", + "source": "apps/api-manager/src/routes/(protected)/system/signal-channels/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/signal-channels\"" + ], + "reads": [ + "channels[].channel_name", + "channels[].message_count", + "channels[].ttl_seconds" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/signal-channels/CHANNEL_NAME", + "source": "apps/api-manager/src/routes/(protected)/system/signal-channels/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/signal-channels/${encodeURIComponent(channelName)}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/signal-channels/CHANNEL_NAME/messages", + "source": "apps/api-manager/src/routes/(protected)/system/signal-channels/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/signal-channels/${encodeURIComponent(channelName)}/messages?limit=50`" + ], + "reads": [ + "messages[].message_id", + "messages[].payload", + "messages[].payload.in_reply_to", + "messages[].timestamp", + "messages[].message_type", + "messages[].to_user_id", + "messages[].sender_user_id", + "messages[].sender_consumer_id", + "total_count", + "has_more" + ], + "undocumented_fields": [ + "messages[].payload.in_reply_to", + "messages[].to_user_id" + ], + "note": "payload is free-form JSON; the page threads replies by payload.in_reply_to and marks private messages by to_user_id." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/signal-channels/CHANNEL_NAME/messages", + "source": "apps/api-manager/src/routes/(protected)/system/signal-publish/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/signal-channels/${encodeURIComponent(channelName.trim())}/messages`" + ], + "reads": [ + "message_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/webui-props", + "source": "apps/api-manager/src/routes/(protected)/system/webui-props/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/webui-props?what=${filter}`" + ], + "reads": [ + "webui_props[].name", + "webui_props[].value", + "webui_props[].source" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/webui-props", + "source": "apps/api-manager/src/routes/(protected)/system/webui-props/[id]/delete/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/webui-props?what=database`" + ], + "reads": [ + "webui_props[].name", + "webui_props[].web_ui_props_id", + "webui_props[].value" + ], + "note": "The prop is found in the list by name." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/webui-props", + "source": "apps/api-manager/src/routes/(protected)/system/webui-props/[id]/edit/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/webui-props?what=active`" + ], + "reads": [ + "webui_props[].name", + "webui_props[].source", + "webui_props[].value" + ], + "note": "The prop is found in the list by name." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/telemetry", + "source": "apps/api-manager/src/routes/(protected)/telemetry/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/management/telemetry\"" + ], + "reads": [ + "api_instance_id", + "git_commit", + "port.enabled", + "port.path", + "port.port", + "meters[].name", + "meters[].type", + "meters[].tags", + "meters[].measurements", + "meters[].base_unit" + ], + "undocumented_fields": [ + "meters[].base_unit" + ], + "note": "The page and the summarise* helpers in apps/api-manager/src/lib/telemetry pick meters by name and read their tags and measurements." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/traffic/top-callers", + "source": "apps/api-manager/src/routes/(protected)/telemetry/+page.svelte", + "needles": [ + "`/proxy/obp/v7.0.0/management/traffic/top-callers?window=${trafficWindow}`" + ], + "reads": [ + "consumers[].consumer_id", + "consumers[].application_name", + "consumers[].requests", + "consumers[].error", + "consumers[].status_2xx", + "consumers[].status_4xx", + "consumers[].status_5xx", + "consumers[].refused", + "consumers[].last_ip_address", + "addresses[].ip_address", + "addresses[].requests", + "addresses[].error", + "addresses[].status_2xx", + "addresses[].status_4xx", + "addresses[].status_5xx", + "addresses[].unmatched", + "addresses[].consumer_ids", + "callers_and_endpoints[].caller_kind", + "callers_and_endpoints[].caller", + "callers_and_endpoints[].endpoint", + "callers_and_endpoints[].api_version", + "callers_and_endpoints[].requests", + "callers_and_endpoints[].error", + "callers_and_endpoints[].status_4xx", + "callers_and_endpoints[].status_5xx", + "callers_and_endpoints[].mean_duration_ms", + "callers_and_endpoints[].max_duration_ms" + ], + "undocumented_fields": [ + "callers_and_endpoints[].api_version" + ], + "note": "api_version links each caller endpoint row to the API Metrics search." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/user-invitations", + "source": "apps/api-manager/src/routes/(protected)/user-invitations/+page.svelte", + "needles": [ + "`/proxy/obp/v5.1.0/banks/${encodeURIComponent(selectedBankId)}/user-invitations`" + ], + "reads": [ + "user_invitations[].first_name", + "user_invitations[].last_name", + "user_invitations[].email", + "user_invitations[].company", + "user_invitations[].country", + "user_invitations[].purpose", + "user_invitations[].status", + "user_invitations[].created" + ], + "undocumented_fields": [ + "user_invitations[].first_name", + "user_invitations[].last_name", + "user_invitations[].email", + "user_invitations[].company", + "user_invitations[].country", + "user_invitations[].purpose", + "user_invitations[].status", + "user_invitations[].created" + ], + "note": "The code reads a user_invitations list; the documented response lists one invitation's fields at the top level." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/entitlement-requests", + "source": "apps/api-manager/src/routes/(protected)/user/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/my/entitlement-requests`" + ], + "reads": [ + "entitlement_requests[].role_name", + "entitlement_requests[].bank_id", + "entitlement_requests[].created" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/consents", + "source": "apps/api-manager/src/routes/(protected)/user/consents/+page.server.ts", + "needles": [ + "'/obp/v6.0.0/my/consents'" + ], + "reads": [ + "consents[].consent_id", + "consents[].status", + "consents[].last_action_date", + "consents[].consumer_id", + "consents[].created_date", + "consents[].consent_reference_id", + "consents[].jwt", + "consents[].jwt_payload", + "consents[].last_usage_date", + "consents[].everything" + ], + "undocumented_fields": [ + "consents[].created_date", + "consents[].everything" + ], + "note": "The server filters and sorts; ConsentCard (packages/shared) renders each consent and also decodes jwt_payload or the JWT for its entitlements, views, exp and my_resources claims." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/my/consents/CONSENT_ID", + "source": "apps/api-manager/src/routes/(protected)/user/consents/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/my/consents/${consentId}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/consumers/CONSUMER_ID/scopes", + "source": "apps/api-manager/src/routes/(protected)/user/entitlements/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/consumers/${consumer.consumer_id}/scopes`" + ], + "reads": [ + "list[].role_name", + "list[].bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/api-manager/src/routes/(protected)/user/entitlements/+page.server.ts", + "needles": [ + "'/obp/v6.0.0/banks'" + ], + "reads": [ + "banks[].bank_id", + "banks[].full_name" + ], + "note": "Called without a token." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/consumers/current", + "source": "apps/api-manager/src/routes/(protected)/user/entitlements/+page.server.ts", + "needles": [ + "'/obp/v6.0.0/consumers/current'" + ], + "reads": [ + "consumer_id", + "app_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/entitlements", + "source": "apps/api-manager/src/routes/(protected)/user/entitlements/+page.server.ts", + "needles": [ + "'/obp/v6.0.0/my/entitlements'" + ], + "reads": [ + "list[].role_name", + "list[].bank_id", + "list[].entitlement_id" + ], + "note": "After adding an entitlement the whole response is stored in the session as the user's entitlements." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "source": "apps/api-manager/src/routes/(protected)/user/entitlements/+page.server.ts", + "needles": [ + "'/obp/v6.0.0/roles'" + ], + "reads": [ + "roles[].role", + "roles[].requires_bank_id" + ], + "note": "RoleSearchWidget shows the roles." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/USER_ID/entitlements", + "source": "apps/api-manager/src/routes/(protected)/user/entitlements/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users/${currentUserId}/entitlements`" + ], + "reads": [], + "note": "The response is only logged." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users", + "source": "apps/api-manager/src/routes/(protected)/users/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users?limit=100`" + ], + "reads": [ + "users[].created_date" + ], + "note": "The server sorts the users by created_date; the page does not render data.users (it searches through the browser call instead)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/api-manager/src/routes/(protected)/users/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/banks\"" + ], + "reads": [ + "banks[].bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/providers", + "source": "apps/api-manager/src/routes/(protected)/users/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/providers\"" + ], + "reads": [ + "providers" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "source": "apps/api-manager/src/routes/(protected)/users/+page.svelte", + "needles": [ + "\"/proxy/obp/v6.0.0/roles\"" + ], + "reads": [ + "roles[].role" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users", + "source": "apps/api-manager/src/routes/(protected)/users/+page.svelte", + "needles": [ + "`/proxy/obp/v6.0.0/users?${params.toString()}`" + ], + "reads": [ + "users[].username", + "users[].email", + "users[].user_id", + "users[].provider" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/provider/PROVIDER/username/USERNAME", + "source": "apps/api-manager/src/routes/(protected)/users/[provider]/[username]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users/provider/${encodeURIComponent(provider)}/username/${encodeURIComponent(username)}`" + ], + "reads": [ + "username", + "user_id", + "email", + "provider", + "created_date", + "last_login_date", + "is_locked", + "is_deleted", + "entitlements.list[].role_name|entitlements.list[].entitlement_id", + "entitlements.list[].bank_id", + "entitlements.list[].created_date", + "accounts[].id", + "accounts[].bank_id", + "accounts[].label", + "accounts[].account_type", + "accounts[].currency", + "views[].id", + "views[].name|views[].short_name", + "views[].description", + "views[].is_public" + ], + "undocumented_fields": [ + "created_date", + "last_login_date", + "entitlements.list[].created_date", + "accounts[].id", + "accounts[].bank_id", + "accounts[].label", + "accounts[].account_type", + "accounts[].currency", + "views[].id", + "views[].name|views[].short_name", + "views[].description", + "views[].is_public" + ], + "note": "The page reads views as a plain list of views and an accounts list, which the documented response does not have (it documents views.list[] with bank_id, account_id, view_id)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "source": "apps/api-manager/src/routes/(protected)/users/[provider]/[username]/lock/+page.server.ts", + "needles": [ + "const lockEndpoint = `/obp/v6.0.0/users/${encodeURIComponent(provider)}/${encodeURIComponent(username)}/lock-status`" + ], + "reads": [ + "bad_attempts_since_last_success_or_reset", + "last_failure_date" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/locks", + "source": "apps/api-manager/src/routes/(protected)/users/[provider]/[username]/lock/+page.server.ts", + "needles": [ + "const lockEndpoint = `/obp/v6.0.0/users/${encodeURIComponent(provider)}/${encodeURIComponent(username)}/locks`" + ], + "reads": [], + "note": "The response is only logged." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/provider/PROVIDER/username/USERNAME", + "source": "apps/api-manager/src/routes/(protected)/users/[provider]/[username]/lock/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users/provider/${encodeURIComponent(provider)}/username/${encodeURIComponent(username)}`" + ], + "reads": [ + "username", + "provider", + "is_locked" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "source": "apps/api-manager/src/routes/(protected)/users/[provider]/[username]/unlock/+page.server.ts", + "needles": [ + "const lockEndpoint = `/obp/v6.0.0/users/${encodeURIComponent(provider)}/${encodeURIComponent(username)}/lock-status`" + ], + "reads": [ + "bad_attempts_since_last_success_or_reset", + "last_failure_date" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "source": "apps/api-manager/src/routes/(protected)/users/[provider]/[username]/unlock/+page.server.ts", + "needles": [ + "const unlockEndpoint = `/obp/v6.0.0/users/${encodeURIComponent(provider)}/${encodeURIComponent(username)}/lock-status`" + ], + "reads": [], + "note": "Unlocks the user; the response is only logged." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/provider/PROVIDER/username/USERNAME", + "source": "apps/api-manager/src/routes/(protected)/users/[provider]/[username]/unlock/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users/provider/${encodeURIComponent(provider)}/username/${encodeURIComponent(username)}`" + ], + "reads": [ + "username", + "provider", + "is_locked" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/users/user-id/USER_ID", + "source": "apps/api-manager/src/routes/(protected)/users/[user_id]/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/users/user-id/${encodeURIComponent(user_id)}`" + ], + "reads": [ + "username", + "email", + "provider", + "user_id", + "email_validated", + "mobile_phone_number", + "mobile_phone_number_is_validated", + "mobile_phone_number_validated_date", + "created_date", + "last_login_date", + "is_locked", + "is_deleted", + "last_activity_date", + "recent_operation_ids", + "entitlements.list[].role_name|entitlements.list[].entitlement_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_request_process", + "entitlements.list[].group_id", + "entitlements.list[].created_date" + ], + "undocumented_fields": [ + "last_login_date", + "entitlements.list[].entitlement_request_process", + "entitlements.list[].group_id", + "entitlements.list[].created_date" + ], + "note": "Read by the user detail page." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "source": "apps/api-manager/src/routes/(protected)/users/[user_id]/lock/+page.server.ts", + "needles": [ + "const lockEndpoint = `/obp/v6.0.0/users/${encodeURIComponent(user.provider)}/${encodeURIComponent(user.username)}/lock-status`" + ], + "reads": [ + "bad_attempts_since_last_success_or_reset", + "last_failure_date" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/locks", + "source": "apps/api-manager/src/routes/(protected)/users/[user_id]/lock/+page.server.ts", + "needles": [ + "const lockEndpoint = `/obp/v6.0.0/users/${encodeURIComponent(user.provider)}/${encodeURIComponent(user.username)}/locks`" + ], + "reads": [], + "note": "Locks the user; the response is only logged." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user-id/USER_ID", + "source": "apps/api-manager/src/routes/(protected)/users/[user_id]/lock/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users/user-id/${encodeURIComponent(user_id)}`" + ], + "reads": [ + "provider", + "username", + "is_locked" + ], + "note": "Loaded in the page load and again in the action to get provider and username." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/user/reset-password-url", + "source": "apps/api-manager/src/routes/(protected)/users/[user_id]/reset-password/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/user/reset-password-url`" + ], + "reads": [ + "to", + "status" + ], + "note": "The action returns to as sentTo (shown) and status as apiStatus (not shown)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user-id/USER_ID", + "source": "apps/api-manager/src/routes/(protected)/users/[user_id]/reset-password/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users/user-id/${encodeURIComponent(user_id)}`" + ], + "reads": [ + "user_id", + "username", + "email", + "provider", + "email_validated" + ], + "note": "Loaded in the page load and again in the action." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "source": "apps/api-manager/src/routes/(protected)/users/[user_id]/unlock/+page.server.ts", + "needles": [ + "const lockEndpoint = `/obp/v6.0.0/users/${encodeURIComponent(user.provider)}/${encodeURIComponent(user.username)}/lock-status`" + ], + "reads": [ + "bad_attempts_since_last_success_or_reset", + "last_failure_date" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "source": "apps/api-manager/src/routes/(protected)/users/[user_id]/unlock/+page.server.ts", + "needles": [ + "const unlockEndpoint = `/obp/v6.0.0/users/${encodeURIComponent(user.provider)}/${encodeURIComponent(user.username)}/lock-status`" + ], + "reads": [], + "note": "Unlocks the user; the response is only logged." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user-id/USER_ID", + "source": "apps/api-manager/src/routes/(protected)/users/[user_id]/unlock/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users/user-id/${encodeURIComponent(user_id)}`" + ], + "reads": [ + "provider", + "username", + "is_locked" + ], + "note": "Loaded in the page load and again in the action to get provider and username." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user-id/USER_ID", + "source": "apps/api-manager/src/routes/(protected)/users/[user_id]/validate-email/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users/user-id/${encodeURIComponent(user_id)}`" + ], + "reads": [ + "username", + "email", + "provider", + "email_validated" + ], + "note": "Loaded in the page load and again in the action." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/users/validation-emails", + "source": "apps/api-manager/src/routes/(protected)/users/[user_id]/validate-email/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/users/validation-emails`" + ], + "reads": [ + "message" + ], + "note": "The action returns message as apiMessage, which the page does not show." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/features", + "source": "apps/api-manager/src/routes/+layout.server.ts", + "needles": [ + "\"/obp/v6.0.0/features\"" + ], + "reads": [ + "allow_just_in_time_entitlements" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/current", + "source": "apps/api-manager/src/routes/+layout.server.ts", + "needles": [ + "`${OBP_API_URL}/users/current`" + ], + "reads": [ + "user_id", + "email", + "username", + "entitlements.list", + "entitlements.list[].role_name" + ], + "note": "OBP_API_URL is `${PUBLIC_OBP_BASE_URL}/obp/v6.0.0` (lib/config.ts). The fresh user replaces the session user; the layout returns user_id, email, username and entitlements.list, and +layout.svelte checks entitlements by role_name." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/api-manager/src/routes/+layout.svelte", + "needles": [ + "`/proxy${dynamicEntityDefinitionsPath(DYNAMIC_ENTITY_SYSTEM_SPACE_BANK_ID)}`" + ], + "reads": [ + "dynamic_entities" + ], + "note": "System space (SYS); only the number of entities is used." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/abac-rules", + "source": "apps/api-manager/src/routes/backend/abac-rules/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/abac-rules`" + ], + "reads": [], + "note": "Returned to the browser as is; the create page only checks response.ok." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/abac-rules/ABAC_RULE_ID", + "source": "apps/api-manager/src/routes/backend/abac-rules/[rule_id]/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/abac-rules/${ruleId}`" + ], + "reads": [], + "note": "Returned to the browser as is; the edit page only checks response.ok." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/abac-rules/ABAC_RULE_ID/execute", + "source": "apps/api-manager/src/routes/backend/abac-rules/[rule_id]/execute/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/abac-rules/${ruleId}/execute`" + ], + "reads": [], + "note": "Returned to the browser as is; the test page shows the whole result as JSON." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/aggregate-metrics", + "source": "apps/api-manager/src/routes/backend/aggregate-metrics/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/aggregate-metrics?${queryString}`" + ], + "reads": [ + "count", + "average_response_time", + "minimum_response_time", + "maximum_response_time" + ], + "note": "Uses fetch on PUBLIC_OBP_BASE_URL directly; accepts an array (takes the first element) or an object." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/api-collections", + "source": "apps/api-manager/src/routes/backend/api-collections/+server.ts", + "needles": [ + "`/obp/v6.0.0/my/api-collections`" + ], + "reads": [ + "api_collection_id" + ], + "note": "The products bootstrap page reads api_collection_id of the created collection." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "source": "apps/api-manager/src/routes/backend/api-collections/[collection_id]/+server.ts", + "needles": [ + "`/obp/v6.0.0/my/api-collections/${collection_id}`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "source": "apps/api-manager/src/routes/backend/api-collections/[collection_id]/+server.ts", + "needles": [ + "`/obp/v6.0.0/my/api-collections/${collection_id}`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints", + "source": "apps/api-manager/src/routes/backend/api-collections/[collection_id]/endpoints/+server.ts", + "needles": [ + "`/obp/v6.0.0/my/api-collection-ids/${collection_id}/api-collection-endpoints`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/my/consents/IMPLICIT", + "source": "apps/api-manager/src/routes/backend/app-studio/consent/+server.ts", + "needles": [ + "\"/obp/v5.1.0/my/consents/IMPLICIT\"" + ], + "reads": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/users/current/consumers", + "source": "apps/api-manager/src/routes/backend/app-studio/consent/+server.ts", + "needles": [ + "`/obp/${API_VERSION}/management/users/current/consumers`", + "const API_VERSION = \"v6.0.0\"" + ], + "reads": [ + "consumers", + "consumers[].consumer_id", + "consumers[].app_name", + "consumers[].enabled" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/accounts", + "source": "apps/api-manager/src/routes/backend/app-studio/consent/+server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/accounts`", + "const API_VERSION = \"v6.0.0\"" + ], + "reads": [ + "accounts", + "accounts[].bank_id", + "accounts[].id", + "accounts[].label" + ], + "note": "Also accepts a bare array of accounts." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/entitlements", + "source": "apps/api-manager/src/routes/backend/app-studio/consent/+server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/entitlements`", + "const API_VERSION = \"v6.0.0\"" + ], + "reads": [ + "list", + "list[].role_name", + "list[].bank_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge", + "source": "apps/api-manager/src/routes/backend/app-studio/consent/challenge/+server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${encodeURIComponent(bankId)}/consents/${encodeURIComponent(consentId)}/challenge`" + ], + "reads": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/cache/namespaces/invalidate", + "source": "apps/api-manager/src/routes/backend/cache/invalidate/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/cache/namespaces/invalidate`" + ], + "reads": [ + "old_version", + "new_version" + ], + "note": "The system cache page shows old_version and new_version." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/connector/metrics", + "source": "apps/api-manager/src/routes/backend/connector-metrics/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/connector/metrics?${queryParams.toString()}`" + ], + "reads": [ + "metrics", + "metrics[].connector_name", + "metrics[].function_name", + "metrics[].correlation_id", + "metrics[].date", + "metrics[].duration" + ], + "note": "The connector-metrics page renders these fields of each metric." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms", + "source": "apps/api-manager/src/routes/backend/developer-faq/[id]/chat-room/+server.ts", + "needles": [ + "\"/obp/v6.0.0/chat-rooms\"" + ], + "reads": [ + "chat_room_id", + "joining_key", + "name" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host", + "source": "apps/api-manager/src/routes/backend/dynamic-endpoints/bank/[bank_id]/[id]/host/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/banks/${bank_id}/dynamic-endpoints/${id}/host`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host", + "source": "apps/api-manager/src/routes/backend/dynamic-endpoints/system/[id]/host/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/dynamic-endpoints/${id}/host`" + ], + "reads": [] + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID", + "source": "apps/api-manager/src/routes/backend/dynamic-entities/[id]/+server.ts", + "needles": [ + "const definitions = dynamicEntityDefinitionsPath(bankId);", + "`${definitions}/${id}`" + ], + "reads": [], + "note": "Used when cascade is not requested; the pages only check response.ok." + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/cascade/DYNAMIC_ENTITY_ID", + "source": "apps/api-manager/src/routes/backend/dynamic-entities/[id]/+server.ts", + "needles": [ + "const definitions = dynamicEntityDefinitionsPath(bankId);", + "`${definitions}/cascade/${id}`" + ], + "reads": [], + "note": "Used when the query has cascade=true." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/backup", + "source": "apps/api-manager/src/routes/backend/dynamic-entities/[id]/backup/+server.ts", + "needles": [ + "`${dynamicEntityDefinitionsPath(bankId)}/${id}/backup`" + ], + "reads": [ + "entity_name" + ], + "note": "The dynamic-entities pages show the backup's entity_name." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/api-collections/featured", + "source": "apps/api-manager/src/routes/backend/featured-collections/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/api-collections/featured`" + ], + "reads": [] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/api-collections/featured/API_COLLECTION_ID", + "source": "apps/api-manager/src/routes/backend/featured-collections/[collection_id]/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/api-collections/featured/${collection_id}`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/api-collections/featured/API_COLLECTION_ID", + "source": "apps/api-manager/src/routes/backend/featured-collections/[collection_id]/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/api-collections/featured/${collection_id}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/files/FILE_ID/content", + "source": "apps/api-manager/src/routes/backend/files/[bank_id]/[file_id]/content/+server.ts", + "needles": [ + "fileContentPath(params.bank_id, params.file_id)" + ], + "reads": [], + "note": "Path built by fileContentPath in lib/server/files.ts; the file bytes and selected headers are passed through to the browser unread." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/connector-methods", + "source": "apps/api-manager/src/routes/backend/integration/connector-methods/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/connector-methods`" + ], + "reads": [ + "connectors_methods" + ], + "note": "Returns the connectors_methods array to the browser; no page calls this backend route at present." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/method_routings", + "source": "apps/api-manager/src/routes/backend/integration/method-routings/+server.ts", + "needles": [ + "`/obp/v5.1.0/management/method_routings${queryString ? `?${queryString}` : \"\"}`" + ], + "reads": [ + "method_routings", + "method_routings[].method_routing_id", + "method_routings[].method_name", + "method_routings[].connector_name", + "method_routings[].is_bank_id_exact_match", + "method_routings[].bank_id_pattern", + "method_routings[].parameters", + "method_routings[].parameters[].key", + "method_routings[].parameters[].value" + ], + "note": "Returned as is to lib/services/methodRoutings.ts fetchMethodRoutings (which also accepts a bare array or items); the method-routings pages read these fields. Query parameters such as active=true are passed through." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/method_routings", + "source": "apps/api-manager/src/routes/backend/integration/method-routings/+server.ts", + "needles": [ + "`/obp/v5.1.0/management/method_routings`" + ], + "reads": [] + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/method_routings/METHOD_ROUTING_ID", + "source": "apps/api-manager/src/routes/backend/integration/method-routings/+server.ts", + "needles": [ + "`/obp/v5.1.0/management/method_routings/${encodeURIComponent(methodRoutingId)}`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/management/method_routings/METHOD_ROUTING_ID", + "source": "apps/api-manager/src/routes/backend/integration/method-routings/+server.ts", + "needles": [ + "`/obp/v5.1.0/management/method_routings/${methodRoutingId}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/customer-account-links", + "source": "apps/api-manager/src/routes/backend/obp/banks/[bank_id]/accounts/[account_id]/customer-account-links/+server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${encodeURIComponent(bank_id)}/accounts/${encodeURIComponent(account_id)}/customer-account-links`" + ], + "reads": [ + "links", + "links[].bank_id", + "links[].customer_id", + "links[].customer_account_link_id", + "links[].relationship_type" + ], + "note": "The account-access account page and the customers graph page render the links." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/owner/account", + "source": "apps/api-manager/src/routes/backend/obp/banks/[bank_id]/accounts/[account_id]/customer-account-links/+server.ts", + "needles": [ + "`/obp/v6.0.0/banks/${encodeURIComponent(bank_id)}/accounts/${encodeURIComponent(account_id)}/owner/account`" + ], + "reads": [ + "label", + "account_routings", + "account_routings[].address" + ], + "note": "View is the literal owner; the customers graph page labels the account with account_routings[0].address." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID", + "source": "apps/api-manager/src/routes/backend/obp/banks/[bank_id]/accounts/[account_id]/customer-account-links/+server.ts", + "needles": [ + "`/obp/v6.0.0/banks/${encodeURIComponent(link.bank_id)}/customers/${encodeURIComponent(link.customer_id)}`" + ], + "reads": [ + "legal_name" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/BANK_ACCOUNT_ID/views", + "source": "apps/api-manager/src/routes/backend/obp/banks/[bank_id]/accounts/[account_id]/views/+server.ts", + "needles": [ + "`/obp/v6.0.0/banks/${bank_id}/accounts/${account_id}/views`" + ], + "reads": [ + "id" + ], + "note": "id is only written to the log; the custom-views create page ignores the result." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/customer-account-links", + "source": "apps/api-manager/src/routes/backend/obp/banks/[bank_id]/customers/[customer_id]/customer-account-links/+server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${encodeURIComponent(bank_id)}/customers/${encodeURIComponent(customer_id)}/customer-account-links`" + ], + "reads": [ + "links", + "links[].bank_id", + "links[].account_id", + "links[].customer_account_link_id", + "links[].relationship_type" + ], + "note": "The customer page, the account-links page and the customers graph page render the links." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/owner/account", + "source": "apps/api-manager/src/routes/backend/obp/banks/[bank_id]/customers/[customer_id]/customer-account-links/+server.ts", + "needles": [ + "`/obp/v6.0.0/banks/${encodeURIComponent(link.bank_id)}/accounts/${encodeURIComponent(link.account_id)}/owner/account`" + ], + "reads": [ + "label", + "account_routings", + "account_routings[].address" + ], + "note": "View is the literal owner; copied into each link as account_label and account_routings, and the graph page uses account_routings[0].address." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID", + "source": "apps/api-manager/src/routes/backend/obp/banks/[bank_id]/customers/[customer_id]/customer-links/+server.ts", + "needles": [ + "`/obp/v6.0.0/banks/${encodeURIComponent(link.other_bank_id)}/customers/${encodeURIComponent(link.other_customer_id)}`" + ], + "reads": [ + "legal_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID/customer-links", + "source": "apps/api-manager/src/routes/backend/obp/banks/[bank_id]/customers/[customer_id]/customer-links/+server.ts", + "needles": [ + "`/obp/v6.0.0/banks/${encodeURIComponent(bank_id)}/customers/${encodeURIComponent(customer_id)}/customer-links`" + ], + "reads": [ + "customer_links", + "customer_links[].other_bank_id", + "customer_links[].other_customer_id", + "customer_links[].relationship_to" + ], + "note": "The customers graph page draws the related customers from these fields." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/entitlement-requests", + "source": "apps/api-manager/src/routes/backend/rbac/entitlement-requests/+server.ts", + "needles": [ + "`/obp/v6.0.0/entitlement-requests`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/users/USER_ID/entitlements", + "source": "apps/api-manager/src/routes/backend/rbac/entitlements/+server.ts", + "needles": [ + "`/obp/v7.0.0/users/${user_id}/entitlements`" + ], + "reads": [] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/entitlements/ENTITLEMENT_ID", + "source": "apps/api-manager/src/routes/backend/rbac/entitlements/[entitlement_id]/+server.ts", + "needles": [ + "`/obp/v6.0.0/entitlements/${entitlement_id}`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/groups", + "source": "apps/api-manager/src/routes/backend/rbac/groups/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/groups`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups", + "source": "apps/api-manager/src/routes/backend/rbac/memberships/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/groups`" + ], + "reads": [ + "groups", + "groups[].group_id" + ], + "note": "The GET handler of this backend route has no caller in the app at present; groups are returned to the browser as is." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups/GROUP_ID/entitlements", + "source": "apps/api-manager/src/routes/backend/rbac/memberships/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/groups/${group.group_id}/entitlements`" + ], + "reads": [ + "entitlements" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/USER_ID/group-entitlements", + "source": "apps/api-manager/src/routes/backend/rbac/memberships/+server.ts", + "needles": [ + "`/obp/v6.0.0/users/${user_id}/group-entitlements`" + ], + "reads": [ + "group_id", + "group_name", + "bank_id", + "target_entitlements", + "target_entitlements[]", + "entitlements_created", + "entitlements_created[]", + "entitlements_skipped", + "entitlements_skipped[]" + ], + "note": "The memberships create page shows the result; it overrides user_id with its own value." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/system-views", + "source": "apps/api-manager/src/routes/backend/system-views/+server.ts", + "needles": [ + "`/obp/v6.0.0/system-views`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/system-views/SYS_VIEW_ID", + "source": "apps/api-manager/src/routes/backend/system-views/[view_id]/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/system-views/${view_id}`" + ], + "reads": [], + "undocumented_endpoint": "OBP-API documents /obp/v6.0.0/management/system-views/SYS_VIEW_ID only for GET; PUT of a system view is documented at /obp/v6.0.0/system-views/UPD_VIEW_ID (updateSystemView)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/connectors", + "source": "apps/api-manager/src/routes/backend/system/connectors/+server.ts", + "needles": [ + "`/obp/v6.0.0/system/connectors`" + ], + "reads": [ + "connectors", + "connectors[].connector_name", + "connectors[].is_available_in_method_routing" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/user-invitation", + "source": "apps/api-manager/src/routes/backend/user-invitations/create/+server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${bank_id}/user-invitation`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/personal-data-fields", + "source": "apps/api-manager/src/routes/backend/user/preferences/+server.ts", + "needles": [ + "`/obp/v6.0.0/my/personal-data-fields`" + ], + "reads": [ + "user_attributes", + "user_attributes[].name", + "user_attributes[].value", + "user_attributes[].user_attribute_id" + ], + "note": "Read by lib/stores/currentBank.svelte.ts and lib/stores/userPreferences.svelte.ts through this backend route." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/personal-data-fields", + "source": "apps/api-manager/src/routes/backend/user/preferences/+server.ts", + "needles": [ + "`/obp/v6.0.0/my/personal-data-fields`" + ], + "reads": [ + "user_attribute_id" + ], + "note": "The preference stores keep the new user_attribute_id." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "source": "apps/api-manager/src/routes/backend/user/preferences/+server.ts", + "needles": [ + "`/obp/v6.0.0/my/personal-data-fields/${encodeURIComponent(user_attribute_id)}`" + ], + "reads": [ + "user_attribute_id" + ], + "note": "userPreferences.svelte.ts keeps user_attribute_id from the response." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/webui_props/WEBUI_PROP_NAME", + "source": "apps/api-manager/src/routes/backend/webui-props/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/webui_props/${name}`" + ], + "reads": [], + "note": "The prop name comes from the request body; no page calls this backend route at present." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/webui_props/WEBUI_PROP_NAME", + "source": "apps/api-manager/src/routes/backend/webui-props/[id]/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/webui_props/${id}`" + ], + "reads": [], + "note": "The delete page passes the prop name, which matches OBPv6.0.0-deleteWebUiProps (the docs also list OBPv3.1.0-deleteWebUiProps at the same shape with WEB_UI_PROPS_ID)." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/webui_props/WEBUI_PROP_NAME", + "source": "apps/api-manager/src/routes/backend/webui-props/[id]/+server.ts", + "needles": [ + "`/obp/v6.0.0/management/webui_props/${id}`" + ], + "reads": [], + "note": "Called by WebUiPropForm with the prop name in the URL." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/current", + "source": "apps/api-manager/src/routes/login/[provider]/callback/+server.ts", + "needles": [ + "`${OBP_API_URL}/users/current`" + ], + "reads": [ + "user_id", + "email", + "username" + ], + "note": "OBP_API_URL is `${PUBLIC_OBP_BASE_URL}/obp/v6.0.0` (lib/config.ts). The whole user is stored in the session after login." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/current", + "source": "apps/api-manager/src/routes/login/obp/callback/+server.ts", + "needles": [ + "`${OBP_API_URL}/users/current`" + ], + "reads": [ + "user_id", + "email", + "username" + ], + "note": "OBP_API_URL is `${PUBLIC_OBP_BASE_URL}/obp/v6.0.0` (lib/config.ts). The whole user is stored in the session after login." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/app-directory", + "source": "apps/cohort/src/lib/server/appDirectory.ts", + "needles": [ + "'/obp/v6.0.0/app-directory'" + ], + "reads": [ + "app_directory[].name", + "app_directory[].value" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links", + "source": "apps/cohort/src/lib/server/customers.ts", + "needles": [ + "`/obp/v5.1.0/banks/${space()}/user_customer_links`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/customers", + "source": "apps/cohort/src/lib/server/customers.ts", + "needles": [ + "`/obp/v6.0.0/banks/${space()}/customers`" + ], + "reads": [ + "customer_id" + ], + "note": "Creates the applicant's INDIVIDUAL Customer with Cohort's application token." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/my/customers", + "source": "apps/cohort/src/lib/server/customers.ts", + "needles": [ + "`/obp/v7.0.0/banks/${space()}/my/customers`" + ], + "reads": [ + "customers[].customer_id", + "customers[].legal_name", + "customers[].mobile_phone_number", + "customers[].email" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/files", + "source": "apps/cohort/src/lib/server/files.ts", + "needles": [ + "obpRequests.get(`${filesPath()}?${query}`, token)", + "const filesPath = () => `/obp/v7.0.0/banks/${encodeURIComponent(cohortSpace())}/files`;" + ], + "reads": [ + "files[].file_id", + "files[].file_name", + "files[].media_type", + "files[].size_in_bytes", + "files[].scan_status", + "files[].scan_status_reason", + "files[].owner_user_id", + "files[].created_at" + ], + "note": "Query record_type and record_id select the files attached to one record." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/files/FILE_ID/content", + "source": "apps/cohort/src/lib/server/files.ts", + "needles": [ + "fetch(`${env.PUBLIC_OBP_BASE_URL}${filesPath()}/${encodeURIComponent(fileId)}/content`", + "const filesPath = () => `/obp/v7.0.0/banks/${encodeURIComponent(cohortSpace())}/files`;" + ], + "reads": [], + "note": "Raw file bytes, passed on unread to the download route." + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/banks/BANK_ID/files/FILE_ID/scan-status", + "source": "apps/cohort/src/lib/server/files.ts", + "needles": [ + "obpRequests.put(`${filesPath()}/${encodeURIComponent(fileId)}/scan-status`", + "const filesPath = () => `/obp/v7.0.0/banks/${encodeURIComponent(cohortSpace())}/files`;" + ], + "reads": [ + "file_id", + "file_name", + "media_type", + "size_in_bytes", + "scan_status", + "scan_status_reason", + "owner_user_id", + "created_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/banks/BANK_ID/my/files", + "source": "apps/cohort/src/lib/server/files.ts", + "needles": [ + "`/obp/v7.0.0/banks/${encodeURIComponent(cohortSpace())}/my/files`" + ], + "reads": [ + "file_id", + "file_name", + "media_type", + "size_in_bytes", + "scan_status", + "scan_status_reason", + "owner_user_id", + "created_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "apps/cohort/src/lib/server/forms.ts", + "needles": [ + "obpRequests.post(path, definition, token)", + "const path = dynamicEntityDefinitionsPath(cohortFormsSpace());" + ], + "reads": [ + "dynamic_entity_id" + ], + "note": "Creates a published form's answers entity in the forms space." + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID", + "source": "apps/cohort/src/lib/server/forms.ts", + "needles": [ + "obpRequests.put(`${path}/${encodeURIComponent(form.dynamic_entity_id)}`, definition, token)", + "const path = dynamicEntityDefinitionsPath(cohortFormsSpace());" + ], + "reads": [], + "note": "Adds a published form's new questions to its answers entity in the forms space; the path comes from the shared dynamicEntityDefinitionsPath." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/banks/BANK_ID/customers/CUSTOMER_ID/emails", + "source": "apps/cohort/src/lib/server/notify.ts", + "needles": [ + "`/obp/v7.0.0/banks/${encodeURIComponent(cohortSpace())}/customers/${encodeURIComponent(customerId)}/emails`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/well-known", + "source": "apps/cohort/src/lib/server/oauth.ts", + "needles": [ + "'/obp/v5.1.0/well-known'" + ], + "reads": [ + "well_known_uris[].provider", + "well_known_uris[].url" + ], + "undocumented_fields": [ + "well_known_uris[].provider", + "well_known_uris[].url" + ], + "note": "Cohort passes this path to the shared OAuth2ProviderManager, which GETs it (providerManager.ts fetchWellKnownUris) and reads each provider and url." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/customers", + "source": "apps/cohort/src/lib/server/organisationCustomers.ts", + "needles": [ + "`/obp/v7.0.0/banks/${space}/customers?${attributeQuery}&limit=${PAGE_SIZE}&offset=${page * PAGE_SIZE}`" + ], + "reads": [ + "customers[].customer_id", + "customers[].legal_name", + "customers[].customer_attributes[].name", + "customers[].customer_attributes[].value" + ], + "note": "Filtered by the organisation_kind Customer Attribute and paged; organisationOfCustomer reads the name, id and attributes." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links", + "source": "apps/cohort/src/lib/server/participants.ts", + "needles": [ + "`/obp/v5.1.0/banks/${space}/user_customer_links`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/customers", + "source": "apps/cohort/src/lib/server/participants.ts", + "needles": [ + "`/obp/v6.0.0/banks/${space}/customers`" + ], + "reads": [ + "customer_id" + ], + "note": "Registers a startup's CORPORATE Customer with Cohort's application token." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "source": "apps/cohort/src/lib/server/retention.ts", + "needles": [ + "obpRequests.get(`${base()}/retention-policies`, token)", + "const base = () => `/obp/v7.0.0/management/banks/${encodeURIComponent(cohortSpace())}`;" + ], + "reads": [ + "retention_policies[].retention_policy_id", + "retention_policies[].bank_id", + "retention_policies[].resource_type", + "retention_policies[].entity_name", + "retention_policies[].date_basis", + "retention_policies[].condition.field", + "retention_policies[].condition.value", + "retention_policies[].retain_days", + "retention_policies[].archive_days", + "retention_policies[].action", + "retention_policies[].cascade", + "retention_policies[].requires_approval", + "retention_policies[].enabled" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "source": "apps/cohort/src/lib/server/retention.ts", + "needles": [ + "obpRequests.post(`${base()}/retention-policies`, body, token)", + "const base = () => `/obp/v7.0.0/management/banks/${encodeURIComponent(cohortSpace())}`;" + ], + "reads": [], + "note": "The result goes to the staff form's write() helper, which ignores it." + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "source": "apps/cohort/src/lib/server/retention.ts", + "needles": [ + "obpRequests.delete(`${base()}/retention-policies/${encodeURIComponent(id)}`, token)", + "const base = () => `/obp/v7.0.0/management/banks/${encodeURIComponent(cohortSpace())}`;" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "source": "apps/cohort/src/lib/server/retention.ts", + "needles": [ + "obpRequests.put(`${base()}/retention-policies/${encodeURIComponent(id)}`, body, token)", + "const base = () => `/obp/v7.0.0/management/banks/${encodeURIComponent(cohortSpace())}`;" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID/preview", + "source": "apps/cohort/src/lib/server/retention.ts", + "needles": [ + "`${base()}/retention-policies/${encodeURIComponent(id)}/preview`", + "const base = () => `/obp/v7.0.0/management/banks/${encodeURIComponent(cohortSpace())}`;" + ], + "reads": [ + "due_count", + "held_count", + "oldest_trigger_date", + "can_execute" + ], + "note": "The preview is returned to /staff/retention, whose page shows these four fields." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID/runs", + "source": "apps/cohort/src/lib/server/retention.ts", + "needles": [ + "`${base()}/retention-policies/${encodeURIComponent(id)}/runs`", + "const base = () => `/obp/v7.0.0/management/banks/${encodeURIComponent(cohortSpace())}`;" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs", + "source": "apps/cohort/src/lib/server/retention.ts", + "needles": [ + "`${base()}/retention-runs?limit=50`", + "const base = () => `/obp/v7.0.0/management/banks/${encodeURIComponent(cohortSpace())}`;" + ], + "reads": [ + "retention_runs[].retention_run_id", + "retention_runs[].retention_policy_id", + "retention_runs[].mode", + "retention_runs[].status", + "retention_runs[].requested_by_user_id", + "retention_runs[].approved_by_user_id", + "retention_runs[].matched_count", + "retention_runs[].archived_count", + "retention_runs[].anonymised_count", + "retention_runs[].deleted_count", + "retention_runs[].held_count", + "retention_runs[].failed_count", + "retention_runs[].message", + "retention_runs[].requested_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs/RETENTION_RUN_ID/approval", + "source": "apps/cohort/src/lib/server/retention.ts", + "needles": [ + "`${base()}/retention-runs/${encodeURIComponent(id)}/approval`", + "const base = () => `/obp/v7.0.0/management/banks/${encodeURIComponent(cohortSpace())}`;" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID", + "source": "apps/cohort/src/lib/server/setupStatus.ts", + "needles": [ + "`/obp/v5.1.0/banks/${encodeURIComponent(space)}`" + ], + "reads": [], + "note": "Only checks that the space's bank exists; the body is not read." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/entitlement-requests", + "source": "apps/cohort/src/lib/server/staffAccess.ts", + "needles": [ + "'/obp/v5.1.0/my/entitlement-requests'" + ], + "reads": [ + "entitlement_requests[].role_name", + "entitlement_requests[].bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/current", + "source": "apps/cohort/src/lib/server/staffAccess.ts", + "needles": [ + "'/obp/v5.1.0/users/current'" + ], + "reads": [ + "entitlements.list[].role_name", + "entitlements.list[].bank_id", + "user_id", + "username", + "email", + "entitlements.list" + ], + "note": "Reads the Roles held; /staff/access also stores the user in the session, where user_id, username, email and the entitlement count are read." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/entitlement-requests", + "source": "apps/cohort/src/lib/server/staffAccess.ts", + "needles": [ + "'/obp/v6.0.0/entitlement-requests'" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/users", + "source": "apps/cohort/src/lib/server/users.ts", + "needles": [ + "`/obp/v7.0.0/users?username=${encodeURIComponent(username)}`" + ], + "reads": [ + "users[].username", + "users[].user_id", + "users[].provider" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/attribute", + "source": "apps/cohort/src/routes/(protected)/staff/organisations/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${space()}/customers/${customerId}/attribute`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links", + "source": "apps/cohort/src/routes/(protected)/staff/organisations/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${space()}/user_customer_links`" + ], + "reads": [] + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links/USER_CUSTOMER_LINK_ID", + "source": "apps/cohort/src/routes/(protected)/staff/organisations/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${space()}/user_customer_links/${encodeURIComponent(linkId)}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links/customers/CUSTOMER_ID", + "source": "apps/cohort/src/routes/(protected)/staff/organisations/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${space()}/user_customer_links/customers/${encodeURIComponent(customerId)}`" + ], + "reads": [ + "user_customer_links[].user_id", + "user_customer_links[].user_customer_link_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/user_id/USER_ID", + "source": "apps/cohort/src/routes/(protected)/staff/organisations/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/users/user_id/${encodeURIComponent(userId)}`" + ], + "reads": [ + "username" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/customers", + "source": "apps/cohort/src/routes/(protected)/staff/organisations/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/banks/${space()}/customers`" + ], + "reads": [ + "customer_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/current", + "source": "apps/cohort/src/routes/(public)/login/obp/callback/+server.ts", + "needles": [ + "'/obp/v5.1.0/users/current'" + ], + "reads": [ + "user_id", + "username", + "email", + "entitlements.list" + ], + "note": "The user is stored in the session; Cohort reads user_id, username, email and the number of entitlements from it." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/root", + "source": "apps/portal/src/hooks.server.ts", + "needles": [ + "`${publicEnv.PUBLIC_OBP_BASE_URL}/obp/v5.1.0/root`" + ], + "reads": [], + "note": "Health check registered with healthCheckRegistry; HealthCheckService GETs the URL and only looks at the HTTP status." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/app-directory", + "source": "apps/portal/src/hooks.server.ts", + "needles": [ + "`${obpBase}/obp/v6.0.0/app-directory`" + ], + "reads": [ + "app_directory[].name", + "app_directory[].value" + ], + "note": "Looks up the OBP-MCP status URLs for the health checks." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/public/consent-config", + "source": "apps/portal/src/hooks.server.ts", + "needles": [ + "`${obpBase}/obp/v7.0.0/public/consent-config`" + ], + "reads": [ + "consents_allowed", + "sca_enabled", + "max_time_to_live_in_seconds" + ], + "note": "JsonStatusHealthCheckService GETs the URL and evaluateConsentConfig (packages/shared health-check stackChecks.ts) reads the fields." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/well-known", + "source": "apps/portal/src/lib/oauth/providerManager.ts", + "needles": [ + "'/obp/v5.1.0/well-known'" + ], + "reads": [ + "well_known_uris[].provider", + "well_known_uris[].url" + ], + "undocumented_fields": [ + "well_known_uris[].provider", + "well_known_uris[].url" + ], + "note": "Passed as wellKnownEndpoint to the shared OAuth2ProviderManager, which GETs it with obpRequests.get and reads response.well_known_uris; the resource docs only list jwks_uris[].jwks_uri for this endpoint." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "source": "apps/portal/src/lib/obp/operationIdsCache.ts", + "needles": [ + "`/obp/${apiVersion}/resource-docs/${apiVersion}/obp`" + ], + "reads": [ + "resource_docs[].operation_id", + "resource_docs[].summary" + ], + "undocumented_fields": [ + "resource_docs[].operation_id", + "resource_docs[].summary" + ], + "note": "apiVersion is filled at run time; the only caller (routes/(protected)/user/api-collections/[collection_id]/+page.server.ts) passes its API_VERSION 'v6.0.0'. The resource docs list no response fields for this endpoint." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/public/password-config", + "source": "apps/portal/src/lib/obp/passwordConfig.ts", + "needles": [ + "'/obp/v7.0.0/public/password-config'" + ], + "reads": [ + "policies[].min_length", + "policies[].max_length", + "policies[].required_character_classes[].name", + "policies[].required_character_classes[].regex", + "policies[].allowed_characters" + ], + "note": "Returned to the register and reset-password pages, which evaluate it with the shared passwordPolicy.ts helpers (evaluatePasswordPolicy, passphrasePolicy, passwordRulesAttribute)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms", + "source": "apps/portal/src/lib/server/faq/faqChat.ts", + "needles": [ + "'/obp/v6.0.0/chat-rooms'" + ], + "reads": [ + "chat_rooms[].is_archived", + "chat_rooms[].description", + "chat_rooms[].chat_room_id", + "chat_rooms[].joining_key" + ], + "note": "The same literal is also used by the POST on line 87; the needle covers both lines." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms", + "source": "apps/portal/src/lib/server/faq/faqChat.ts", + "needles": [ + "'/obp/v6.0.0/chat-rooms'" + ], + "reads": [ + "chat_room_id", + "joining_key" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/personal-data-fields", + "source": "apps/portal/src/lib/server/userPreferences.ts", + "needles": [ + "'/obp/v6.0.0/my/personal-data-fields'" + ], + "reads": [ + "user_attributes[].user_attribute_id", + "user_attributes[].name", + "user_attributes[].value" + ], + "note": "The same literal is also used by the POST on line 84; the needle covers both lines." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/personal-data-fields", + "source": "apps/portal/src/lib/server/userPreferences.ts", + "needles": [ + "'/obp/v6.0.0/my/personal-data-fields'" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "source": "apps/portal/src/lib/server/userPreferences.ts", + "needles": [ + "`/obp/v6.0.0/my/personal-data-fields/${encodeURIComponent(existing.id)}`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/personal-data-fields", + "source": "apps/portal/src/lib/stores/currentBank.svelte.ts", + "needles": [ + "\"/proxy/obp/v6.0.0/my/personal-data-fields\"" + ], + "reads": [ + "user_attributes[].user_attribute_id", + "user_attributes[].name", + "user_attributes[].value" + ], + "note": "Browser fetch through the generic proxy; the same literal is also used by the POST on line 207." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/personal-data-fields", + "source": "apps/portal/src/lib/stores/currentBank.svelte.ts", + "needles": [ + "\"/proxy/obp/v6.0.0/my/personal-data-fields\"" + ], + "reads": [ + "user_attribute_id" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "source": "apps/portal/src/lib/stores/currentBank.svelte.ts", + "needles": [ + "`/proxy/obp/v6.0.0/my/personal-data-fields/${encodeURIComponent(this.attributeId)}`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/users/current/auth-context-updates/SCA_METHOD", + "source": "apps/portal/src/routes/(protected)/add-user-auth-context-update-request/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${bankId}/users/current/auth-context-updates/${scaMethod}`" + ], + "reads": [ + "user_auth_context_update_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/portal/src/routes/(protected)/checkout/[product_code]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/banks`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "banks[].id" + ], + "undocumented_fields": [ + "banks[].id" + ], + "note": "findProduct reads bank.id of each bank to build the api-products path; the v6.0.0 docs name the field bank_id, so bank.id looks like a leftover from an older bank shape." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/account-applications", + "source": "apps/portal/src/routes/(protected)/checkout/[product_code]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/banks/${bankId}/account-applications`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "account_application_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "source": "apps/portal/src/routes/(protected)/checkout/[product_code]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/banks/${bank.id}/api-products/${productCode}`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "bank_id", + "api_product_code", + "parent_api_product_code", + "name", + "more_info_url", + "terms_and_conditions_url", + "description", + "meta", + "attributes", + "collection_id", + "category", + "monthly_subscription_amount", + "monthly_subscription_currency", + "per_second_call_limit", + "per_minute_call_limit", + "per_hour_call_limit", + "per_day_call_limit", + "per_week_call_limit", + "per_month_call_limit" + ], + "undocumented_fields": [ + "meta" + ], + "note": "mapApiProductDetails copies these fields into the page data; the attributes list is passed on but its items are not read; meta is copied although the docs do not list it." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/user/current/consents/CONSENT_ID", + "source": "apps/portal/src/routes/(protected)/confirm-bg-consent-request-redirect-uri/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/user/current/consents/${consentId}`" + ], + "reads": [ + "jwt", + "status" + ], + "note": "tppRedirectsOf (lib/server/bgConsentRedirects.ts) decodes the jwt for the TPP redirect headers." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/consumers/CONSUMER_ID", + "source": "apps/portal/src/routes/(protected)/confirm-bg-consent-request/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/management/consumers/${consent.consumer_id}`" + ], + "reads": [ + "app_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/user/current/consents/CONSENT_ID", + "source": "apps/portal/src/routes/(protected)/confirm-bg-consent-request/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/user/current/consents/${consentId}`" + ], + "reads": [ + "jwt", + "consumer_id" + ], + "note": "Called in load (line 59) and again in the deny action (line 219), where tppRedirectsOf reads the jwt." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/consents/CONSENT_ID", + "source": "apps/portal/src/routes/(protected)/confirm-bg-consent-request/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/banks/${defaultBankId}/consents/${consentId}`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/banks/BANK_ID/consents/CONSENT_ID/account-access", + "source": "apps/portal/src/routes/(protected)/confirm-bg-consent-request/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/management/banks/${defaultBankId}/consents/${consentId}/account-access`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/accounts", + "source": "apps/portal/src/routes/(protected)/confirm-bg-consent-request/+page.server.ts", + "needles": [ + "'/obp/v6.0.0/my/accounts'" + ], + "reads": [ + "accounts[].account_routings[].scheme", + "accounts[].account_routings[].address", + "accounts[].id", + "accounts[].bank_id", + "accounts[].label" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/users/current/auth-context-updates/AUTH_CONTEXT_UPDATE_ID/challenge", + "source": "apps/portal/src/routes/(protected)/confirm-user-auth-context-update-request/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${bankId}/users/current/auth-context-updates/${authContextUpdateId}/challenge`" + ], + "reads": [ + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID", + "source": "apps/portal/src/routes/(protected)/confirm-vrp-consent-request/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/consumer/consent-requests/${consentRequestId}`" + ], + "reads": [ + "payload", + "payload.from_account", + "payload.to_account", + "payload.maximum_single_amount.amount", + "payload.maximum_single_amount.currency", + "payload.maximum_monthly_amount.amount", + "payload.maximum_monthly_amount.currency", + "payload.valid_from", + "payload.valid_to" + ], + "undocumented_fields": [ + "payload.from_account", + "payload.to_account", + "payload.maximum_single_amount.amount", + "payload.maximum_single_amount.currency", + "payload.maximum_monthly_amount.amount", + "payload.maximum_monthly_amount.currency", + "payload.valid_to" + ], + "note": "The load JSON.parses payload as a string (the docs show it as an object, so a parsed object falls back to {}), and +page.svelte shows from_account and to_account as JSON and the amount, currency and validity fields." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID/IMPLICIT/consents", + "source": "apps/portal/src/routes/(protected)/confirm-vrp-consent-request/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/consumer/consent-requests/${consentRequestId}/IMPLICIT/consents`" + ], + "reads": [ + "consent_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge", + "source": "apps/portal/src/routes/(protected)/confirm-vrp-consent/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${defaultBankId}/consents/${consentId}/challenge`" + ], + "reads": [ + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/consumers/CONSUMER_ID", + "source": "apps/portal/src/routes/(protected)/confirm-vrp-consent/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/management/consumers/${consumerId}`" + ], + "reads": [ + "redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/user/current/consents/CONSENT_ID", + "source": "apps/portal/src/routes/(protected)/confirm-vrp-consent/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/user/current/consents/${consentId}`" + ], + "reads": [ + "consumer_id", + "consent_request_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/my/consumers", + "source": "apps/portal/src/routes/(protected)/consumers/register/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/my/consumers`" + ], + "reads": [], + "note": "The whole response is put in a short-lived cookie and the success page lists every key and value generically (Object.entries), so no field is read by name." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge", + "source": "apps/portal/src/routes/(protected)/obp-consent-request-sca/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${bankId}/consents/${consentId}/challenge`" + ], + "reads": [ + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID", + "source": "apps/portal/src/routes/(protected)/obp-consent-request/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/consumer/consent-requests/${consentRequestId}`" + ], + "reads": [ + "payload", + "consumer_id", + "payload.everything", + "payload.time_to_live", + "payload.valid_from", + "payload.account_access[].account_routing.address", + "payload.account_access[].account_routing.scheme", + "payload.account_access[].view_id", + "payload.from_account.account_routing.address", + "payload.from_account.account_routing.scheme", + "payload.to_account.counterparty_name", + "payload.to_account.account_routing.address", + "payload.to_account.account_routing.scheme", + "payload.to_account.limit.currency", + "payload.to_account.limit.max_single_amount", + "payload.to_account.limit.max_monthly_amount", + "payload.to_account.limit.max_number_of_monthly_transactions", + "payload.to_account.limit.max_yearly_amount", + "payload.to_account.limit.max_number_of_yearly_transactions", + "payload.to_account.limit.max_total_amount", + "payload.to_account.limit.max_number_of_transactions", + "payload.entitlements[].role_name", + "payload.entitlements[].bank_id" + ], + "undocumented_fields": [ + "payload.from_account.account_routing.address", + "payload.from_account.account_routing.scheme", + "payload.to_account.counterparty_name", + "payload.to_account.account_routing.address", + "payload.to_account.account_routing.scheme", + "payload.to_account.limit.currency", + "payload.to_account.limit.max_single_amount", + "payload.to_account.limit.max_monthly_amount", + "payload.to_account.limit.max_number_of_monthly_transactions", + "payload.to_account.limit.max_yearly_amount", + "payload.to_account.limit.max_number_of_yearly_transactions", + "payload.to_account.limit.max_total_amount", + "payload.to_account.limit.max_number_of_transactions", + "payload.entitlements[].role_name", + "payload.entitlements[].bank_id" + ], + "note": "The payload is passed to +page.svelte, which shows the VRP from/to accounts and limits and the requested roles; the docs only describe the account-access form of the payload." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID/IMPLICIT/consents", + "source": "apps/portal/src/routes/(protected)/obp-consent-request/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/consumer/consent-requests/${consentRequestId}/IMPLICIT/consents`" + ], + "reads": [ + "consent_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/consumers/CONSUMER_ID", + "source": "apps/portal/src/routes/(protected)/obp-consent-request/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/management/consumers/${consentRequest.consumer_id}`" + ], + "reads": [ + "app_name" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/GRANT_VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge", + "source": "apps/portal/src/routes/(protected)/otp/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${bankId}/accounts/${accountId}/${viewId}/transaction-request-types/${transactionRequestType}/transaction-requests/${transactionRequestId}/challenge`" + ], + "reads": [], + "note": "The transaction request type comes from the form, so this is the generic answerTransactionRequestChallenge endpoint; the response is not read." + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/authorise", + "source": "apps/portal/src/routes/(protected)/uk-consent-request-sca/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${bankId}/consents/${consentId}/authorise`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/authorise/challenge", + "source": "apps/portal/src/routes/(protected)/uk-consent-request/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${bankId}/consents/${consentId}/authorise/challenge`" + ], + "reads": [ + "challenge_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/accounts", + "source": "apps/portal/src/routes/(protected)/uk-consent-request/+page.server.ts", + "needles": [ + "'/obp/v6.0.0/my/accounts'" + ], + "reads": [ + "accounts[].bank_id", + "accounts[].id", + "accounts[].label" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks", + "source": "apps/portal/src/routes/(protected)/user/accounts/+page.server.ts", + "needles": [ + "'/obp/v5.1.0/banks'" + ], + "reads": [ + "banks[].id", + "banks[].full_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/accounts", + "source": "apps/portal/src/routes/(protected)/user/accounts/+page.server.ts", + "needles": [ + "'/obp/v5.1.0/my/accounts'" + ], + "reads": [ + "accounts[].id", + "accounts[].bank_id", + "accounts[].label", + "accounts[].account_type", + "accounts[].account_routings[].scheme", + "accounts[].account_routings[].address", + "accounts[].views[].id", + "accounts[].views[].is_public", + "accounts[].views[].short_name", + "accounts[].views[].description" + ], + "note": "The accounts are returned as is and +page.svelte reads these fields." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views", + "source": "apps/portal/src/routes/(protected)/user/accounts/[bank_id]/[account_id]/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${encodeURIComponent(bank_id)}/accounts/${encodeURIComponent(account_id)}/views`" + ], + "reads": [ + "views[].id", + "views[].is_public" + ], + "note": "Used only to pick a default view to redirect to." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views", + "source": "apps/portal/src/routes/(protected)/user/accounts/[bank_id]/[account_id]/[view_id]/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${encodeURIComponent(bank_id)}/accounts/${encodeURIComponent(account_id)}/views`" + ], + "reads": [ + "views[].id", + "views[].short_name", + "views[].description", + "views[].is_public" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/accounts", + "source": "apps/portal/src/routes/(protected)/user/accounts/[bank_id]/[account_id]/[view_id]/+page.server.ts", + "needles": [ + "'/obp/v5.1.0/my/accounts'" + ], + "reads": [ + "accounts[].bank_id", + "accounts[].id", + "accounts[].views[].id", + "accounts[].views[].short_name", + "accounts[].views[].description", + "accounts[].views[].is_public" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions", + "source": "apps/portal/src/routes/(protected)/user/accounts/[bank_id]/[account_id]/[view_id]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/banks/${encodeURIComponent(bank_id)}/accounts/${encodeURIComponent(account_id)}/${encodeURIComponent(view_id)}/transactions?limit=10&sort_direction=DESC`" + ], + "reads": [ + "transactions[].id", + "transactions[].details.posted", + "transactions[].details.completed", + "transactions[].details.type", + "transactions[].details.description", + "transactions[].details.value.amount", + "transactions[].details.value.currency", + "transactions[].details.new_balance.amount", + "transactions[].other_account.holder.name", + "transactions[].other_account.id" + ], + "undocumented_fields": [ + "transactions[].id", + "transactions[].other_account.id" + ], + "note": "The code reads t.id and t.other_account.id, but the v6.0.0 docs name these transaction_id and other_account.account_id." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account", + "source": "apps/portal/src/routes/(protected)/user/accounts/[bank_id]/[account_id]/[view_id]/+page.server.ts", + "needles": [ + "`/obp/v7.0.0/banks/${encodeURIComponent(bank_id)}/accounts/${encodeURIComponent(account_id)}/${encodeURIComponent(view_id)}/account`" + ], + "reads": [ + "id", + "bank_id", + "label", + "account_type", + "account_routings[].scheme", + "account_routings[].address", + "balance.amount", + "balance.currency" + ], + "undocumented_fields": [ + "account_type" + ], + "note": "The v7.0.0 docs for this endpoint list product_code but no account_type; the page shows account_type." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID", + "source": "apps/portal/src/routes/(protected)/user/accounts/[bank_id]/[account_id]/[view_id]/counterparties/[counterparty_id]/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${encodeURIComponent(bank_id)}/accounts/${encodeURIComponent(" + ], + "reads": [ + "counterparty_id", + "name", + "description", + "currency", + "created_by_user_id", + "is_beneficiary", + "other_bank_routing_scheme", + "other_bank_routing_address", + "other_branch_routing_scheme", + "other_branch_routing_address", + "other_account_routing_scheme", + "other_account_routing_address", + "other_account_secondary_routing_scheme", + "other_account_secondary_routing_address", + "metadata.public_alias", + "metadata.private_alias", + "metadata.more_info", + "metadata.url", + "metadata.image_url", + "metadata.open_corporates_url", + "bespoke[].key", + "bespoke[].value" + ], + "note": "The path template spans three lines (72-74); the counterparty is returned as is and +page.svelte shows these fields." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates", + "source": "apps/portal/src/routes/(protected)/user/accounts/[bank_id]/[account_id]/mandates/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/banks/${encodeURIComponent(bank_id)}/accounts/${encodeURIComponent(account_id)}/mandates`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "mandates[].mandate_id", + "mandates[].mandate_name", + "mandates[].mandate_reference", + "mandates[].status", + "mandates[].valid_from", + "mandates[].valid_to", + "mandates[].description" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels", + "source": "apps/portal/src/routes/(protected)/user/accounts/[bank_id]/[account_id]/mandates/[mandate_id]/signatory-panels/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/banks/${encodeURIComponent(bank_id)}/mandates/${encodeURIComponent(mandate_id)}/signatory-panels`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "signatory_panels[].panel_id", + "signatory_panels[].panel_name", + "signatory_panels[].description", + "signatory_panels[].user_ids" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels/PANEL_ID", + "source": "apps/portal/src/routes/(protected)/user/accounts/[bank_id]/[account_id]/mandates/[mandate_id]/signatory-panels/[panel_id]/+page.server.ts", + "needles": [ + "obp_requests.delete(panelUrl(bank_id, mandate_id, panel_id)", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [], + "note": "Missed by the script: the delete action." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels/PANEL_ID", + "source": "apps/portal/src/routes/(protected)/user/accounts/[bank_id]/[account_id]/mandates/[mandate_id]/signatory-panels/[panel_id]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/banks/${encodeURIComponent(bank_id)}/mandates/${encodeURIComponent(mandate_id)}/signatory-panels/${encodeURIComponent(panel_id)}`", + "const API_VERSION = 'v6.0.0'", + "obp_requests.get(panelUrl(bank_id, mandate_id, panel_id)" + ], + "reads": [ + "panel_id", + "panel_name", + "description", + "user_ids" + ], + "note": "The path is built by panelUrl in the same file, which the load (GET), update (PUT) and delete (DELETE) actions all use." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels/PANEL_ID", + "source": "apps/portal/src/routes/(protected)/user/accounts/[bank_id]/[account_id]/mandates/[mandate_id]/signatory-panels/[panel_id]/+page.server.ts", + "needles": [ + "panelUrl(bank_id, mandate_id, panel_id),", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [], + "note": "Missed by the script: the update action PUTs to panelUrl(...); the response is not read." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels", + "source": "apps/portal/src/routes/(protected)/user/accounts/[bank_id]/[account_id]/mandates/[mandate_id]/signatory-panels/create/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/banks/${encodeURIComponent(bank_id)}/mandates/${encodeURIComponent(mandate_id)}/signatory-panels`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [], + "note": "The script guessed GET; the URL is handed to obp_requests.post in the default action and the response is not read." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections", + "source": "apps/portal/src/routes/(protected)/user/api-collections/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/api-collections`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_collections[].api_collection_name", + "api_collections[].api_collection_id", + "api_collections[].description", + "api_collections[].is_sharable" + ], + "note": "The same literal is also used by the POST on line 83. The list goes to +page.svelte, which renders each collection with lib/components/ApiCollectionCard.svelte." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/api-collections", + "source": "apps/portal/src/routes/(protected)/user/api-collections/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/api-collections`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "source": "apps/portal/src/routes/(protected)/user/api-collections/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/api-collections/${collectionId}`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoint-ids/API_COLLECTION_ENDPOINT_ID", + "source": "apps/portal/src/routes/(protected)/user/api-collections/[collection_id]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/api-collection-ids/${collectionId}/api-collection-endpoint-ids/${endpointId}`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints", + "source": "apps/portal/src/routes/(protected)/user/api-collections/[collection_id]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/api-collection-ids/${collectionId}/api-collection-endpoints`", + "`/obp/${API_VERSION}/my/api-collection-ids/${sourceCollectionId}/api-collection-endpoints`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_collection_endpoints[].api_collection_endpoint_id", + "api_collection_endpoints[].operation_id" + ], + "note": "Called in load (line 58, the first literal is also used by the POST on line 114) and in the copyFrom action (line 219)." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints", + "source": "apps/portal/src/routes/(protected)/user/api-collections/[collection_id]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/api-collection-ids/${collectionId}/api-collection-endpoints`", + "`/obp/${API_VERSION}/my/api-collection-ids/${targetCollectionId}/api-collection-endpoints`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [], + "note": "Called in the addEndpoint action (line 114) and in the copyFrom loop (line 244)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections", + "source": "apps/portal/src/routes/(protected)/user/api-collections/[collection_id]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/api-collections`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_collections[].api_collection_id", + "api_collections[].api_collection_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "source": "apps/portal/src/routes/(protected)/user/api-collections/[collection_id]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/api-collections/${collectionId}`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable" + ], + "note": "The same literal is also used by the PUT on line 183. The collection is returned as is and +page.svelte reads these fields." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "source": "apps/portal/src/routes/(protected)/user/api-collections/[collection_id]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/api-collections/${collectionId}`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/consents", + "source": "apps/portal/src/routes/(protected)/user/consents/+page.server.ts", + "needles": [ + "'/obp/v5.1.0/my/consents?limit=10&sort_by=created_date:desc'", + "`/obp/v5.1.0/my/consents?limit=${pageLimit}&offset=${offset}`" + ], + "reads": [ + "consents[].status", + "consents[].last_action_date", + "consents[].consumer_id", + "consents[].created_date", + "consents[].consent_id", + "consents[].consent_reference_id", + "consents[].everything", + "consents[].jwt", + "consents[].jwt_payload", + "consents[].last_usage_date", + "consents[].jwt_payload.exp", + "consents[].jwt_payload.entitlements[].role_name", + "consents[].jwt_payload.entitlements[].bank_id", + "consents[].jwt_payload.views[].bank_id", + "consents[].jwt_payload.views[].account_id", + "consents[].jwt_payload.views[].view_id|consents[].jwt_payload.views[].id", + "consents[].jwt_payload.my_resources.personal_dynamic_entities[].actions", + "consents[].jwt_payload.my_resources.personal_dynamic_entities[].entity_name", + "consents[].jwt_payload.my_resources.personal_dynamic_entities[].bank_id" + ], + "undocumented_fields": [ + "consents[].created_date", + "consents[].everything", + "consents[].jwt_payload.exp", + "consents[].jwt_payload.entitlements[].role_name", + "consents[].jwt_payload.entitlements[].bank_id", + "consents[].jwt_payload.views[].bank_id", + "consents[].jwt_payload.views[].account_id", + "consents[].jwt_payload.views[].view_id|consents[].jwt_payload.views[].id", + "consents[].jwt_payload.my_resources.personal_dynamic_entities[].actions", + "consents[].jwt_payload.my_resources.personal_dynamic_entities[].entity_name", + "consents[].jwt_payload.my_resources.personal_dynamic_entities[].bank_id" + ], + "note": "Called in load (line 64) and in the deleteAll action (line 186, reads status and consent_id). The load passes the consents to +page.svelte, which renders each with the shared ConsentCard component; ConsentCard parses jwt_payload (or decodes the jwt when it is missing) and reads the claims listed. created_date and everything are read but not in the docs." + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/my/consents/CONSENT_ID", + "source": "apps/portal/src/routes/(protected)/user/consents/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/my/consents/${consentId}`", + "`/obp/v5.1.0/my/consents/${c.consent_id}`" + ], + "reads": [], + "note": "Called in the delete action (line 152) and for each consent in deleteAll (line 227)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/users/current/consumers", + "source": "apps/portal/src/routes/(protected)/user/consumers/+page.server.ts", + "needles": [ + "'/obp/v6.0.0/management/users/current/consumers'" + ], + "reads": [ + "consumers[].created", + "consumers[].app_name", + "consumers[].app_type", + "consumers[].company", + "consumers[].consumer_id", + "consumers[].description", + "consumers[].developer_email", + "consumers[].enabled", + "consumers[].key", + "consumers[].secret", + "consumers[].redirect_url" + ], + "undocumented_fields": [ + "consumers[].company", + "consumers[].key", + "consumers[].secret" + ], + "note": "The consumers go to +page.svelte, which shows company and the key/secret pair; the docs do not list company, key or secret for this endpoint." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks", + "source": "apps/portal/src/routes/(protected)/user/entitlements/+page.server.ts", + "needles": [ + "'/obp/v5.1.0/banks'" + ], + "reads": [ + "banks[].id", + "banks[].full_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/entitlements", + "source": "apps/portal/src/routes/(protected)/user/entitlements/+page.server.ts", + "needles": [ + "'/obp/v5.1.0/my/entitlements'" + ], + "reads": [ + "list[].entitlement_id", + "list[].bank_id", + "list[].role_name" + ], + "note": "Called in load (line 32) and after adding an entitlement (line 113, where the whole response is stored in the session unread); +page.svelte reads the listed fields." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/roles", + "source": "apps/portal/src/routes/(protected)/user/entitlements/+page.server.ts", + "needles": [ + "'/obp/v5.1.0/roles'" + ], + "reads": [ + "roles[].role", + "roles[].requires_bank_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/users/USER_ID/entitlements", + "source": "apps/portal/src/routes/(protected)/user/entitlements/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/users/${currentUserId}/entitlements`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/users/current/consumers", + "source": "apps/portal/src/routes/(protected)/user/my-activity-dashboard/+page.server.ts", + "needles": [ + "'/obp/v6.0.0/management/users/current/consumers'" + ], + "reads": [ + "consumers[].consumer_id", + "consumers[].app_name" + ], + "note": "buildMyMetricsConsumerOptions (packages/shared metrics.ts) reads consumer_id and app_name." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/my/metrics", + "source": "apps/portal/src/routes/(protected)/user/my-activity-dashboard/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/metrics?${query.toString()}`", + "`/obp/${API_VERSION}/my/metrics?${buildMyMetricsSummaryQuery(query).toString()}`", + "const API_VERSION = 'v7.0.0'" + ], + "reads": [ + "metrics[].app_name", + "metrics[].auth_type", + "metrics[].consent_reference_id", + "metrics[].consumer_id", + "metrics[].correlation_id", + "metrics[].date", + "metrics[].duration", + "metrics[].implemented_by_partial_function", + "metrics[].operation_id", + "metrics[].status_code", + "metrics[].url", + "metrics[].verb" + ], + "note": "Two GETs: the visible page (rendered by +page.svelte) and a summary page reduced by summariseMetrics in packages/shared metrics.ts (status_code, duration, operation_id, implemented_by_partial_function, consumer_id, app_name)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/personal-dynamic-entities/available", + "source": "apps/portal/src/routes/(protected)/user/my-data/+page.server.ts", + "needles": [ + "'/obp/v6.0.0/personal-dynamic-entities/available'" + ], + "reads": [ + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].user_id", + "dynamic_entities[].bank_id", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].schema" + ], + "undocumented_fields": [ + "dynamic_entities[].bank_id" + ], + "note": "bank_id is read to choose the bank-level dynamic entity data path; the docs do not list it." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/personal-data-fields", + "source": "apps/portal/src/routes/(protected)/user/personal-data-fields/+page.server.ts", + "needles": [ + "'/obp/v6.0.0/my/personal-data-fields'" + ], + "reads": [ + "user_attributes[].user_attribute_id", + "user_attributes[].name", + "user_attributes[].type", + "user_attributes[].value", + "user_attributes[].insert_date" + ], + "note": "The same literal is also used by the POST on line 70; +page.svelte reads the listed fields." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/personal-data-fields", + "source": "apps/portal/src/routes/(protected)/user/personal-data-fields/+page.server.ts", + "needles": [ + "'/obp/v6.0.0/my/personal-data-fields'" + ], + "reads": [] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "source": "apps/portal/src/routes/(protected)/user/personal-data-fields/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/my/personal-data-fields/${id}`" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "source": "apps/portal/src/routes/(protected)/user/personal-data-fields/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/my/personal-data-fields/${id}`" + ], + "reads": [], + "note": "The same literal is also used by the DELETE on line 134." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/app-directory", + "source": "apps/portal/src/routes/+layout.server.ts", + "needles": [ + "'/obp/v6.0.0/app-directory'" + ], + "reads": [ + "app_directory[].name", + "app_directory[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms", + "source": "apps/portal/src/routes/+layout.server.ts", + "needles": [ + "'/obp/v6.0.0/chat-rooms'" + ], + "reads": [ + "chat_rooms[].unread_count" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/personal-data-fields", + "source": "apps/portal/src/routes/+layout.server.ts", + "needles": [ + "'/obp/v6.0.0/my/personal-data-fields'" + ], + "reads": [ + "user_attributes[].name", + "user_attributes[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/portal/src/routes/backend/banks/+server.ts", + "needles": [ + "`/obp/v6.0.0/banks`" + ], + "reads": [ + "banks[].bank_id", + "banks[].short_name", + "banks[].full_name" + ], + "undocumented_fields": [ + "banks[].short_name" + ], + "note": "The route returns the banks to the currentBank store (lib/stores/currentBank.svelte.ts), and routes/(protected)/user/+page.svelte shows bank.short_name and bank.full_name in the bank selector; the v6.0.0 docs list bank_code but no short_name." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/roles", + "source": "apps/portal/src/routes/backend/obp/roles/+server.ts", + "needles": [ + "\"/obp/v5.1.0/roles\"" + ], + "reads": [], + "note": "Returned to the browser as is; no page in the repo calls /backend/obp/roles." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints", + "source": "apps/portal/src/routes/collections/[collection_id]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/api-collections/${collectionId}/api-collection-endpoints`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_collection_endpoints[].operation_id", + "api_collection_endpoints[].api_collection_endpoint_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-collections/sharable/API_COLLECTION_ID", + "source": "apps/portal/src/routes/collections/[collection_id]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/api-collections/sharable/${collectionId}`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_collection_id", + "api_collection_name", + "description" + ], + "note": "Returned as is; +page.svelte reads these fields." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "source": "apps/portal/src/routes/collections/[collection_id]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/resource-docs/${API_VERSION}/obp`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "resource_docs[].operation_id", + "resource_docs[].summary", + "resource_docs[].description_markdown", + "resource_docs[].request_verb", + "resource_docs[].specified_url|resource_docs[].request_url", + "resource_docs[].tags" + ], + "undocumented_fields": [ + "resource_docs[].operation_id", + "resource_docs[].summary", + "resource_docs[].description_markdown", + "resource_docs[].request_verb", + "resource_docs[].specified_url|resource_docs[].request_url", + "resource_docs[].tags" + ], + "note": "Both version segments are the file's API_VERSION 'v6.0.0'. The resource docs list no response fields for this endpoint." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints", + "source": "apps/portal/src/routes/featured/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/api-collections/${collection.api_collection_id}/api-collection-endpoints`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_collection_endpoints[].operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-collections/featured", + "source": "apps/portal/src/routes/featured/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/api-collections/featured`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_collections[].api_collection_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api/popular-endpoints", + "source": "apps/portal/src/routes/featured/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/api/popular-endpoints`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "operation_ids" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "source": "apps/portal/src/routes/featured/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/resource-docs/${API_VERSION}/obp`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].specified_url|resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].description", + "resource_docs[].description_markdown", + "resource_docs[].tags" + ], + "undocumented_fields": [ + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].specified_url|resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].description", + "resource_docs[].description_markdown", + "resource_docs[].tags" + ], + "note": "Both version segments are the file's API_VERSION 'v6.0.0'. The resource docs list no response fields for this endpoint." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/root", + "source": "apps/portal/src/routes/featured/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/root`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [], + "note": "Only checks that OBP-API answers." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/products", + "source": "apps/portal/src/routes/financial-products/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/products?tag=featured`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "products[].name", + "products[].bank_id", + "products[].product_code", + "products[].description" + ], + "note": "Returned to +page.svelte, which sorts by bank_id and name and shows these fields." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/root", + "source": "apps/portal/src/routes/financial-products/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/root`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [], + "note": "Only checks that OBP-API answers." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/products/PRODUCT_CODE", + "source": "apps/portal/src/routes/financial-products/[bank_id]/[product_code]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/banks/${encodeURIComponent(bankId)}/products/${encodeURIComponent(productCode)}`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "product_code", + "bank_id", + "name", + "description", + "more_info_url", + "terms_and_conditions_url", + "product_attributes[].name", + "product_attributes[].value" + ], + "undocumented_fields": [ + "product_attributes[].name", + "product_attributes[].value" + ], + "note": "+page.svelte lists product.product_attributes, but the v6.0.0 docs call this list attributes." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/portal/src/routes/financial-products/[product_code]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/banks`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "banks[].id|banks[].bank_id" + ], + "note": "Reads b.id || b.bank_id; the v6.0.0 docs only have bank_id." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/products", + "source": "apps/portal/src/routes/financial-products/[product_code]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/banks/${encodeURIComponent(bankId)}/products`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "products[].product_code" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/personal-data-fields", + "source": "apps/portal/src/routes/financial-products/[product_code]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/my/personal-data-fields`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "user_attributes[].name", + "user_attributes[].value" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/password-reset-url", + "source": "apps/portal/src/routes/forgot-password/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users/password-reset-url`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/current", + "source": "apps/portal/src/routes/login/[provider]/callback/+server.ts", + "needles": [ + "`${env.PUBLIC_OBP_BASE_URL}/obp/v5.1.0/users/current`" + ], + "reads": [ + "user_id", + "email", + "username" + ], + "note": "The script guessed DELETE; the URL is wrapped in new Request(...) with no method and sent with fetch, so it is a GET. The user is stored in the session, where the portal reads user_id, email and username." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/current", + "source": "apps/portal/src/routes/login/obp/callback/+server.ts", + "needles": [ + "`${env.PUBLIC_OBP_BASE_URL}/obp/v5.1.0/users/current`" + ], + "reads": [ + "user_id", + "email", + "username" + ], + "note": "The script guessed DELETE; the URL is wrapped in new Request(...) with no method and sent with fetch, so it is a GET. The user is stored in the session, where the portal reads user_id, email and username." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-products", + "source": "apps/portal/src/routes/products/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/api-products?tag=featured`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_products[].bank_id", + "api_products[].api_product_code", + "api_products[].parent_api_product_code", + "api_products[].name", + "api_products[].more_info_url", + "api_products[].terms_and_conditions_url", + "api_products[].description", + "api_products[].meta", + "api_products[].attributes", + "api_products[].collection_id", + "api_products[].category", + "api_products[].monthly_subscription_amount", + "api_products[].monthly_subscription_currency", + "api_products[].per_second_call_limit", + "api_products[].per_minute_call_limit", + "api_products[].per_hour_call_limit", + "api_products[].per_day_call_limit", + "api_products[].per_week_call_limit", + "api_products[].per_month_call_limit" + ], + "undocumented_fields": [ + "api_products[].meta" + ], + "note": "Each product goes through mapApiProductDetails; the attributes list is passed on but its items are not read; meta is copied although the docs do not list it." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/root", + "source": "apps/portal/src/routes/products/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/root`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [], + "note": "Only checks that OBP-API answers." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints", + "source": "apps/portal/src/routes/products/[product_code]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/api-collections/${product.apiCollectionId}/api-collection-endpoints`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_collection_endpoints[].operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "apps/portal/src/routes/products/[product_code]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/banks`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "banks[].id|banks[].bank_id" + ], + "note": "Reads b.id || b.bank_id; the v6.0.0 docs only have bank_id." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "source": "apps/portal/src/routes/products/[product_code]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/banks/${bank.id}/api-products/${productCode}`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "bank_id", + "api_product_code", + "parent_api_product_code", + "name", + "more_info_url", + "terms_and_conditions_url", + "description", + "meta", + "attributes", + "collection_id", + "category", + "monthly_subscription_amount", + "monthly_subscription_currency", + "per_second_call_limit", + "per_minute_call_limit", + "per_hour_call_limit", + "per_day_call_limit", + "per_week_call_limit", + "per_month_call_limit" + ], + "undocumented_fields": [ + "meta" + ], + "note": "mapApiProductDetails copies these fields; the attributes list is passed on but its items are not read; meta is copied although the docs do not list it." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "source": "apps/portal/src/routes/products/[product_code]/+page.server.ts", + "needles": [ + "`/obp/${API_VERSION}/resource-docs/${API_VERSION}/obp`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].specified_url|resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].description.markdown", + "resource_docs[].tags" + ], + "undocumented_fields": [ + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].specified_url|resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].description.markdown", + "resource_docs[].tags" + ], + "note": "Both version segments are the file's API_VERSION 'v6.0.0'. The resource docs list no response fields for this endpoint; this page reads description.markdown where the featured and collection pages read description_markdown." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/users", + "source": "apps/portal/src/routes/register/+page.server.ts", + "needles": [ + "'/obp/v7.0.0/users'", + "obp_requests.post(REGISTER_USER_ENDPOINT" + ], + "reads": [ + "username" + ], + "note": "The script guessed GET; REGISTER_USER_ENDPOINT is handed to obp_requests.post in the default action. The response goes in a short-lived cookie; register/success/+page.svelte shows username and then lists every key generically." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/password", + "source": "apps/portal/src/routes/reset-password/[token]/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users/password`" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-products", + "source": "apps/portal/src/routes/subscriptions/+page.server.ts", + "needles": [ + "`/obp/${PRODUCTS_API_VERSION}/api-products`", + "const PRODUCTS_API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_products[].bank_id", + "api_products[].api_product_code", + "api_products[].name", + "api_products[].category", + "api_products[].description", + "api_products[].monthly_subscription_amount", + "api_products[].monthly_subscription_currency" + ], + "note": "bank_id and api_product_code build the detail path; the other fields are read by toSubscribableProduct when the detail call fails." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "source": "apps/portal/src/routes/subscriptions/+page.server.ts", + "needles": [ + "`/obp/${PRODUCTS_API_VERSION}/banks/${encodeURIComponent(raw.bank_id)}/api-products/${encodeURIComponent(raw.api_product_code)}`", + "const PRODUCTS_API_VERSION = 'v6.0.0'" + ], + "reads": [ + "attributes[].name", + "attributes[].is_active", + "attributes[].value", + "bank_id", + "api_product_code", + "name", + "category", + "description", + "monthly_subscription_amount", + "monthly_subscription_currency" + ], + "note": "The SELF_SUBSCRIBE and BILLING_SYSTEM attributes decide which button the page shows." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/users/current/consumers", + "source": "apps/portal/src/routes/subscriptions/+page.server.ts", + "needles": [ + "`/obp/${PRODUCTS_API_VERSION}/management/users/current/consumers`", + "const PRODUCTS_API_VERSION = 'v6.0.0'" + ], + "reads": [ + "consumers[].created", + "consumers[].consumer_id", + "consumers[].app_name", + "consumers[].enabled" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE/subscriptions", + "source": "apps/portal/src/routes/subscriptions/+page.server.ts", + "needles": [ + "`/obp/${SUBSCRIPTIONS_API_VERSION}/banks/${encodeURIComponent(bankId)}/api-products/${encodeURIComponent(apiProductCode)}/subscriptions`", + "const SUBSCRIPTIONS_API_VERSION = 'v7.0.0'" + ], + "reads": [ + "api_product_subscription_id", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/my/api-product-subscriptions", + "source": "apps/portal/src/routes/subscriptions/+page.server.ts", + "needles": [ + "`/obp/${SUBSCRIPTIONS_API_VERSION}/my/api-product-subscriptions`", + "const SUBSCRIPTIONS_API_VERSION = 'v7.0.0'" + ], + "reads": [ + "api_product_subscriptions[].created_at", + "api_product_subscriptions[].api_product_subscription_id", + "api_product_subscriptions[].api_product_code", + "api_product_subscriptions[].bank_id", + "api_product_subscriptions[].consumer_id", + "api_product_subscriptions[].status", + "api_product_subscriptions[].start_date", + "api_product_subscriptions[].end_date" + ], + "undocumented_fields": [ + "api_product_subscriptions[].end_date" + ], + "note": "+page.svelte shows end_date, which the v7.0.0 docs do not list for this endpoint." + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/my/api-product-subscriptions/API_PRODUCT_SUBSCRIPTION_ID/status", + "source": "apps/portal/src/routes/subscriptions/+page.server.ts", + "needles": [ + "`/obp/${SUBSCRIPTIONS_API_VERSION}/my/api-product-subscriptions/${encodeURIComponent(subscriptionId)}/status`", + "const SUBSCRIPTIONS_API_VERSION = 'v7.0.0'" + ], + "reads": [ + "api_product_code" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/user-invitation", + "source": "apps/portal/src/routes/user-invitation/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${effectiveBankId}/user-invitation`" + ], + "reads": [] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/user-invitations", + "source": "apps/portal/src/routes/user-invitation/+page.server.ts", + "needles": [ + "`/obp/v5.1.0/banks/${effectiveBankId}/user-invitations`" + ], + "reads": [ + "first_name", + "last_name", + "email", + "company", + "country", + "purpose", + "status" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/email-validation", + "source": "apps/portal/src/routes/user-validation/+page.server.ts", + "needles": [ + "`/obp/v6.0.0/users/email-validation`" + ], + "reads": [], + "note": "The response is returned as data and +page.svelte lists every key generically (Object.entries)." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/root", + "source": "packages/shared/src/hooks.server.ts", + "needles": [ + "`${publicEnv.PUBLIC_OBP_BASE_URL}/obp/v5.1.0/root`" + ], + "reads": [], + "note": "Health check: HealthCheckService GETs this URL and only looks at the status code." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-room-participants", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${V}/banks/${encodeURIComponent(scope.bankId)}/chat-room-participants`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "chat_room_id" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (joining with a joining key)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${V}/banks/${encodeURIComponent(scope.bankId)}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "chat_rooms[].chat_room_id", + "chat_rooms[].unread_count", + "chat_rooms[].last_message_at", + "chat_rooms[].created_at", + "chat_rooms[].name", + "chat_rooms[].bank_id", + "chat_rooms[].is_open_room", + "chat_rooms[].participant_count", + "chat_rooms[].last_message_preview", + "chat_rooms[].description", + "chat_rooms[].created_by_username", + "chat_rooms[].is_archived", + "chat_rooms[].last_message_sender_username|chat_rooms[].last_message_sender" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (rooms list) for a bank's rooms (Cohort's discussions); ChatRoomList.svelte renders the fields." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${V}/banks/${encodeURIComponent(scope.bankId)}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "chat_room_id", + "name", + "joining_key" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (create action; ChatRoomList shows name, joining_key, chat_room_id)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/banks/${encodeURIComponent(scope.bankId)}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "chat_room_id", + "name", + "description", + "bank_id", + "is_open_room", + "participant_count", + "is_archived", + "unread_count", + "joining_key" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (room and settings pages); ChatRoomView.svelte and ChatRoomSettings.svelte render the fields." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/banks/${encodeURIComponent(scope.bankId)}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (settings update); the response is not read." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/joining-key", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${room(id)}/joining-key`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/banks/${encodeURIComponent(scope.bankId)}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "joining_key" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (settings refreshKey)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${room(id)}/messages`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/banks/${encodeURIComponent(scope.bankId)}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "messages[].chat_message_id", + "messages[].content", + "messages[].created_at", + "messages[].is_deleted", + "messages[].reply_to_message_id", + "messages[].sender_user_id", + "messages[].updated_at", + "messages[].sender_username", + "messages[].sender_consumer_name", + "messages[].mentioned_user_ids", + "messages[].reactions[].emoji", + "messages[].reactions[].user_ids" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (room page) and ChatRoomView.svelte (GET polling with ?from_date=)." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${room(id)}/messages`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/banks/${encodeURIComponent(scope.bankId)}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "chat_message_id", + "content", + "created_at", + "is_deleted", + "reply_to_message_id", + "sender_user_id", + "updated_at", + "sender_username", + "sender_consumer_name", + "mentioned_user_ids" + ], + "note": "Built by chatApiPaths; called from ChatRoomView.svelte (sendMessage); the new message is appended and rendered." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${room(id)}/messages`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/banks/${encodeURIComponent(scope.bankId)}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "updated_at" + ], + "undocumented_endpoint": "OBP-API documents editing a message only at PUT .../chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID, not at .../messages.", + "note": "Built by chatApiPaths; called from ChatRoomView.svelte (saveEdit), which PUTs to the messages list with chat_message_id in the body." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID/reactions", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${message(roomId, messageId)}/reactions`", + "`${room(roomId)}/messages/${encodeURIComponent(messageId)}`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/banks/${encodeURIComponent(scope.bankId)}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [], + "note": "Built by chatApiPaths; called from ChatRoomView.svelte (toggleReaction); only res.ok is checked." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID/reactions/EMOJI_REACTION", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${message(roomId, messageId)}/reactions/${encodeURIComponent(emoji)}`", + "`${room(roomId)}/messages/${encodeURIComponent(messageId)}`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/banks/${encodeURIComponent(scope.bankId)}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [], + "note": "Built by chatApiPaths; called from ChatRoomView.svelte (toggleReaction)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/participants", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${room(id)}/participants`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/banks/${encodeURIComponent(scope.bankId)}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "participants[].participant_id", + "participants[].user_id", + "participants[].username" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (room page; ChatRoomView renders the fields)." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-room-participants", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${V}/chat-room-participants`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "chat_room_id" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (joining with a joining key)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${V}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "chat_rooms[].chat_room_id", + "chat_rooms[].unread_count", + "chat_rooms[].last_message_at", + "chat_rooms[].created_at", + "chat_rooms[].name", + "chat_rooms[].bank_id", + "chat_rooms[].is_open_room", + "chat_rooms[].participant_count", + "chat_rooms[].last_message_preview", + "chat_rooms[].description", + "chat_rooms[].created_by_username", + "chat_rooms[].is_archived", + "chat_rooms[].last_message_sender_username|chat_rooms[].last_message_sender" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (rooms list) for system-wide rooms (the Portal); ChatRoomList.svelte renders the fields." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${V}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "chat_room_id", + "name", + "joining_key" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (create action; ChatRoomList shows name, joining_key, chat_room_id) and server/chat/dm.ts (findOrCreateDm reads chat_room_id)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "chat_room_id", + "name", + "description", + "bank_id", + "is_open_room", + "participant_count", + "is_archived", + "unread_count", + "joining_key" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (room and settings pages); ChatRoomView.svelte and ChatRoomSettings.svelte render the fields." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (settings update) and server/chat/dm.ts (renaming a new DM); the response is not read." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/joining-key", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${room(id)}/joining-key`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "joining_key" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (settings refreshKey)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${room(id)}/messages`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "messages[].chat_message_id", + "messages[].content", + "messages[].created_at", + "messages[].is_deleted", + "messages[].reply_to_message_id", + "messages[].sender_user_id", + "messages[].updated_at", + "messages[].sender_username", + "messages[].sender_consumer_name", + "messages[].mentioned_user_ids", + "messages[].reactions[].emoji", + "messages[].reactions[].user_ids" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (room page) and ChatRoomView.svelte (GET polling with ?from_date=)." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${room(id)}/messages`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "chat_message_id", + "content", + "created_at", + "is_deleted", + "reply_to_message_id", + "sender_user_id", + "updated_at", + "sender_username", + "sender_consumer_name", + "mentioned_user_ids" + ], + "note": "Built by chatApiPaths; called from ChatRoomView.svelte (sendMessage); the new message is appended and rendered." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${room(id)}/messages`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "updated_at" + ], + "undocumented_endpoint": "OBP-API documents editing a message only at PUT .../chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID, not at .../messages.", + "note": "Built by chatApiPaths; called from ChatRoomView.svelte (saveEdit), which PUTs to the messages list with chat_message_id in the body." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID/reactions", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${message(roomId, messageId)}/reactions`", + "`${room(roomId)}/messages/${encodeURIComponent(messageId)}`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [], + "note": "Built by chatApiPaths; called from ChatRoomView.svelte (toggleReaction); only res.ok is checked." + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID/reactions/EMOJI_REACTION", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${message(roomId, messageId)}/reactions/${encodeURIComponent(emoji)}`", + "`${room(roomId)}/messages/${encodeURIComponent(messageId)}`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [], + "note": "Built by chatApiPaths; called from ChatRoomView.svelte (toggleReaction)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${room(id)}/participants`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "participants[].participant_id", + "participants[].user_id", + "participants[].username" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (room page; ChatRoomView renders the fields) and server/chat/dm.ts (usernames for a new DM's name)." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${room(id)}/participants`", + "`${rooms}/${encodeURIComponent(id)}`", + "`${V}/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [], + "note": "Built by chatApiPaths; called from server/chat/dm.ts (adding the other user to a new DM, system rooms only); the response is not read." + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms/search", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${V}/chat-rooms/search`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "chat_rooms[].chat_room_id" + ], + "note": "Built by chatApiPaths; called from server/chat/dm.ts (finding an existing DM)." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/current/chat-rooms", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${V}/users/current/chat-rooms`", + "const V = '/obp/v6.0.0'" + ], + "reads": [ + "chat_rooms[].joining_key", + "chat_rooms[].chat_room_id" + ], + "note": "Built by chatApiPaths; called from server/chat/pages.ts (join page, when the user is already a participant)." + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/users/current/chat-rooms/CHAT_ROOM_ID/read-marker", + "source": "packages/shared/src/lib/chat/paths.ts", + "needles": [ + "`${V}/users/current/chat-rooms/${encodeURIComponent(id)}/read-marker`", + "const V = '/obp/v6.0.0'" + ], + "reads": [], + "note": "Built by chatApiPaths; called from ChatRoomView.svelte (fire-and-forget read marker)." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/my/accounts", + "source": "packages/shared/src/lib/components/AccountScopePicker.svelte", + "needles": [ + "'/proxy/obp/v7.0.0/my/accounts'" + ], + "reads": [ + "accounts[].bank_id", + "accounts[].account_id", + "accounts[].label", + "accounts[].views[].view_id", + "accounts[].views[].short_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/entitlements", + "source": "packages/shared/src/lib/components/ConsentRequestCard.svelte", + "needles": [ + "'/proxy/obp/v5.1.0/my/entitlements'" + ], + "reads": [ + "list[].role_name", + "list[].bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/entitlements", + "source": "packages/shared/src/lib/components/NewEntitlementsNotice.svelte", + "needles": [ + "'/proxy/obp/v5.1.0/my/entitlements'" + ], + "reads": [ + "list[].role_name", + "list[].bank_id" + ], + "note": "Default of the entitlementsUrl prop." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/consents", + "source": "packages/shared/src/lib/components/OpeyChat.svelte", + "needles": [ + "'/proxy/obp/v5.1.0/my/consents'" + ], + "reads": [ + "consents[].consent_id", + "consents[].consent_reference_id" + ], + "note": "Default of options.consentsUrl." + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/consumers/current/platform-app", + "source": "packages/shared/src/lib/health-check/services/ConsumerScopesHealthCheckService.ts", + "needles": [ + "'/obp/v7.0.0/consumers/current/platform-app'", + "this.call('PUT', CURRENT_CONSUMER_PLATFORM_APP_PATH, token, body)" + ], + "reads": [], + "note": "Only the status code (and message of an error) is read." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/consumers/current/scopes", + "source": "packages/shared/src/lib/health-check/services/ConsumerScopesHealthCheckService.ts", + "needles": [ + "'/obp/v7.0.0/consumers/current/scopes'", + "this.call('GET', CURRENT_CONSUMER_SCOPES_PATH, tokenResult.token)" + ], + "reads": [ + "consumer_id", + "scopes[].role_name", + "scopes[].bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/consumers/current/identity", + "source": "packages/shared/src/lib/health-check/services/OIDCHealthCheckService.ts", + "needles": [ + "`${this.obpBaseUrl}/obp/v7.0.0/consumers/current/identity`" + ], + "reads": [ + "consumer_id", + "consumer_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/consents", + "source": "packages/shared/src/lib/opey/recording/consentReference.ts", + "needles": [ + "'/obp/v5.1.0/my/consents'", + "obpGet(MY_CONSENTS_PATH, accessToken)" + ], + "reads": [ + "consents[].consent_id", + "consents[].consent_reference_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/root", + "source": "packages/shared/src/lib/server/chat/pages.ts", + "needles": [ + "'/obp/v6.0.0/root'" + ], + "reads": [], + "note": "Reachability probe after a failed room fetch; the body is not read." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/public/chat-config", + "source": "packages/shared/src/lib/server/chat/policy.ts", + "needles": [ + "'/obp/v7.0.0/public/chat-config'" + ], + "reads": [ + "allowed_link_hosts", + "max_message_length" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api/versions", + "source": "packages/shared/src/lib/server/explorer/apiVersions.ts", + "needles": [ + "`/obp/${metaVersion}/api/versions`", + "export const DEFAULT_META_VERSION = 'v6.0.0'" + ], + "reads": [ + "scanned_api_versions[].url_prefix", + "scanned_api_versions[].api_standard", + "scanned_api_versions[].api_short_version", + "scanned_api_versions[].fully_qualified_version", + "scanned_api_versions[].is_active" + ], + "note": "The version is metaVersion, DEFAULT_META_VERSION (v6.0.0) unless a caller passes another; no caller in the repo does." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/api/glossary", + "source": "packages/shared/src/lib/server/explorer/glossaryCache.ts", + "needles": [ + "'/obp/v7.0.0/api/glossary'", + "fetch(`${baseUrl.replace(/\\/$/, '')}${API_GLOSSARY_PATH}`, { headers })" + ], + "reads": [ + "glossary_items[].title", + "glossary_items[].description.markdown", + "glossary_items[].is_dynamic", + "glossary_items[].overrides_static_item" + ], + "note": "Revalidated with If-None-Match; also reads the ETag header." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/message-docs/CONNECTOR", + "source": "packages/shared/src/lib/server/explorer/messageDocsCache.ts", + "needles": [ + "`/obp/v5.1.0/message-docs/${encodeURIComponent(connector)}`" + ], + "reads": [ + "message_docs[].process", + "message_docs[].description", + "message_docs[].message_format", + "message_docs[].adapter_implementation.group", + "message_docs[].adapter_implementation.suggested_order", + "message_docs[].dependent_endpoints", + "message_docs[].requiredFieldInfo" + ], + "note": "loadMessageDoc also hands one whole message doc to the caller's page." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "source": "packages/shared/src/lib/server/explorer/resourceDocsCache.ts", + "needles": [ + "`/obp/${metaVersion}/resource-docs/${fullyQualifiedVersion}/obp${query}`", + "const { metaVersion = DEFAULT_META_VERSION, token, content = 'all' } = options;" + ], + "reads": [ + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].specified_url", + "resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].tags" + ], + "undocumented_fields": [ + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].specified_url", + "resource_docs[].request_url", + "resource_docs[].summary", + "resource_docs[].tags" + ], + "note": "metaVersion defaults to DEFAULT_META_VERSION (v6.0.0, apiVersions.ts); API_VERSION is a catalogue such as OBPv7.0.0, optional ?content=. buildIndex reads these fields; the whole docs also go to the Explorer pages. OBP-API documents no response schema for resource-docs, so these fields are not in the docs field list." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints", + "source": "packages/shared/src/lib/server/landing/fetchers.ts", + "needles": [ + "`/obp/${API_VERSION}/api-collections/${encodeURIComponent(collection)}/api-collection-endpoints`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_collection_endpoints[].operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-products", + "source": "packages/shared/src/lib/server/landing/fetchers.ts", + "needles": [ + "`/obp/${API_VERSION}/api-products`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "api_products[].tags", + "api_products[].bank_id", + "api_products[].api_product_code", + "api_products[].name", + "api_products[].description", + "api_products[].category", + "api_products[].monthly_subscription_amount", + "api_products[].monthly_subscription_currency", + "api_products[].collection_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "packages/shared/src/lib/server/landing/fetchers.ts", + "needles": [ + "`/obp/${API_VERSION}/banks`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "banks[].bank_id", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "source": "packages/shared/src/lib/server/landing/fetchers.ts", + "needles": [ + "`/obp/${API_VERSION}/resource-docs/${API_VERSION}/obp`", + "const API_VERSION = 'v6.0.0'" + ], + "reads": [ + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].request_url", + "resource_docs[].summary" + ], + "undocumented_fields": [ + "resource_docs[].operation_id", + "resource_docs[].request_verb", + "resource_docs[].request_url", + "resource_docs[].summary" + ], + "note": "Both version segments are API_VERSION (v6.0.0). OBP-API documents no response schema for resource-docs, so these fields are not in the docs field list." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/my/roles/ROLE_NAME", + "source": "packages/shared/src/lib/server/monitoring/obpRoleCheck.ts", + "needles": [ + "`${obpApiHost}/obp/v7.0.0/banks/SYS/my/roles/${encodeURIComponent(role)}`" + ], + "reads": [ + "allowed" + ], + "undocumented_fields": [ + "allowed" + ], + "note": "BANK_ID is always SYS. The code reads body.allowed, which the documented field list does not have." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/well-known", + "source": "packages/shared/src/lib/server/oauth/providerManager.ts", + "needles": [ + "'/obp/v5.1.0/well-known'", + "this.obpRequests.get(this.wellKnownEndpoint)" + ], + "reads": [ + "well_known_uris[].provider", + "well_known_uris[].url" + ], + "undocumented_fields": [ + "well_known_uris[].provider", + "well_known_uris[].url" + ], + "note": "Default wellKnownEndpoint when the app passes none. The documented response lists only jwks_uris; the code reads well_known_uris." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/consents", + "source": "packages/shared/src/lib/server/obp/OBPIntegrationService.ts", + "needles": [ + "'/obp/v5.1.0/my/consents'" + ], + "reads": [ + "consents[].consent_id", + "consents[].consumer_id", + "consents[].status", + "consents[].jwt_expires_at", + "consents[].jwt", + "consents[].created_by_user_id", + "consents[].last_action_date", + "consents[].last_usage_date", + "consents[].api_standard", + "consents[].api_version" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/my/consents/IMPLICIT", + "source": "packages/shared/src/lib/server/obp/OBPIntegrationService.ts", + "needles": [ + "'/obp/v5.1.0/my/consents/IMPLICIT'" + ], + "reads": [ + "jwt", + "status", + "consent_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/consents", + "source": "packages/shared/src/lib/server/obp/consentReuse.ts", + "needles": [ + "'/obp/v5.1.0/my/consents'" + ], + "reads": [ + "consents[].consent_id", + "consents[].status", + "consents[].consumer_id", + "consents[].jwt_expires_at", + "consents[].jwt_payload", + "consents[].jwt" + ], + "note": "Earlier hand-checked reads consent_id and status still hold; it also reads consumer_id, jwt_expires_at, jwt_payload (a JSON string, parsed for entitlements, views and my_resources) and jwt." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/public/consent-config", + "source": "packages/shared/src/lib/server/obp/consentsConfig.ts", + "needles": [ + "'/obp/v7.0.0/public/consent-config'" + ], + "reads": [ + "max_time_to_live_in_seconds" + ], + "note": "Earlier hand-checked read still holds." + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "packages/shared/src/lib/server/obp/dynamicEntityBootstrap.ts", + "needles": [ + "deps.get(entities, deps.accessToken)", + "const entities = dynamicEntityDefinitionsPath(bankId);" + ], + "reads": [ + "dynamic_entities[].entity_name", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].schema.properties", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_public_access" + ], + "note": "ensureDynamicEntity; the app passes its own get/post/put (Cohort's entities/bootstrap.ts and others)." + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "source": "packages/shared/src/lib/server/obp/dynamicEntityBootstrap.ts", + "needles": [ + "deps.post(entities, definition, deps.accessToken)", + "const entities = dynamicEntityDefinitionsPath(bankId);" + ], + "reads": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID", + "source": "packages/shared/src/lib/server/obp/dynamicEntityBootstrap.ts", + "needles": [ + "deps.put(`${entities}/${encodeURIComponent(existing.dynamic_entity_id)}`, definition, deps.accessToken)", + "const entities = dynamicEntityDefinitionsPath(bankId);" + ], + "reads": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "source": "packages/shared/src/lib/server/obp/operationIdsCache.ts", + "needles": [ + "`/obp/${apiVersion}/resource-docs/${apiVersion}/obp`" + ], + "reads": [ + "resource_docs[].operation_id", + "resource_docs[].summary" + ], + "undocumented_fields": [ + "resource_docs[].operation_id", + "resource_docs[].summary" + ], + "note": "apiVersion comes from the caller and fills both version segments; the shared getOperationIds has no caller in the repo (the Portal uses its own copy with API_VERSION 'v6.0.0'), so v6.0.0 is assumed. OBP-API documents no response schema for resource-docs, so these fields are not in the docs field list." + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/webui-props", + "source": "packages/shared/src/lib/server/obp/webUiProps.ts", + "needles": [ + "'/obp/v6.0.0/webui-props?what=database'" + ], + "reads": [ + "webui_props[].name", + "webui_props[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/entitlements", + "source": "packages/shared/src/lib/server/opey/consentHandler.ts", + "needles": [ + "'/obp/v5.1.0/my/entitlements'" + ], + "reads": [ + "list[].role_name", + "list[].bank_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/roles", + "source": "packages/shared/src/lib/server/opey/consentHandler.ts", + "needles": [ + "'/obp/v5.1.0/roles'" + ], + "reads": [ + "roles[].role", + "roles[].requires_bank_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/consents/IMPLICIT", + "source": "packages/shared/src/lib/server/opey/consentHandler.ts", + "needles": [ + "'/obp/v6.0.0/my/consents/IMPLICIT'", + "obpRequests.post(OBP_CREATE_CONSENT_PATH, consentBody, accessToken)" + ], + "reads": [ + "jwt", + "consent_id", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "source": "packages/shared/src/routes/api/banks/+server.ts", + "needles": [ + "`/obp/v6.0.0/banks`" + ], + "reads": [ + "banks[].bank_id" + ], + "note": "Filters on bank_id and returns the banks to the browser as they are." + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/current", + "source": "packages/shared/src/routes/login/[provider]/callback/+server.ts", + "needles": [ + "`${env.PUBLIC_OBP_BASE_URL}/obp/v5.1.0/users/current`" + ], + "reads": [ + "user_id", + "email", + "username" + ], + "note": "A plain GET Request (the draft's DELETE was wrong); the user goes into the session, where user_id, email and username are read." + } + ], + "not_calls": [ + { + "source": "apps/api-manager/src/lib/components/DomainApiForm.svelte", + "needles": [ + "/carbon-registry/v1/ENTITY answers what /obp/v7.0.0/banks/SPACE/dynamic-entities/ENTITY answers" + ], + "reason": "help text in the form description given to Opey" + }, + { + "source": "apps/api-manager/src/lib/components/DomainApiForm.svelte", + "needles": [ + "true lists it in GET /obp/v7.0.0/banks/SPACE/domain-apis for anyone" + ], + "reason": "help text in the form description given to Opey" + }, + { + "source": "apps/api-manager/src/lib/components/DynamicResourceDocForm.svelte", + "needles": [ + "Read them with GET /obp/v7.0.0/management/banks/${space}/dynamic-entities before changing a name" + ], + "reason": "text of the fix prompt sent to Opey" + }, + { + "source": "apps/api-manager/src/lib/components/GlossaryItemForm.svelte", + "needles": [ + "served by GET /obp/v7.0.0/api/glossary alongside the static ones" + ], + "reason": "help text in the form description given to Opey" + }, + { + "source": "apps/api-manager/src/lib/components/ReportEditor.svelte", + "needles": [ + "Paths MUST start with /obp/ and include the version, e.g. /obp/v6.0.0/banks." + ], + "reason": "help text in the report-editor description given to Opey" + }, + { + "source": "apps/api-manager/src/lib/components/ReportEditor.svelte", + "needles": [ + "metrics endpoints under /obp/v6.0.0/management/" + ], + "reason": "help text in the report-editor description given to Opey" + }, + { + "source": "apps/api-manager/src/lib/config.ts", + "needles": [ + "`${obpBaseUrl}/obp/v6.0.0`" + ], + "reason": "base URL constant (OBP_API_URL); the calls built on it are listed at their callers: apps/api-manager/src/routes/+layout.server.ts, apps/api-manager/src/routes/login/[provider]/callback/+server.ts, apps/api-manager/src/routes/login/obp/callback/+server.ts" + }, + { + "source": "apps/api-manager/src/lib/server/domainApis.ts", + "needles": [ + "create: { operation_id: \"OBPv7.0.0-createDomainApi\"" + ], + "reason": "descriptor table of operation ids and paths, shown as links to the API Explorer" + }, + { + "source": "apps/api-manager/src/lib/server/domainApis.ts", + "needles": [ + "list: { operation_id: \"OBPv7.0.0-getDomainApis\"" + ], + "reason": "descriptor table of operation ids and paths, shown as links to the API Explorer" + }, + { + "source": "apps/api-manager/src/lib/server/domainApis.ts", + "needles": [ + "get: { operation_id: \"OBPv7.0.0-getDomainApi\"" + ], + "reason": "descriptor table of operation ids and paths, shown as links to the API Explorer" + }, + { + "source": "apps/api-manager/src/lib/server/domainApis.ts", + "needles": [ + "update: { operation_id: \"OBPv7.0.0-updateDomainApi\"" + ], + "reason": "descriptor table of operation ids and paths, shown as links to the API Explorer" + }, + { + "source": "apps/api-manager/src/lib/server/domainApis.ts", + "needles": [ + "delete: { operation_id: \"OBPv7.0.0-deleteDomainApi\"" + ], + "reason": "descriptor table of operation ids and paths, shown as links to the API Explorer" + }, + { + "source": "apps/api-manager/src/lib/server/dynamicEntities/ensure.ts", + "needles": [ + "get: (path, token) => obp_requests.get(path, token)," + ], + "reason": "passes obp_requests to the shared ensureSystemDynamicEntity in packages/shared/src/lib/server/obp, which builds the paths" + }, + { + "source": "apps/api-manager/src/lib/server/dynamicEntityWebhooks.ts", + "needles": [ + "\"/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks\"" + ], + "reason": "descriptor table of operation ids and paths, shown as links to the API Explorer" + }, + { + "source": "apps/api-manager/src/lib/server/dynamicEntityWebhooks.ts", + "needles": [ + "path: \"/obp/v7.0.0/management/banks/BANK_ID/dynamic-entity-web-hooks\"" + ], + "reason": "descriptor table of operation ids and paths, shown as links to the API Explorer" + }, + { + "source": "apps/api-manager/src/lib/server/files.ts", + "needles": [ + "`/obp/v7.0.0/banks/${encodeURIComponent(bankId)}/files/${encodeURIComponent(fileId)}/content`" + ], + "reason": "builds the path for calls listed at its callers: apps/api-manager/src/routes/backend/files/[bank_id]/[file_id]/content/+server.ts" + }, + { + "source": "apps/api-manager/src/lib/server/landing/fetchers.ts", + "needles": [ + "buildShared((path, t) => obp_requests.get(path, t), token, links)" + ], + "reason": "passes obp_requests to the shared landing fetchers in packages/shared/src/lib/server/landing, which build the paths" + }, + { + "source": "apps/api-manager/src/lib/server/landing/fetchers.ts", + "needles": [ + "findShared((path, t) => obp_requests.get(path, t), token)" + ], + "reason": "passes obp_requests to the shared landing fetchers in packages/shared/src/lib/server/landing, which build the paths" + }, + { + "source": "apps/api-manager/src/lib/server/opeyConversations/opeyConversationEntity.ts", + "needles": [ + "get: (path: string, token: string) => obp_requests.get(path, token)," + ], + "reason": "passes obp_requests to the shared ensureSystemDynamicEntity in packages/shared/src/lib/server/obp, which builds the paths" + }, + { + "source": "apps/api-manager/src/lib/services/dynamicEntityWebhooks.ts", + "needles": [ + "`/obp/v7.0.0/management/banks/${encodeURIComponent(spaceOf(bankId))}/dynamic-entity-web-hooks`" + ], + "reason": "builds the path for calls listed at its callers: apps/api-manager/src/routes/(protected)/dynamic-entity-webhooks/+page.server.ts" + }, + { + "source": "apps/api-manager/src/lib/services/reports.ts", + "needles": [ + "'/obp/v6.0.0/banks'" + ], + "reason": "example call inside the starter report definition (JavaScript text a user can edit and run in a sandbox), not a call the app makes itself" + }, + { + "source": "apps/api-manager/src/lib/services/retention.ts", + "needles": [ + "`/obp/v7.0.0/management/banks/${encodeURIComponent(retentionSpace(bankId))}/${rest}${qs ? `" + ], + "reason": "builds the path for calls listed at its callers: apps/api-manager/src/routes/(protected)/retention/+page.server.ts, apps/api-manager/src/routes/(protected)/retention/runs/+page.server.ts, apps/api-manager/src/routes/(protected)/retention/runs/[bank_id]/[run_id]/+page.server.ts, apps/api-manager/src/routes/(protected)/retention/archive/+page.server.ts, apps/api-manager/src/routes/(protected)/retention/archive/[bank_id]/[archive_id]/+page.server.ts, apps/api-manager/src/routes/(protected)/retention/archive/[bank_id]/[archive_id]/content/+server.ts, apps/api-manager/src/routes/(protected)/retention/holds/+page.server.ts, apps/api-manager/src/routes/(protected)/retention/[bank_id]/[policy_id]/+page.server.ts" + }, + { + "source": "apps/api-manager/src/routes/(protected)/abac/rules/[rule_id]/edit/+page.svelte", + "needles": [ + "`API Manager Proxy: /proxy/obp/v6.0.0/management/abac-rules-schema`" + ], + "reason": "error message text naming the endpoint" + }, + { + "source": "apps/api-manager/src/routes/(protected)/abac/rules/[rule_id]/edit/+page.svelte", + "needles": [ + "`OBP Endpoint: ${schema.endpoint || \"/obp/v6.0.0/management/abac-rules-schema\"}`" + ], + "reason": "error message text naming the endpoint" + }, + { + "source": "apps/api-manager/src/routes/(protected)/account-access/accounts/[bank_id]/[account_id]/[view_id]/+page.svelte", + "needles": [ + "`/obp/v7.0.0/banks/${bankId}/accounts/${accountId}/views/${targetView}/users/${targetUser}/account-access-trace`" + ], + "reason": "endpoint string written into a debug report the user copies to the clipboard" + }, + { + "source": "apps/api-manager/src/routes/(protected)/app-studio/+page.svelte", + "needles": [ + "\" await obp.get('/obp/v6.0.0/banks') -> parsed JSON, throws Error(message) with .status on non-2xx\"" + ], + "reason": "example in the prompt that tells the model how to write an app" + }, + { + "source": "apps/api-manager/src/routes/(protected)/app-studio/+page.svelte", + "needles": [ + "\"- Paths MUST start with /obp/ and include the version, e.g. /obp/v6.0.0/my/accounts. Query strings are allowed.\"" + ], + "reason": "example in the prompt that tells the model how to write an app" + }, + { + "source": "apps/api-manager/src/routes/(protected)/app-studio/blocks/examples.ts", + "needles": [ + "
curl https://apisandbox.bankx.example/obp/v6.0.0/banks
" + ], + "reason": "curl example text inside an example page block" + }, + { + "source": "apps/api-manager/src/routes/(protected)/consumers/+page.server.ts", + "needles": [ + "path: \"/obp/v7.0.0/management/consumers\" }" + ], + "reason": "descriptor table of operation ids and paths shown as API Explorer links" + }, + { + "source": "apps/api-manager/src/routes/(protected)/consumers/+page.server.ts", + "needles": [ + "path: \"/obp/v7.0.0/management/metrics/consumer-last-calls\"," + ], + "reason": "descriptor table of operation ids and paths shown as API Explorer links" + }, + { + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/diagnostics/+page.server.ts", + "needles": [ + "dynamicEntityRecordsPath(entity.bank_id, entityName)" + ], + "reason": "records of an entity the app defines (/obp/v7.0.0/banks/BANK_ID/dynamic-entities/ENTITY_NAME, generated per entity like /obp/dynamic-entity/...); the response is only shown raw for debugging" + }, + { + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/personal/[entityName]/+page.server.ts", + "needles": [ + "`/obp/dynamic-entity/my/${entityName}`", + "`/obp/dynamic-entity/community/${entityName}`", + "`/obp/dynamic-entity/public/${entityName}`" + ], + "reason": "paths under /obp/dynamic-entity/... (records of entities the apps define)" + }, + { + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/system/[id]/+page.svelte", + "needles": [ + "const dataPath = dynamicEntityDataPath(space);" + ], + "reason": "prefix of the per-entity record URLs, used only to display endpoint strings and API Explorer links" + }, + { + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/system/[id]/crud/+page.server.ts", + "needles": [ + "dynamicEntityRecordsPath(entity.bank_id, entityName)," + ], + "reason": "records of an entity the app defines (/obp/v7.0.0/banks/BANK_ID/dynamic-entities/ENTITY_NAME, generated per entity like /obp/dynamic-entity/...)" + }, + { + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/system/[id]/crud/+page.svelte", + "needles": [ + "let dataPath = $derived(dynamicEntityDataPath(space));" + ], + "reason": "prefix of the per-entity record URLs, used only to display endpoint strings and API Explorer links; record CRUD goes through /backend/dynamic-entities routes" + }, + { + "source": "apps/api-manager/src/routes/(protected)/glossary-items/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/api/glossary\"", + "\"/obp/v7.0.0/api/glossary/TITLE\"" + ], + "reason": "descriptor table of the endpoints behind the page, only shown as API Explorer links; the items are fetched by loadGlossaryItems in $lib/server/glossaryItems" + }, + { + "source": "apps/api-manager/src/routes/(protected)/glossary-items/[title]/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/api/glossary/TITLE\"" + ], + "reason": "descriptor table of the endpoints behind the page, only shown as API Explorer links; the GET call is listed separately" + }, + { + "source": "apps/api-manager/src/routes/(protected)/glossary-items/create/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/api/glossary\"" + ], + "reason": "descriptor table of the endpoints behind the page, only shown as API Explorer links; the create call is made by the browser through $lib/services/glossaryItems" + }, + { + "source": "apps/api-manager/src/routes/(protected)/glossary/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/api/glossary\"" + ], + "reason": "descriptor table of the endpoints behind the page, only shown as API Explorer links; the glossary is fetched by loadGlossaryIndex in $lib/server/apiGlossaryCache" + }, + { + "source": "apps/api-manager/src/routes/(protected)/glossary/[title]/+page.server.ts", + "needles": [ + "\"/obp/v7.0.0/api/glossary\"" + ], + "reason": "descriptor table of the endpoints behind the page, only shown as API Explorer links; the entry is fetched by loadGlossaryEntry in $lib/server/apiGlossaryCache" + }, + { + "source": "apps/api-manager/src/routes/(protected)/message-docs/[connector]/+page.server.ts", + "needles": [ + "\"/obp/v5.1.0/message-docs/CONNECTOR\"", + "\"/obp/v6.0.0/message-docs/CONNECTOR/json-schema\"", + "\"/obp/v5.1.0/message-docs/CONNECTOR/swagger2.0\"" + ], + "reason": "descriptor table of the endpoints behind the page, only shown as API Explorer links; message docs are fetched by loadMessageDocIndex in $lib/server/messageDocsCache" + }, + { + "source": "apps/api-manager/src/routes/(protected)/message-docs/[connector]/[process]/+page.server.ts", + "needles": [ + "\"/obp/v5.1.0/message-docs/CONNECTOR\"" + ], + "reason": "descriptor table of the endpoints behind the page, only shown as API Explorer links; the message doc is fetched by loadMessageDoc in $lib/server/messageDocsCache" + }, + { + "source": "apps/api-manager/src/routes/(protected)/system/config-props/+page.svelte", + "needles": [ + "{obpInfo.baseUrl}/obp/v6.0.0/management/config-props" + ], + "reason": "display text naming the endpoint" + }, + { + "source": "apps/api-manager/src/routes/(protected)/system/migrations/+page.svelte", + "needles": [ + "url: \"/proxy/obp/v6.0.0/system/migrations\"," + ], + "reason": "error log payload naming the endpoint" + }, + { + "source": "apps/api-manager/src/routes/(protected)/system/signal-publish/help/+page.svelte", + "needles": [ + "/obp/v6.0.0{ep.request_url}" + ], + "reason": "display of resource-doc paths on a help page" + }, + { + "source": "apps/api-manager/src/routes/(protected)/system/signal-publish/help/+page.svelte", + "needles": [ + "{publishDoc.request_verb} /obp/v6.0.0{publishDoc.request_url}" + ], + "reason": "display of a resource-doc path on a help page" + }, + { + "source": "apps/api-manager/src/routes/+page.server.ts", + "needles": [ + "resolveWebUiValues((path) => obp_requests.get(path), publicEnv, WEB_UI_TEXT)" + ], + "reason": "passes obp_requests to the shared resolveWebUiValues in packages/shared/src/lib/server/obp, which builds the paths" + }, + { + "source": "apps/api-manager/src/routes/backend/app-studio/pages/+server.ts", + "needles": [ + "PORTAL_PAGE_DATA_PATH" + ], + "reason": "/obp/dynamic-entity/... path (PORTAL_PAGE_DATA_PATH), a Dynamic Entity the app defines" + }, + { + "source": "apps/api-manager/src/routes/backend/app-studio/pages/[id]/+server.ts", + "needles": [ + "PORTAL_PAGE_DATA_PATH" + ], + "reason": "/obp/dynamic-entity/... path (PORTAL_PAGE_DATA_PATH), a Dynamic Entity the app defines" + }, + { + "source": "apps/api-manager/src/routes/backend/developer-faq/+server.ts", + "needles": [ + "FAQ_DATA_PATH" + ], + "reason": "/obp/dynamic-entity/... path (FAQ_DATA_PATH), a Dynamic Entity the app defines" + }, + { + "source": "apps/api-manager/src/routes/backend/developer-faq/[id]/+server.ts", + "needles": [ + "FAQ_DATA_PATH" + ], + "reason": "/obp/dynamic-entity/... path (FAQ_DATA_PATH), a Dynamic Entity the app defines" + }, + { + "source": "apps/api-manager/src/routes/backend/developer-faq/[id]/chat-room/+server.ts", + "needles": [ + "`${FAQ_DATA_PATH}/${encodeURIComponent(params.id)}`" + ], + "reason": "/obp/dynamic-entity/... path (FAQ_DATA_PATH), a Dynamic Entity the app defines" + }, + { + "source": "apps/api-manager/src/routes/backend/dynamic-entities/[id]/data/+server.ts", + "needles": [ + "dynamicEntityRecordsPath(bankId, entityName)" + ], + "reason": "records of a Dynamic Entity the app defines (/obp/v7.0.0/banks/BANK_ID/dynamic-entities/ENTITY_NAME, the versioned form of /obp/dynamic-entity/...), not in OBP-API's static docs" + }, + { + "source": "apps/api-manager/src/routes/backend/dynamic-entities/[id]/data/[recordId]/+server.ts", + "needles": [ + "`${dynamicEntityRecordsPath(bankId, entityName)}/${recordId}`" + ], + "reason": "records of a Dynamic Entity the app defines (/obp/v7.0.0/banks/BANK_ID/dynamic-entities/ENTITY_NAME/RECORD_ID, the versioned form of /obp/dynamic-entity/...), not in OBP-API's static docs" + }, + { + "source": "apps/api-manager/src/routes/backend/reports/+server.ts", + "needles": [ + "REPORT_DATA_PATH" + ], + "reason": "/obp/dynamic-entity/... path (REPORT_DATA_PATH), a Dynamic Entity the app defines" + }, + { + "source": "apps/api-manager/src/routes/backend/reports/[id]/+server.ts", + "needles": [ + "REPORT_DATA_PATH" + ], + "reason": "/obp/dynamic-entity/... path (REPORT_DATA_PATH), a Dynamic Entity the app defines" + }, + { + "source": "apps/api-manager/src/routes/login/[provider]/callback/+server.ts", + "needles": [ + "logger.debug(`OBP_API_URL from config: ${OBP_API_URL}`)" + ], + "reason": "A debug log line that prints the base URL." + }, + { + "source": "apps/api-manager/src/routes/login/obp/callback/+server.ts", + "needles": [ + "logger.debug(`OBP_API_URL from config: ${OBP_API_URL}`)" + ], + "reason": "A debug log line that prints the base URL." + }, + { + "source": "apps/api-manager/src/routes/support/+page.server.ts", + "needles": [ + "getWebUiProps((path) => obp_requests.get(path))" + ], + "reason": "passes obp_requests to the shared getWebUiProps in packages/shared/src/lib/server/obp, which builds the paths" + }, + { + "source": "apps/cohort/src/lib/components/PublishedPage.svelte", + "needles": [ + "appStudioPathToProxyPath(req.path, '/pages/obp')" + ], + "reason": "generic proxy pass-through: the published App chooses the whole OBP path" + }, + { + "source": "apps/cohort/src/lib/server/entities/bootstrap.ts", + "needles": [ + "entities[definition.entity_name] = await ensureDynamicEntity(definition, {" + ], + "reason": "hands obpRequests to the shared ensureDynamicEntity; its calls are listed at packages/shared/src/lib/server/obp/dynamicEntityBootstrap.ts" + }, + { + "source": "apps/cohort/src/lib/server/forms.ts", + "needles": [ + "listRecords(form.entity_name, access, token, cohortFormsSpace())" + ], + "reason": "form answers are records of the app's own Dynamic Entities (see records.ts)" + }, + { + "source": "apps/cohort/src/lib/server/opeyGuide.ts", + "needles": [ + "const base = dynamicEntityDataPath(space);" + ], + "reason": "builds Dynamic Entity record URLs as text for Opey's prompt; nothing is requested" + }, + { + "source": "apps/cohort/src/lib/server/pageView.ts", + "needles": [ + "buildLandingFetchers((path, t) => obpRequests.get(path, t), app.token ?? undefined, {" + ], + "reason": "hands obpRequests to the shared landing fetchers; their calls are listed at packages/shared/src/lib/server/landing/fetchers.ts" + }, + { + "source": "apps/cohort/src/lib/server/records.ts", + "needles": [ + "const base = dynamicEntityDataPath(space);" + ], + "reason": "reads and writes Cohort's own Dynamic Entity records at /obp/v7.0.0/banks/BANK_ID/dynamic-entities/[my|public|community/]ENTITY: entities the app defines itself, documented only per entity on the instance that has them (like /obp/dynamic-entity/...)" + }, + { + "source": "apps/cohort/src/lib/server/sitePages.ts", + "needles": [ + "fetchSitePageRecords((path, t) => obpRequests.get(path, t), app.token)" + ], + "reason": "reads the obp_portal_page Dynamic Entity records (/obp/dynamic-entity/obp_portal_page) through the shared fetchSitePageRecords" + }, + { + "source": "apps/portal/src/lib/server/faq/faqChat.ts", + "needles": [ + "`/obp/dynamic-entity/public/${ENTITY}/${encodeURIComponent(id)}`", + "`/obp/dynamic-entity/${ENTITY}/${encodeURIComponent(id)}`" + ], + "reason": "Dynamic entity paths the apps define themselves, not part of OBP-API's static docs." + }, + { + "source": "apps/portal/src/lib/server/faq/faqItems.ts", + "needles": [ + "`/obp/dynamic-entity/public/${ENTITY}/${encodeURIComponent(id)}`" + ], + "reason": "Dynamic entity path the apps define themselves, not part of OBP-API's static docs." + }, + { + "source": "apps/portal/src/lib/server/landing/portalPages.ts", + "needles": [ + "fetchSitePageRecords((path, token) => obp_requests.get(path, token), tokenResult.token)" + ], + "reason": "Hands obp_requests.get to fetchSitePageRecords (packages/shared server/landing/pages.ts), which chooses the path, a /obp/dynamic-entity/ path the apps define themselves." + }, + { + "source": "apps/portal/src/lib/server/opeyConversations/opeyConversationEntity.ts", + "needles": [ + "get: (path, token) => obp_requests.get(path, token),", + "post: (path, body, token) => obp_requests.post(path, body, token),", + "put: (path, body, token) => obp_requests.put(path, body, token)," + ], + "reason": "Generic get/post/put adapters handed to ensureSystemDynamicEntity (packages/shared server/obp/dynamicEntityBootstrap.ts), which chooses the dynamic entity definition paths; the calls are listed in packages/shared." + }, + { + "source": "apps/portal/src/routes/(protected)/confirm-bg-consent-request-sca/+page.server.ts", + "needles": [ + "`/berlin-group/v1.3/consents/${consentId}/authorisations`", + "`/berlin-group/v1.3/consents/${consentId}/authorisations/${authorisationId}`" + ], + "reason": "Berlin Group paths, not covered yet." + }, + { + "source": "apps/portal/src/routes/(protected)/otp/+page.server.ts", + "needles": [ + "`/berlin-group/v1.3/${paymentService}/${paymentProduct}/${paymentId}/authorisations`", + "`/berlin-group/v1.3/${paymentService}/${paymentProduct}/${paymentId}/authorisations/${authorisationId}`" + ], + "reason": "Berlin Group paths, not covered yet." + }, + { + "source": "apps/portal/src/routes/(protected)/uk-consent-request/+page.server.ts", + "needles": [ + "`/open-banking/v4.0.1/aisp/account-access-consents/${consentId}`", + "`/open-banking/v3.1/account-access-consents/${consentId}`" + ], + "reason": "UK Open Banking paths, not covered yet." + }, + { + "source": "apps/portal/src/routes/(protected)/user/my-data/+page.server.ts", + "needles": [ + "`/obp/dynamic-entity/banks/${entity.bankId}/my/${entity.entityName}`", + "`/obp/dynamic-entity/my/${entity.entityName}`" + ], + "reason": "Dynamic entity data paths the apps define themselves, not part of OBP-API's static docs." + }, + { + "source": "apps/portal/src/routes/+layout.server.ts", + "needles": [ + "resolveWebUiValues((path) => obp_requests.get(path), publicEnv, WEB_UI_TEXT)" + ], + "reason": "Hands obp_requests.get to resolveWebUiValues (packages/shared server/obp/webUiProps.ts), which GETs /obp/v6.0.0/webui-props; the call is listed there." + }, + { + "source": "apps/portal/src/routes/api-explorer/endpoint/[verb]/[...path]/+page.server.ts", + "needles": [ + "fetchApiVersions(obp_requests)", + "fetchResourceDocs(obp_requests, version.fullyQualifiedVersion)" + ], + "reason": "Hands obp_requests to fetchApiVersions and fetchResourceDocs (packages/shared server/explorer), which choose the paths; the calls are listed there." + }, + { + "source": "apps/portal/src/routes/api-explorer/resource-docs/[version]/+page.server.ts", + "needles": [ + "fetchApiVersions(obp_requests)", + "fetchResourceDocs(obp_requests, version.fullyQualifiedVersion)" + ], + "reason": "Hands obp_requests to fetchApiVersions and fetchResourceDocs (packages/shared server/explorer), which choose the paths; the calls are listed there." + }, + { + "source": "apps/portal/src/routes/developers/oauth2-oidc/+page.svelte", + "needles": [ + "`${ctx.apiBaseUrl}/obp/v5.1.0/well-known`" + ], + "reason": "Link (href) shown on the OAuth2/OIDC help page; nothing is requested with it." + }, + { + "source": "apps/portal/src/routes/developers/oauth2-oidc/+page.svelte", + "needles": [ + "https://YOUR_OBP_HOST/obp/v6.0.0/my/accounts" + ], + "reason": "Example curl command shown in a code block on the help page." + }, + { + "source": "apps/portal/src/routes/faq/+page.server.ts", + "needles": [ + "`/obp/dynamic-entity/public/${ENTITY}`" + ], + "reason": "Dynamic entity path the apps define themselves, not part of OBP-API's static docs." + }, + { + "source": "apps/portal/src/routes/pages/[slug]/+page.server.ts", + "needles": [ + "buildLandingFetchers((path, t) => obp_requests.get(path, t), token, {" + ], + "reason": "Hands obp_requests.get to buildLandingFetchers (packages/shared server/landing/fetchers.ts), which chooses the paths (resource-docs, api-products, api-collection-endpoints, banks); the calls are listed there." + }, + { + "source": "apps/portal/src/routes/pages/[slug]/+page.svelte", + "needles": [ + "appStudioPathToProxyPath(req.path, '/pages/obp')" + ], + "reason": "Generic proxy pass-through: the App Studio page chooses the whole /obp/ path at run time." + }, + { + "source": "apps/portal/src/routes/register/+page.server.ts", + "needles": [ + "getWebUiProps((path) => obp_requests.get(path))" + ], + "reason": "Hands obp_requests.get to getWebUiProps (packages/shared server/obp/webUiProps.ts), which GETs /obp/v6.0.0/webui-props; the call is listed there." + }, + { + "source": "apps/portal/src/routes/support/+page.server.ts", + "needles": [ + "getWebUiProps((path) => obp_requests.get(path))" + ], + "reason": "Hands obp_requests.get to getWebUiProps (packages/shared server/obp/webUiProps.ts), which GETs /obp/v6.0.0/webui-props; the call is listed there." + }, + { + "source": "packages/shared/src/lib/components/OpeyChat.svelte", + "needles": [ + "'/obp/v5.1.0/banks/gh.29.uk/accounts'", + "'/obp/v5.1.0/accounts/123'", + "'/obp/v5.1.0/accounts'" + ], + "reason": "fixture: tool inputs of a temporary test batch-approval message; nothing is requested" + }, + { + "source": "packages/shared/src/lib/components/appStudioShim.ts", + "needles": [ + "if (!trimmed.startsWith('/obp/')) return null;" + ], + "reason": "generic proxy pass-through helper: the App chooses the whole OBP path" + }, + { + "source": "packages/shared/src/lib/health-check/services/OIDCHealthCheckService.ts", + "needles": [ + "'not available: this OBP-API has no GET /obp/v7.0.0/consumers/current/identity'" + ], + "reason": "status note text naming the endpoint" + }, + { + "source": "packages/shared/src/lib/landing/registry.ts", + "needles": [ + "curl https://…/obp/v6.0.0/banks" + ], + "reason": "example markup in a block's help text" + }, + { + "source": "packages/shared/src/lib/obp/dynamicEntitySpace.ts", + "needles": [ + "`/obp/v7.0.0/management/banks/${encodeURIComponent(space)}/dynamic-entities`" + ], + "reason": "builds the path for calls listed at its callers: apps/cohort/src/lib/server/forms.ts, packages/shared/src/lib/server/obp/dynamicEntityBootstrap.ts, and the API Manager (domainApis.ts, dynamicEntityWebhooks.ts, opeyNotebook.ts, dynamicEntities/definitions.ts, routes under dynamic-entities and app-studio)" + }, + { + "source": "packages/shared/src/lib/obp/dynamicEntitySpace.ts", + "needles": [ + "`/obp/v7.0.0/banks/${encodeURIComponent(space)}/dynamic-entities`" + ], + "reason": "builds record URLs of the apps' own Dynamic Entities (entity named at run time; like /obp/dynamic-entity/..., documented only per entity on the instance that has them); used by cohort records.ts and opeyGuide.ts, opey/recording/ConversationRowStore.ts and API Manager pages" + }, + { + "source": "packages/shared/src/lib/opey/recording/ConversationRowStore.ts", + "needles": [ + "`${dynamicEntityDataPath(options.bankId)}/my/${encodeURIComponent(entityName)}`", + "`/obp/dynamic-entity/my/${encodeURIComponent(entityName)}`" + ], + "reason": "records Opey conversations in an app-defined personal Dynamic Entity; not part of OBP-API's static docs" + }, + { + "source": "packages/shared/src/lib/server/landing/pages.ts", + "needles": [ + "`/obp/dynamic-entity/${SITE_PAGE_ENTITY}`" + ], + "reason": "app-defined Dynamic Entity records (obp_portal_page), not part of OBP-API's static docs" + } + ] +} From aa8719181dd9a71c193e9edef99a70eefe5fd12f Mon Sep 17 00:00:00 2001 From: Hongwei Date: Fri, 13 Nov 2026 00:44:50 +0100 Subject: [PATCH 2/6] test: add snapshot.py and the resource-docs snapshot of k8s.openbankproject.com --- obp-api-contract/snapshot.json | 14914 +++++++++++++++++++++++++++++++ obp-api-contract/snapshot.py | 152 + 2 files changed, 15066 insertions(+) create mode 100644 obp-api-contract/snapshot.json create mode 100644 obp-api-contract/snapshot.py diff --git a/obp-api-contract/snapshot.json b/obp-api-contract/snapshot.json new file mode 100644 index 00000000..586a55c4 --- /dev/null +++ b/obp-api-contract/snapshot.json @@ -0,0 +1,14914 @@ +{ + "about": "Written by obp-api-contract/snapshot.py; do not edit by hand.", + "obp_api": { + "https://k8s.openbankproject.com": { + "version": "v7.0.0", + "git_commit": "474d4bcc554f1d8e9516e12d85be121d92410aa5" + } + }, + "taken_at": "2026-11-12T23:43:43Z", + "endpoints": [ + { + "verb": "GET", + "path": "/obp/v6.0.0/root", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-root", + "documented_path": "/obp/v6.0.0/root", + "fields": [ + "connector", + "energy_source", + "energy_source.organisation", + "energy_source.organisation_website", + "git_commit", + "hosted_at", + "hosted_at.organisation", + "hosted_at.organisation_website", + "hosted_by", + "hosted_by.email", + "hosted_by.organisation", + "hosted_by.organisation_website", + "hosted_by.phone", + "hostname", + "local_identity_provider", + "resource_docs_requires_role", + "version", + "version_status" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createBankLevelEndpointMapping", + "documented_path": "/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings", + "fields": [ + "endpoint_mapping_id", + "operation_id", + "request_mapping", + "response_mapping", + "response_mapping.balance", + "response_mapping.balance.entity", + "response_mapping.balance.field", + "response_mapping.balance.query", + "response_mapping.name", + "response_mapping.name.entity", + "response_mapping.name.field", + "response_mapping.name.query" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings/ENDPOINT_MAPPING_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteBankLevelEndpointMapping", + "documented_path": "/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings/ENDPOINT_MAPPING_ID", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings/ENDPOINT_MAPPING_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-updateBankLevelEndpointMapping", + "documented_path": "/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings/ENDPOINT_MAPPING_ID", + "fields": [ + "endpoint_mapping_id", + "operation_id", + "request_mapping", + "response_mapping", + "response_mapping.balance", + "response_mapping.balance.entity", + "response_mapping.balance.field", + "response_mapping.balance.query", + "response_mapping.name", + "response_mapping.name.entity", + "response_mapping.name.field", + "response_mapping.name.query" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/endpoint-mappings", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createEndpointMapping", + "documented_path": "/obp/v5.1.0/management/endpoint-mappings", + "fields": [ + "endpoint_mapping_id", + "operation_id", + "request_mapping", + "response_mapping", + "response_mapping.balance", + "response_mapping.balance.entity", + "response_mapping.balance.field", + "response_mapping.balance.query", + "response_mapping.name", + "response_mapping.name.entity", + "response_mapping.name.field", + "response_mapping.name.query" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteEndpointMapping", + "documented_path": "/obp/v5.1.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-updateEndpointMapping", + "documented_path": "/obp/v5.1.0/management/endpoint-mappings/ENDPOINT_MAPPING_ID", + "fields": [ + "endpoint_mapping_id", + "operation_id", + "request_mapping", + "response_mapping", + "response_mapping.balance", + "response_mapping.balance.entity", + "response_mapping.balance.field", + "response_mapping.balance.query", + "response_mapping.name", + "response_mapping.name.entity", + "response_mapping.name.field", + "response_mapping.name.query" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteJsonSchemaValidation", + "documented_path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "fields": [] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createJsonSchemaValidation", + "documented_path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "fields": [ + "json_schema", + "json_schema.$schema", + "json_schema.additionalProperties", + "json_schema.description", + "json_schema.properties", + "json_schema.properties.xxx_id", + "json_schema.properties.xxx_id.examples", + "json_schema.properties.xxx_id.examples[]", + "json_schema.properties.xxx_id.maxLength", + "json_schema.properties.xxx_id.minLength", + "json_schema.properties.xxx_id.type", + "json_schema.required", + "json_schema.required[]", + "json_schema.title", + "json_schema.type", + "operation_id" + ] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-updateJsonSchemaValidation", + "documented_path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "fields": [ + "json_schema", + "json_schema.$schema", + "json_schema.additionalProperties", + "json_schema.description", + "json_schema.properties", + "json_schema.properties.xxx_id", + "json_schema.properties.xxx_id.examples", + "json_schema.properties.xxx_id.examples[]", + "json_schema.properties.xxx_id.maxLength", + "json_schema.properties.xxx_id.minLength", + "json_schema.properties.xxx_id.type", + "json_schema.required", + "json_schema.required[]", + "json_schema.title", + "json_schema.type", + "operation_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/dynamic-resource-docs/endpoint-code", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-buildDynamicEndpointTemplate", + "documented_path": "/obp/v5.1.0/management/dynamic-resource-docs/endpoint-code", + "fields": [ + "code" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/dynamic-resource-docs/compile", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-compileDynamicResourceDoc", + "documented_path": "/obp/v7.0.0/management/dynamic-resource-docs/compile", + "fields": [ + "compiles", + "duration_ms", + "errors", + "errors[]", + "errors[].column", + "errors[].line", + "errors[].message", + "errors[].severity" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/dynamic-resource-docs/explain", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-explainDynamicQuery", + "documented_path": "/obp/v7.0.0/management/dynamic-resource-docs/explain", + "fields": [ + "caller_may_run", + "entities", + "entities[]", + "entities[].bank_id", + "entities[].caller_may_read", + "entities[].entity", + "entities[].public_access", + "entities[].read_role", + "entities[].row_level_access", + "explained_for", + "refusal", + "restricted_fields", + "restricted_fields[]", + "rules", + "rules[]", + "space", + "steps", + "steps[]", + "steps[].backend", + "steps[].notes", + "steps[].notes[]", + "steps[].parameter_count", + "steps[].purpose", + "steps[].sql", + "steps[].step" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/email/USER_EMAIL/terminator", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getUsersByEmail", + "documented_path": "/obp/v5.1.0/users/email/USER_EMAIL/terminator", + "fields": [ + "users", + "users[]", + "users[].agreements", + "users[].agreements[]", + "users[].agreements[].text", + "users[].agreements[].type", + "users[].email", + "users[].entitlements", + "users[].entitlements.list", + "users[].entitlements.list[]", + "users[].entitlements.list[].bank_id", + "users[].entitlements.list[].entitlement_id", + "users[].entitlements.list[].role_name", + "users[].is_deleted", + "users[].is_locked", + "users[].last_marketing_agreement_signed_date", + "users[].provider", + "users[].provider_id", + "users[].user_id", + "users[].username", + "users[].views", + "users[].views.list", + "users[].views.list[]", + "users[].views.list[].account_id", + "users[].views.list[].bank_id", + "users[].views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/providers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getProviders", + "documented_path": "/obp/v6.0.0/providers", + "fields": [ + "providers", + "providers[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUsers", + "documented_path": "/obp/v6.0.0/users", + "fields": [ + "users", + "users[]", + "users[].agreements", + "users[].agreements[]", + "users[].agreements[].text", + "users[].agreements[].type", + "users[].created_date", + "users[].email", + "users[].email_validated", + "users[].entitlements", + "users[].entitlements.list", + "users[].entitlements.list[]", + "users[].entitlements.list[].bank_id", + "users[].entitlements.list[].entitlement_id", + "users[].entitlements.list[].role_name", + "users[].first_name", + "users[].is_deleted", + "users[].is_locked", + "users[].last_marketing_agreement_signed_date", + "users[].last_name", + "users[].last_used_locale", + "users[].provider", + "users[].provider_id", + "users[].updated_date", + "users[].user_id", + "users[].username", + "users[].views", + "users[].views.list", + "users[].views.list[]", + "users[].views.list[].account_id", + "users[].views.list[].bank_id", + "users[].views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user-id/USER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUserByUserId", + "documented_path": "/obp/v6.0.0/users/user-id/USER_ID", + "fields": [ + "agreements", + "agreements[]", + "agreements[].text", + "agreements[].type", + "created_date", + "email", + "email_validated", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "first_name", + "is_deleted", + "is_locked", + "last_activity_date", + "last_marketing_agreement_signed_date", + "last_name", + "last_used_locale", + "provider", + "provider_id", + "recent_operation_ids", + "recent_operation_ids[]", + "updated_date", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/well-known", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getOAuth2ServerWellKnown", + "documented_path": "/obp/v6.0.0/well-known", + "fields": [ + "jwks_uris", + "jwks_uris[]", + "jwks_uris[].jwks_uri" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/app-directory", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAppDirectory", + "documented_path": "/obp/v7.0.0/app-directory", + "fields": [ + "app_directory", + "app_directory[]", + "app_directory[].name", + "app_directory[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/method_routings", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-getMethodRoutings", + "documented_path": "/obp/v5.1.0/management/method_routings", + "fields": [ + "method_routings", + "method_routings[]", + "method_routings[].bank_id_pattern", + "method_routings[].connector_name", + "method_routings[].is_bank_id_exact_match", + "method_routings[].method_name", + "method_routings[].method_routing_id", + "method_routings[].parameters", + "method_routings[].parameters[]", + "method_routings[].parameters[].key", + "method_routings[].parameters[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/config-props", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getConfigProps", + "documented_path": "/obp/v6.0.0/management/config-props", + "fields": [ + "config_props", + "config_props[]", + "config_props[].name", + "config_props[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityDefinitions", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[].auth_mode", + "dynamic_entities[].bank_id", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.description", + "dynamic_entities[].schema.properties.language.example", + "dynamic_entities[].schema.properties.language.maxLength", + "dynamic_entities[].schema.properties.language.minLength", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.description", + "dynamic_entities[].schema.properties.theme.example", + "dynamic_entities[].schema.properties.theme.indexed", + "dynamic_entities[].schema.properties.theme.maxLength", + "dynamic_entities[].schema.properties.theme.minLength", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/dynamic-code-approval-config", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicCodeApprovalConfig", + "documented_path": "/obp/v7.0.0/management/dynamic-code-approval-config", + "fields": [ + "approval_role", + "delete_requires_approval", + "dynamic_code_execution_enabled", + "request_ttl_hours", + "requires_approval", + "target_types", + "target_types[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityDefinitions", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[].auth_mode", + "dynamic_entities[].bank_id", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.description", + "dynamic_entities[].schema.properties.language.example", + "dynamic_entities[].schema.properties.language.maxLength", + "dynamic_entities[].schema.properties.language.minLength", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.description", + "dynamic_entities[].schema.properties.theme.example", + "dynamic_entities[].schema.properties.theme.indexed", + "dynamic_entities[].schema.properties.theme.maxLength", + "dynamic_entities[].schema.properties.theme.minLength", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityDefinitions", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[].auth_mode", + "dynamic_entities[].bank_id", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.description", + "dynamic_entities[].schema.properties.language.example", + "dynamic_entities[].schema.properties.language.maxLength", + "dynamic_entities[].schema.properties.language.minLength", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.description", + "dynamic_entities[].schema.properties.theme.example", + "dynamic_entities[].schema.properties.theme.indexed", + "dynamic_entities[].schema.properties.theme.maxLength", + "dynamic_entities[].schema.properties.theme.minLength", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/api/glossary", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getApiGlossary", + "documented_path": "/obp/v5.1.0/api/glossary", + "fields": [ + "glossary_items", + "glossary_items[]", + "glossary_items[].description", + "glossary_items[].description.html", + "glossary_items[].description.markdown", + "glossary_items[].title" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/api/glossary", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getGlossary", + "documented_path": "/obp/v7.0.0/api/glossary", + "fields": [ + "glossary_items", + "glossary_items[]", + "glossary_items[].description", + "glossary_items[].description.html", + "glossary_items[].description.markdown", + "glossary_items[].is_dynamic", + "glossary_items[].overrides_static_item", + "glossary_items[].shadows_static_glossary_item", + "glossary_items[].title", + "total_count" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityDefinitions", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[].auth_mode", + "dynamic_entities[].bank_id", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.description", + "dynamic_entities[].schema.properties.language.example", + "dynamic_entities[].schema.properties.language.maxLength", + "dynamic_entities[].schema.properties.language.minLength", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.description", + "dynamic_entities[].schema.properties.theme.example", + "dynamic_entities[].schema.properties.theme.indexed", + "dynamic_entities[].schema.properties.theme.maxLength", + "dynamic_entities[].schema.properties.theme.minLength", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createDynamicEntityDefinition", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "auth_mode", + "bank_id", + "dynamic_entity_id", + "entity_name", + "has_community_access", + "has_personal_entity", + "has_public_access", + "personal_requires_role", + "schema", + "schema.description", + "schema.properties", + "schema.properties.language", + "schema.properties.language.description", + "schema.properties.language.example", + "schema.properties.language.maxLength", + "schema.properties.language.minLength", + "schema.properties.language.type", + "schema.properties.theme", + "schema.properties.theme.description", + "schema.properties.theme.example", + "schema.properties.theme.indexed", + "schema.properties.theme.maxLength", + "schema.properties.theme.minLength", + "schema.properties.theme.type", + "schema.required", + "schema.required[]", + "schema.required[].s", + "use_row_level_access", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/platform-apps", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getPlatformApps", + "documented_path": "/obp/v7.0.0/management/platform-apps", + "fields": [ + "platform_apps", + "platform_apps[]", + "platform_apps[].consumer_id", + "platform_apps[].consumer_name", + "platform_apps[].declared_at", + "platform_apps[].label", + "platform_apps[].marked_at", + "platform_apps[].marked_by_user_id", + "platform_apps[].required_scopes", + "platform_apps[].required_scopes[]", + "platform_apps[].required_scopes[].bank_id", + "platform_apps[].required_scopes[].held", + "platform_apps[].required_scopes[].needed_for", + "platform_apps[].required_scopes[].optional", + "platform_apps[].required_scopes[].role_name", + "platform_apps[].state", + "platform_apps[].version" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createDomainApi", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis", + "fields": [ + "bank_id", + "base_path", + "created_at", + "created_by_user_id", + "description", + "domain_api_id", + "is_publicly_discoverable", + "openapi_url", + "title", + "updated_at", + "url", + "version" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis/DOMAIN_API_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-deleteDomainApi", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis/DOMAIN_API_ID", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis/DOMAIN_API_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateDomainApi", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis/DOMAIN_API_ID", + "fields": [ + "bank_id", + "base_path", + "created_at", + "created_by_user_id", + "description", + "domain_api_id", + "is_publicly_discoverable", + "openapi_url", + "title", + "updated_at", + "url", + "version" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createDynamicEntityWebhook", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks", + "fields": [ + "bank_id", + "created_at", + "created_by_user_id", + "description", + "dynamic_entity_id", + "entity_name", + "events", + "events[]", + "field_conditions", + "field_conditions[]", + "field_conditions[].field", + "field_conditions[].from", + "field_conditions[].from.value", + "field_conditions[].to", + "field_conditions[].to.value", + "is_active", + "signature_status", + "updated_at", + "url", + "webhook_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-deleteDynamicEntityWebhook", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateDynamicEntityWebhook", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID", + "fields": [ + "bank_id", + "created_at", + "created_by_user_id", + "description", + "dynamic_entity_id", + "entity_name", + "events", + "events[]", + "field_conditions", + "field_conditions[]", + "field_conditions[].field", + "field_conditions[].from", + "field_conditions[].from.value", + "field_conditions[].to", + "field_conditions[].to.value", + "is_active", + "signature_status", + "updated_at", + "url", + "webhook_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID/deliveries", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityWebhookDeliveries", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID/deliveries", + "fields": [ + "deliveries", + "deliveries[]", + "deliveries[].attempts", + "deliveries[].created_at", + "deliveries[].event_id", + "deliveries[].event_name", + "deliveries[].last_error", + "deliveries[].last_http_status", + "deliveries[].record_id", + "deliveries[].status", + "deliveries[].updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID/deliveries/EVENT_ID/retry", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-retryDynamicEntityWebhookDelivery", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID/deliveries/EVENT_ID/retry", + "fields": [ + "attempts", + "created_at", + "event_id", + "event_name", + "status", + "updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID/test", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-testDynamicEntityWebhook", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID/test", + "fields": [ + "attempts", + "created_at", + "event_id", + "event_name", + "status", + "updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/api/glossary", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createGlossaryItem", + "documented_path": "/obp/v7.0.0/api/glossary", + "fields": [ + "created_at", + "created_by_user_id", + "description", + "description.html", + "description.markdown", + "glossary_item_id", + "is_dynamic", + "overrides_static_item", + "shadows_static_glossary_item", + "title", + "updated_at" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/api/glossary/TITLE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-deleteGlossaryItem", + "documented_path": "/obp/v7.0.0/api/glossary/TITLE", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/api/glossary/TITLE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateGlossaryItem", + "documented_path": "/obp/v7.0.0/api/glossary/TITLE", + "fields": [ + "created_at", + "created_by_user_id", + "description", + "description.html", + "description.markdown", + "glossary_item_id", + "is_dynamic", + "overrides_static_item", + "shadows_static_glossary_item", + "title", + "updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/json-schema-validations", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getAllJsonSchemaValidations", + "documented_path": "/obp/v5.1.0/management/json-schema-validations", + "fields": [ + "json_schema_validations", + "json_schema_validations[]", + "json_schema_validations[].json_schema", + "json_schema_validations[].json_schema.$schema", + "json_schema_validations[].json_schema.additionalProperties", + "json_schema_validations[].json_schema.description", + "json_schema_validations[].json_schema.properties", + "json_schema_validations[].json_schema.properties.xxx_id", + "json_schema_validations[].json_schema.properties.xxx_id.examples", + "json_schema_validations[].json_schema.properties.xxx_id.examples[]", + "json_schema_validations[].json_schema.properties.xxx_id.maxLength", + "json_schema_validations[].json_schema.properties.xxx_id.minLength", + "json_schema_validations[].json_schema.properties.xxx_id.type", + "json_schema_validations[].json_schema.required", + "json_schema_validations[].json_schema.required[]", + "json_schema_validations[].json_schema.title", + "json_schema_validations[].json_schema.type", + "json_schema_validations[].operation_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteJsonSchemaValidation", + "documented_path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getJsonSchemaValidation", + "documented_path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "fields": [ + "json_schema", + "json_schema.$schema", + "json_schema.additionalProperties", + "json_schema.description", + "json_schema.properties", + "json_schema.properties.xxx_id", + "json_schema.properties.xxx_id.examples", + "json_schema.properties.xxx_id.examples[]", + "json_schema.properties.xxx_id.maxLength", + "json_schema.properties.xxx_id.minLength", + "json_schema.properties.xxx_id.type", + "json_schema.required", + "json_schema.required[]", + "json_schema.title", + "json_schema.type", + "operation_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createJsonSchemaValidation", + "documented_path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "fields": [ + "json_schema", + "json_schema.$schema", + "json_schema.additionalProperties", + "json_schema.description", + "json_schema.properties", + "json_schema.properties.xxx_id", + "json_schema.properties.xxx_id.examples", + "json_schema.properties.xxx_id.examples[]", + "json_schema.properties.xxx_id.maxLength", + "json_schema.properties.xxx_id.minLength", + "json_schema.properties.xxx_id.type", + "json_schema.required", + "json_schema.required[]", + "json_schema.title", + "json_schema.type", + "operation_id" + ] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-updateJsonSchemaValidation", + "documented_path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "fields": [ + "json_schema", + "json_schema.$schema", + "json_schema.additionalProperties", + "json_schema.description", + "json_schema.properties", + "json_schema.properties.xxx_id", + "json_schema.properties.xxx_id.examples", + "json_schema.properties.xxx_id.examples[]", + "json_schema.properties.xxx_id.maxLength", + "json_schema.properties.xxx_id.minLength", + "json_schema.properties.xxx_id.type", + "json_schema.required", + "json_schema.required[]", + "json_schema.title", + "json_schema.type", + "operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/connector-method-names", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getConnectorMethodNames", + "documented_path": "/obp/v6.0.0/system/connector-method-names", + "fields": [ + "connector_method_names", + "connector_method_names[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.1.0-getRoles", + "documented_path": "/obp/v6.0.0/roles", + "fields": [ + "roles", + "roles[]", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/abac-rules", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAbacRules", + "documented_path": "/obp/v6.0.0/management/abac-rules", + "fields": [ + "abac_rules", + "abac_rules[]", + "abac_rules[].abac_rule_id", + "abac_rules[].created_by_user_id", + "abac_rules[].description", + "abac_rules[].is_active", + "abac_rules[].policy", + "abac_rules[].rule_code", + "abac_rules[].rule_name", + "abac_rules[].updated_by_user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/abac-rules/ABAC_RULE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAbacRule", + "documented_path": "/obp/v6.0.0/management/abac-rules/ABAC_RULE_ID", + "fields": [ + "abac_rule_id", + "created_by_user_id", + "description", + "is_active", + "policy", + "rule_code", + "rule_name", + "updated_by_user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/abac-rules-schema", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAbacRuleSchema", + "documented_path": "/obp/v6.0.0/management/abac-rules-schema", + "fields": [ + "available_operators", + "available_operators[]", + "examples", + "examples[]", + "examples[].description", + "examples[].is_active", + "examples[].policy", + "examples[].rule_code", + "examples[].rule_name", + "notes", + "notes[]", + "object_types", + "object_types[]", + "object_types[].description", + "object_types[].name", + "object_types[].properties", + "object_types[].properties[]", + "object_types[].properties[].description", + "object_types[].properties[].name", + "object_types[].properties[].type", + "parameters", + "parameters[]", + "parameters[].category", + "parameters[].description", + "parameters[].name", + "parameters[].required", + "parameters[].type" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/abac-rules/validate", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-validateAbacRule", + "documented_path": "/obp/v6.0.0/management/abac-rules/validate", + "fields": [ + "message", + "valid" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/abac-rules/ABAC_RULE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAbacRule", + "documented_path": "/obp/v6.0.0/management/abac-rules/ABAC_RULE_ID", + "fields": [ + "abac_rule_id", + "created_by_user_id", + "description", + "is_active", + "policy", + "rule_code", + "rule_name", + "updated_by_user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/account-directory", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAccountDirectory", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/account-directory", + "fields": [ + "accounts", + "accounts[]", + "accounts[].account_attributes", + "accounts[].account_attributes[]", + "accounts[].account_attributes[].code", + "accounts[].account_attributes[].type", + "accounts[].account_attributes[].value", + "accounts[].account_id", + "accounts[].account_number", + "accounts[].account_routings", + "accounts[].account_routings[]", + "accounts[].account_routings[].address", + "accounts[].account_routings[].scheme", + "accounts[].account_type", + "accounts[].bank_id", + "accounts[].branch_id", + "accounts[].label", + "accounts[].view_ids", + "accounts[].view_ids[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAccountsAtBank", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts", + "fields": [ + "accounts", + "accounts[]", + "accounts[].account_id", + "accounts[].bank_id", + "accounts[].label", + "accounts[].views_available", + "accounts[].views_available[]", + "accounts[].views_available[].id", + "accounts[].views_available[].is_public", + "accounts[].views_available[].short_name" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/products/PRODUCT_CODE/attribute", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-createAccountAttribute", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/products/PRODUCT_CODE/attribute", + "fields": [ + "account_attribute_id", + "name", + "product_code", + "product_instance_code", + "type", + "value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getPrivateAccountByIdFull", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account", + "fields": [ + "account_attributes", + "account_attributes[]", + "account_attributes[].account_attribute_id", + "account_attributes[].name", + "account_attributes[].product_code", + "account_attributes[].product_instance_code", + "account_attributes[].type", + "account_attributes[].value", + "account_routings", + "account_routings[]", + "account_routings[].address", + "account_routings[].scheme", + "balance", + "balance.amount", + "balance.currency", + "bank_id", + "id", + "label", + "number", + "owners", + "owners[]", + "owners[].display_name", + "owners[].id", + "owners[].provider", + "product_code", + "tags", + "tags[]", + "tags[].date", + "tags[].id", + "tags[].user", + "tags[].user.display_name", + "tags[].user.id", + "tags[].user.provider", + "tags[].value", + "views_available", + "views_available[]", + "views_available[].account_id", + "views_available[].alias", + "views_available[].allowed_actions", + "views_available[].allowed_actions[]", + "views_available[].bank_id", + "views_available[].can_grant_access_to_views", + "views_available[].can_grant_access_to_views[]", + "views_available[].can_revoke_access_to_views", + "views_available[].can_revoke_access_to_views[]", + "views_available[].description", + "views_available[].hide_metadata_if_alias_used", + "views_available[].is_firehose", + "views_available[].is_public", + "views_available[].is_system", + "views_available[].metadata_view", + "views_available[].view_id", + "views_available[].view_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/has-account-access", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-hasAccountAccess", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/has-account-access", + "fields": [ + "abac_rule_id", + "access_source", + "account_access_id", + "has_account_access" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/users-with-access", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUsersWithAccountAccess", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID/users-with-access", + "fields": [ + "users", + "users[]", + "users[].access_source", + "users[].email", + "users[].provider", + "users[].user_id", + "users[].username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/abac-rules", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAbacRules", + "documented_path": "/obp/v6.0.0/management/abac-rules", + "fields": [ + "abac_rules", + "abac_rules[]", + "abac_rules[].abac_rule_id", + "abac_rules[].created_by_user_id", + "abac_rules[].description", + "abac_rules[].is_active", + "abac_rules[].policy", + "abac_rules[].rule_code", + "abac_rules[].rule_name", + "abac_rules[].updated_by_user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/TARGET_VIEW_ID/users/TARGET_USER_ID/account-access-trace", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getAccountAccessTrace", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/views/TARGET_VIEW_ID/users/TARGET_USER_ID/account-access-trace", + "fields": [ + "abac_trace", + "abac_trace.allow_abac_account_access", + "abac_trace.policy", + "abac_trace.rules_evaluated", + "abac_trace.rules_evaluated[]", + "abac_trace.standalone_abac_result", + "access_source", + "account_access_trace", + "account_access_trace.account_access_view_ids", + "account_access_trace.account_access_view_ids[]", + "account_access_trace.has_account_access_for_view", + "account_id", + "bank_id", + "entitlement_trace", + "entitlement_trace.has_can_execute_abac_rule", + "has_access", + "user_id", + "view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getExplicitCounterpartiesForAccount", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties", + "fields": [ + "counterparties", + "counterparties[]", + "counterparties[].bespoke", + "counterparties[].bespoke[]", + "counterparties[].bespoke[].key", + "counterparties[].bespoke[].value", + "counterparties[].counterparty_id", + "counterparties[].created_by_user_id", + "counterparties[].currency", + "counterparties[].description", + "counterparties[].is_beneficiary", + "counterparties[].name", + "counterparties[].other_account_routing_address", + "counterparties[].other_account_routing_scheme", + "counterparties[].other_account_secondary_routing_address", + "counterparties[].other_account_secondary_routing_scheme", + "counterparties[].other_bank_routing_address", + "counterparties[].other_bank_routing_scheme", + "counterparties[].other_branch_routing_address", + "counterparties[].other_branch_routing_scheme", + "counterparties[].this_account_id", + "counterparties[].this_bank_id", + "counterparties[].this_view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getExplicitCounterpartyById", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID", + "fields": [ + "bespoke", + "bespoke[]", + "bespoke[].key", + "bespoke[].value", + "counterparty_id", + "created_by_user_id", + "currency", + "description", + "is_beneficiary", + "metadata", + "metadata.corporate_location", + "metadata.corporate_location.date", + "metadata.corporate_location.latitude", + "metadata.corporate_location.longitude", + "metadata.corporate_location.user", + "metadata.corporate_location.user.id", + "metadata.corporate_location.user.provider", + "metadata.corporate_location.user.username", + "metadata.image_url", + "metadata.more_info", + "metadata.open_corporates_url", + "metadata.physical_location", + "metadata.physical_location.date", + "metadata.physical_location.latitude", + "metadata.physical_location.longitude", + "metadata.physical_location.user", + "metadata.physical_location.user.id", + "metadata.physical_location.user.provider", + "metadata.physical_location.user.username", + "metadata.private_alias", + "metadata.public_alias", + "metadata.url", + "name", + "other_account_routing_address", + "other_account_routing_scheme", + "other_account_secondary_routing_address", + "other_account_secondary_routing_scheme", + "other_bank_routing_address", + "other_bank_routing_scheme", + "other_branch_routing_address", + "other_branch_routing_scheme", + "this_account_id", + "this_bank_id", + "this_view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getTransactionsForBankAccount", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions", + "fields": [ + "transactions", + "transactions[]", + "transactions[].details", + "transactions[].details.completed", + "transactions[].details.description", + "transactions[].details.new_balance", + "transactions[].details.new_balance.amount", + "transactions[].details.new_balance.currency", + "transactions[].details.posted", + "transactions[].details.type", + "transactions[].details.value", + "transactions[].details.value.amount", + "transactions[].details.value.currency", + "transactions[].metadata", + "transactions[].metadata.comments", + "transactions[].metadata.comments[]", + "transactions[].metadata.comments[].date", + "transactions[].metadata.comments[].id", + "transactions[].metadata.comments[].user", + "transactions[].metadata.comments[].user.display_name", + "transactions[].metadata.comments[].user.id", + "transactions[].metadata.comments[].user.provider", + "transactions[].metadata.comments[].value", + "transactions[].metadata.images", + "transactions[].metadata.images[]", + "transactions[].metadata.images[].URL", + "transactions[].metadata.images[].date", + "transactions[].metadata.images[].id", + "transactions[].metadata.images[].label", + "transactions[].metadata.images[].user", + "transactions[].metadata.images[].user.display_name", + "transactions[].metadata.images[].user.id", + "transactions[].metadata.images[].user.provider", + "transactions[].metadata.narrative", + "transactions[].metadata.tags", + "transactions[].metadata.tags[]", + "transactions[].metadata.tags[].date", + "transactions[].metadata.tags[].id", + "transactions[].metadata.tags[].user", + "transactions[].metadata.tags[].user.display_name", + "transactions[].metadata.tags[].user.id", + "transactions[].metadata.tags[].user.provider", + "transactions[].metadata.tags[].value", + "transactions[].metadata.where", + "transactions[].metadata.where.date", + "transactions[].metadata.where.latitude", + "transactions[].metadata.where.longitude", + "transactions[].metadata.where.user", + "transactions[].metadata.where.user.display_name", + "transactions[].metadata.where.user.id", + "transactions[].metadata.where.user.provider", + "transactions[].other_account", + "transactions[].other_account.account_id", + "transactions[].other_account.account_routings", + "transactions[].other_account.account_routings[]", + "transactions[].other_account.account_routings[].address", + "transactions[].other_account.account_routings[].scheme", + "transactions[].other_account.bank_id", + "transactions[].other_account.bank_routing", + "transactions[].other_account.bank_routing.address", + "transactions[].other_account.bank_routing.scheme", + "transactions[].other_account.holder", + "transactions[].other_account.holder.is_alias", + "transactions[].other_account.holder.name", + "transactions[].other_account.metadata", + "transactions[].other_account.metadata.URL", + "transactions[].other_account.metadata.corporate_location", + "transactions[].other_account.metadata.corporate_location.date", + "transactions[].other_account.metadata.corporate_location.latitude", + "transactions[].other_account.metadata.corporate_location.longitude", + "transactions[].other_account.metadata.corporate_location.user", + "transactions[].other_account.metadata.corporate_location.user.display_name", + "transactions[].other_account.metadata.corporate_location.user.id", + "transactions[].other_account.metadata.corporate_location.user.provider", + "transactions[].other_account.metadata.image_URL", + "transactions[].other_account.metadata.more_info", + "transactions[].other_account.metadata.open_corporates_URL", + "transactions[].other_account.metadata.physical_location", + "transactions[].other_account.metadata.physical_location.date", + "transactions[].other_account.metadata.physical_location.latitude", + "transactions[].other_account.metadata.physical_location.longitude", + "transactions[].other_account.metadata.physical_location.user", + "transactions[].other_account.metadata.physical_location.user.display_name", + "transactions[].other_account.metadata.physical_location.user.id", + "transactions[].other_account.metadata.physical_location.user.provider", + "transactions[].other_account.metadata.private_alias", + "transactions[].other_account.metadata.public_alias", + "transactions[].this_account", + "transactions[].this_account.account_id", + "transactions[].this_account.account_routings", + "transactions[].this_account.account_routings[]", + "transactions[].this_account.account_routings[].address", + "transactions[].this_account.account_routings[].scheme", + "transactions[].this_account.bank_id", + "transactions[].this_account.bank_routing", + "transactions[].this_account.bank_routing.address", + "transactions[].this_account.bank_routing.scheme", + "transactions[].this_account.holders", + "transactions[].this_account.holders[]", + "transactions[].this_account.holders[].is_alias", + "transactions[].this_account.holders[].name", + "transactions[].transaction_attributes", + "transactions[].transaction_attributes[]", + "transactions[].transaction_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/custom-views", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCustomViews", + "documented_path": "/obp/v6.0.0/management/custom-views", + "fields": [ + "views", + "views[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCustomViewById", + "documented_path": "/obp/v6.0.0/management/banks/BANK_ID/accounts/ACCOUNT_ID/views/VIEW_ID", + "fields": [ + "account_id", + "alias", + "allowed_actions", + "allowed_actions[]", + "bank_id", + "can_grant_access_to_views", + "can_grant_access_to_views[]", + "can_revoke_access_to_views", + "can_revoke_access_to_views[]", + "description", + "hide_metadata_if_alias_used", + "is_firehose", + "is_public", + "is_system", + "metadata_view", + "view_id", + "view_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/view-permissions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getViewPermissions", + "documented_path": "/obp/v6.0.0/management/view-permissions", + "fields": [ + "permissions", + "permissions[]", + "permissions[].category", + "permissions[].permission" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/account-directory", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAccountDirectory", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/account-directory", + "fields": [ + "accounts", + "accounts[]", + "accounts[].account_attributes", + "accounts[].account_attributes[]", + "accounts[].account_attributes[].code", + "accounts[].account_attributes[].type", + "accounts[].account_attributes[].value", + "accounts[].account_id", + "accounts[].account_number", + "accounts[].account_routings", + "accounts[].account_routings[]", + "accounts[].account_routings[].address", + "accounts[].account_routings[].scheme", + "accounts[].account_type", + "accounts[].bank_id", + "accounts[].branch_id", + "accounts[].label", + "accounts[].view_ids", + "accounts[].view_ids[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/system-views", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemViews", + "documented_path": "/obp/v6.0.0/management/system-views", + "fields": [ + "views", + "views[]", + "views[].account_id", + "views[].alias", + "views[].allowed_actions", + "views[].allowed_actions[]", + "views[].bank_id", + "views[].can_grant_access_to_views", + "views[].can_grant_access_to_views[]", + "views[].can_revoke_access_to_views", + "views[].can_revoke_access_to_views[]", + "views[].description", + "views[].hide_metadata_if_alias_used", + "views[].is_firehose", + "views[].is_public", + "views[].is_system", + "views[].metadata_view", + "views[].view_id", + "views[].view_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/system-views/SYS_VIEW_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemViewById", + "documented_path": "/obp/v6.0.0/management/system-views/SYS_VIEW_ID", + "fields": [ + "account_id", + "alias", + "allowed_actions", + "allowed_actions[]", + "bank_id", + "can_grant_access_to_views", + "can_grant_access_to_views[]", + "can_revoke_access_to_views", + "can_revoke_access_to_views[]", + "description", + "hide_metadata_if_alias_used", + "is_firehose", + "is_public", + "is_system", + "metadata_view", + "view_id", + "view_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/system-views/SYS_VIEW_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemViewById", + "documented_path": "/obp/v6.0.0/management/system-views/SYS_VIEW_ID", + "fields": [ + "account_id", + "alias", + "allowed_actions", + "allowed_actions[]", + "bank_id", + "can_grant_access_to_views", + "can_grant_access_to_views[]", + "can_revoke_access_to_views", + "can_revoke_access_to_views[]", + "description", + "hide_metadata_if_alias_used", + "is_firehose", + "is_public", + "is_system", + "metadata_view", + "view_id", + "view_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/view-permissions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getViewPermissions", + "documented_path": "/obp/v6.0.0/management/view-permissions", + "fields": [ + "permissions", + "permissions[]", + "permissions[].category", + "permissions[].permission" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/view-permissions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getViewPermissions", + "documented_path": "/obp/v6.0.0/management/view-permissions", + "fields": [ + "permissions", + "permissions[]", + "permissions[].category", + "permissions[].permission" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/view-permissions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getViewPermissions", + "documented_path": "/obp/v6.0.0/management/view-permissions", + "fields": [ + "permissions", + "permissions[]", + "permissions[].category", + "permissions[].permission" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/metrics", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getMetrics", + "documented_path": "/obp/v6.0.0/management/metrics", + "fields": [ + "metrics", + "metrics[]", + "metrics[].api_instance_id", + "metrics[].app_name", + "metrics[].auth_type", + "metrics[].certificate_trust", + "metrics[].certificate_trust_detail", + "metrics[].consent_reference_id", + "metrics[].consumer_id", + "metrics[].correlation_id", + "metrics[].date", + "metrics[].developer_email", + "metrics[].duration", + "metrics[].forwarded_for", + "metrics[].implemented_by_partial_function", + "metrics[].implemented_in_version", + "metrics[].operation_id", + "metrics[].response_body", + "metrics[].response_body.code", + "metrics[].response_body.message", + "metrics[].source_ip", + "metrics[].status_code", + "metrics[].target_ip", + "metrics[].url", + "metrics[].user_id", + "metrics[].username", + "metrics[].verb" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getMyApiCollections", + "documented_path": "/obp/v6.0.0/my/api-collections", + "fields": [ + "api_collections", + "api_collections[]", + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description", + "api_collections[].is_sharable", + "api_collections[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getMyApiCollectionEndpointsById", + "documented_path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints", + "fields": [ + "api_collection_endpoints", + "api_collection_endpoints[]", + "api_collection_endpoints[].api_collection_endpoint_id", + "api_collection_endpoints[].api_collection_id", + "api_collection_endpoints[].operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getMyApiCollectionById", + "documented_path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "fields": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable", + "user_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoint-ids/API_COLLECTION_ENDPOINT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteMyApiCollectionEndpointById", + "documented_path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoint-ids/API_COLLECTION_ENDPOINT_ID", + "fields": [ + "value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getMyApiCollectionById", + "documented_path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "fields": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getMyApiCollectionById", + "documented_path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "fields": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityDefinitions", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[].auth_mode", + "dynamic_entities[].bank_id", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.description", + "dynamic_entities[].schema.properties.language.example", + "dynamic_entities[].schema.properties.language.maxLength", + "dynamic_entities[].schema.properties.language.minLength", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.description", + "dynamic_entities[].schema.properties.theme.example", + "dynamic_entities[].schema.properties.theme.indexed", + "dynamic_entities[].schema.properties.theme.maxLength", + "dynamic_entities[].schema.properties.theme.minLength", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/consumers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getConsumers", + "documented_path": "/obp/v7.0.0/management/consumers", + "fields": [ + "consumers", + "consumers[]", + "consumers[].app_name", + "consumers[].app_type", + "consumers[].certificate_pem", + "consumers[].company", + "consumers[].consumer_id", + "consumers[].created", + "consumers[].created_by_user", + "consumers[].created_by_user.email", + "consumers[].created_by_user.provider", + "consumers[].created_by_user.provider_id", + "consumers[].created_by_user.user_id", + "consumers[].created_by_user.username", + "consumers[].description", + "consumers[].developer_email", + "consumers[].enabled", + "consumers[].logo_url", + "consumers[].redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/platform-apps", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getPlatformApps", + "documented_path": "/obp/v7.0.0/management/platform-apps", + "fields": [ + "platform_apps", + "platform_apps[]", + "platform_apps[].consumer_id", + "platform_apps[].consumer_name", + "platform_apps[].declared_at", + "platform_apps[].label", + "platform_apps[].marked_at", + "platform_apps[].marked_by_user_id", + "platform_apps[].required_scopes", + "platform_apps[].required_scopes[]", + "platform_apps[].required_scopes[].bank_id", + "platform_apps[].required_scopes[].held", + "platform_apps[].required_scopes[].needed_for", + "platform_apps[].required_scopes[].optional", + "platform_apps[].required_scopes[].role_name", + "platform_apps[].state", + "platform_apps[].version" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/consumers/CONSUMER_ID/scopes", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getScopes", + "documented_path": "/obp/v6.0.0/consumers/CONSUMER_ID/scopes", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].role_name", + "list[].scope_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBank", + "documented_path": "/obp/v6.0.0/banks/BANK_ID", + "fields": [ + "attributes", + "attributes[]", + "attributes[].name", + "attributes[].value", + "bank_code", + "bank_id", + "bank_routings", + "bank_routings[]", + "bank_routings[].address", + "bank_routings[].scheme", + "full_name", + "logo", + "website" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/attribute", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createBankAttribute", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/attribute", + "fields": [ + "bank_attribute_id", + "bank_id", + "is_active", + "name", + "type", + "value" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createBank", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "attributes", + "attributes[]", + "attributes[].name", + "attributes[].value", + "bank_code", + "bank_id", + "bank_routings", + "bank_routings[]", + "bank_routings[].address", + "bank_routings[].scheme", + "full_name", + "logo", + "website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/currencies", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getCurrenciesAtBank", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/currencies", + "fields": [ + "currencies", + "currencies[]", + "currencies[].alphanumeric_code" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/fx/FROM_CURRENCY_CODE/TO_CURRENCY_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.2.0-getCurrentFxRate", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/fx/FROM_CURRENCY_CODE/TO_CURRENCY_CODE", + "fields": [ + "bank_id", + "conversion_value", + "effective_date", + "from_currency_code", + "inverse_conversion_value", + "to_currency_code" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemChatRoom", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "docs_from": "https://k8s.openbankproject.com", + "missing": true + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemChatRoomParticipants", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "fields": [ + "participants", + "participants[]", + "participants[].chat_room_id", + "participants[].consumer_id", + "participants[].consumer_name", + "participants[].is_muted", + "participants[].joined_at", + "participants[].last_read_at", + "participants[].participant_id", + "participants[].permissions", + "participants[].permissions[]", + "participants[].provider", + "participants[].user_id", + "participants[].username", + "participants[].webhook_url" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/joining-key", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-refreshBankJoiningKey", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/joining-key", + "fields": [ + "joining_key" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemChatRoom", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/joining-key", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-refreshSystemJoiningKey", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/joining-key", + "fields": [ + "joining_key" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-addSystemChatRoomParticipant", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "fields": [ + "chat_room_id", + "consumer_id", + "consumer_name", + "is_muted", + "joined_at", + "last_read_at", + "participant_id", + "permissions", + "permissions[]", + "provider", + "user_id", + "username", + "webhook_url" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/open-room", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-setBankChatRoomOpenRoom", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/open-room", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemChatRoom", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/open-room", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-setSystemChatRoomOpenRoom", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/open-room", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBankChatRooms", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms", + "fields": [ + "chat_rooms", + "chat_rooms[]", + "chat_rooms[].bank_id", + "chat_rooms[].chat_room_id", + "chat_rooms[].created_at", + "chat_rooms[].created_by_provider", + "chat_rooms[].created_by_user_id", + "chat_rooms[].created_by_username", + "chat_rooms[].description", + "chat_rooms[].is_archived", + "chat_rooms[].is_open_room", + "chat_rooms[].joining_key", + "chat_rooms[].last_message_at", + "chat_rooms[].last_message_preview", + "chat_rooms[].last_message_sender_username", + "chat_rooms[].name", + "chat_rooms[].participant_count", + "chat_rooms[].unread_count", + "chat_rooms[].updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createBankChatRoom", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-deleteBankChatRoom", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemChatRooms", + "documented_path": "/obp/v6.0.0/chat-rooms", + "fields": [ + "chat_rooms", + "chat_rooms[]", + "chat_rooms[].bank_id", + "chat_rooms[].chat_room_id", + "chat_rooms[].created_at", + "chat_rooms[].created_by_provider", + "chat_rooms[].created_by_user_id", + "chat_rooms[].created_by_username", + "chat_rooms[].description", + "chat_rooms[].is_archived", + "chat_rooms[].is_open_room", + "chat_rooms[].joining_key", + "chat_rooms[].last_message_at", + "chat_rooms[].last_message_preview", + "chat_rooms[].last_message_sender_username", + "chat_rooms[].name", + "chat_rooms[].participant_count", + "chat_rooms[].unread_count", + "chat_rooms[].updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createSystemChatRoom", + "documented_path": "/obp/v6.0.0/chat-rooms", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-deleteSystemChatRoom", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/connector/metrics/counts", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getConnectorCallCounts", + "documented_path": "/obp/v6.0.0/management/connector/metrics/counts", + "fields": [ + "connector_counts", + "connector_counts[]", + "connector_counts[].connector_name", + "connector_counts[].method_name", + "connector_counts[].per_hour_inbound_failure_count", + "connector_counts[].per_hour_inbound_success_count", + "connector_counts[].per_hour_outbound_count", + "connector_counts[].ttl_seconds", + "enabled" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/connector/traces", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getConnectorTraces", + "documented_path": "/obp/v6.0.0/management/connector/traces", + "fields": [ + "connector_traces", + "connector_traces[]", + "connector_traces[].bank_id", + "connector_traces[].connector_name", + "connector_traces[].connector_trace_id", + "connector_traces[].correlation_id", + "connector_traces[].date", + "connector_traces[].duration", + "connector_traces[].function_name", + "connector_traces[].http_verb", + "connector_traces[].inbound_message", + "connector_traces[].is_successful", + "connector_traces[].outbound_message", + "connector_traces[].url", + "connector_traces[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/consumers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getConsumers", + "documented_path": "/obp/v7.0.0/management/consumers", + "fields": [ + "consumers", + "consumers[]", + "consumers[].app_name", + "consumers[].app_type", + "consumers[].certificate_pem", + "consumers[].company", + "consumers[].consumer_id", + "consumers[].created", + "consumers[].created_by_user", + "consumers[].created_by_user.email", + "consumers[].created_by_user.provider", + "consumers[].created_by_user.provider_id", + "consumers[].created_by_user.user_id", + "consumers[].created_by_user.username", + "consumers[].description", + "consumers[].developer_email", + "consumers[].enabled", + "consumers[].logo_url", + "consumers[].redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/metrics/consumer-last-calls", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getConsumerLastCalls", + "documented_path": "/obp/v7.0.0/management/metrics/consumer-last-calls", + "fields": [ + "consumer_last_calls", + "consumer_last_calls[]", + "consumer_last_calls[].consumer_id", + "consumer_last_calls[].last_call_at", + "tracked_since" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/consumers/CONSUMER_ID/scope/SCOPE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-deleteScope", + "documented_path": "/obp/v6.0.0/consumers/CONSUMER_ID/scope/SCOPE_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/consumers/CONSUMER_ID/scopes", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getScopes", + "documented_path": "/obp/v6.0.0/consumers/CONSUMER_ID/scopes", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].role_name", + "list[].scope_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/consumers/CONSUMER_ID/scopes", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-addScope", + "documented_path": "/obp/v6.0.0/consumers/CONSUMER_ID/scopes", + "fields": [ + "bank_id", + "role_name", + "scope_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/consumers/current", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCurrentConsumer", + "documented_path": "/obp/v6.0.0/consumers/current", + "fields": [ + "active_rate_limits", + "active_rate_limits.active_at_date", + "active_rate_limits.active_per_day_rate_limit", + "active_rate_limits.active_per_hour_rate_limit", + "active_rate_limits.active_per_minute_rate_limit", + "active_rate_limits.active_per_month_rate_limit", + "active_rate_limits.active_per_second_rate_limit", + "active_rate_limits.active_per_week_rate_limit", + "active_rate_limits.considered_rate_limit_ids", + "active_rate_limits.considered_rate_limit_ids[]", + "app_name", + "app_type", + "call_counters", + "call_counters.per_day", + "call_counters.per_day.calls_made", + "call_counters.per_day.reset_in_seconds", + "call_counters.per_day.status", + "call_counters.per_hour", + "call_counters.per_hour.calls_made", + "call_counters.per_hour.reset_in_seconds", + "call_counters.per_hour.status", + "call_counters.per_minute", + "call_counters.per_minute.calls_made", + "call_counters.per_minute.reset_in_seconds", + "call_counters.per_minute.status", + "call_counters.per_month", + "call_counters.per_month.calls_made", + "call_counters.per_month.reset_in_seconds", + "call_counters.per_month.status", + "call_counters.per_second", + "call_counters.per_second.calls_made", + "call_counters.per_second.reset_in_seconds", + "call_counters.per_second.status", + "call_counters.per_week", + "call_counters.per_week.calls_made", + "call_counters.per_week.reset_in_seconds", + "call_counters.per_week.status", + "consumer_id", + "description" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-enableDisableConsumers", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "fields": [ + "enabled" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/active-rate-limits", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getActiveRateLimitsNow", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/active-rate-limits", + "fields": [ + "active_at_date", + "active_per_day_rate_limit", + "active_per_hour_rate_limit", + "active_per_minute_rate_limit", + "active_per_month_rate_limit", + "active_per_second_rate_limit", + "active_per_week_rate_limit", + "considered_rate_limit_ids", + "considered_rate_limit_ids[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/rate-limiting", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-getRateLimitingInfo", + "documented_path": "/obp/v6.0.0/rate-limiting", + "fields": [ + "enabled", + "is_active", + "service_available", + "technology" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.1.0-getRoles", + "documented_path": "/obp/v6.0.0/roles", + "fields": [ + "roles", + "roles[]", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/consumers/CONSUMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getConsumer", + "documented_path": "/obp/v7.0.0/management/consumers/CONSUMER_ID", + "fields": [ + "active_rate_limits", + "active_rate_limits.active_at_date", + "active_rate_limits.active_per_day_rate_limit", + "active_rate_limits.active_per_hour_rate_limit", + "active_rate_limits.active_per_minute_rate_limit", + "active_rate_limits.active_per_month_rate_limit", + "active_rate_limits.active_per_second_rate_limit", + "active_rate_limits.active_per_week_rate_limit", + "active_rate_limits.considered_rate_limit_ids", + "active_rate_limits.considered_rate_limit_ids[]", + "app_name", + "app_type", + "call_counters", + "call_counters.per_day", + "call_counters.per_day.calls_made", + "call_counters.per_day.reset_in_seconds", + "call_counters.per_day.status", + "call_counters.per_hour", + "call_counters.per_hour.calls_made", + "call_counters.per_hour.reset_in_seconds", + "call_counters.per_hour.status", + "call_counters.per_minute", + "call_counters.per_minute.calls_made", + "call_counters.per_minute.reset_in_seconds", + "call_counters.per_minute.status", + "call_counters.per_month", + "call_counters.per_month.calls_made", + "call_counters.per_month.reset_in_seconds", + "call_counters.per_month.status", + "call_counters.per_second", + "call_counters.per_second.calls_made", + "call_counters.per_second.reset_in_seconds", + "call_counters.per_second.status", + "call_counters.per_week", + "call_counters.per_week.calls_made", + "call_counters.per_week.reset_in_seconds", + "call_counters.per_week.status", + "certificate_info", + "certificate_info.issuer_domain_name", + "certificate_info.not_after", + "certificate_info.not_before", + "certificate_info.roles_info", + "certificate_info.subject_domain_name", + "certificate_pem", + "company", + "consumer_id", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "description", + "developer_email", + "enabled", + "logo_url", + "redirect_url" + ] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/certificate", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateConsumerCertificate", + "documented_path": "/obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/certificate", + "fields": [ + "app_name", + "app_type", + "certificate_pem", + "company", + "consumer_id", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "description", + "developer_email", + "enabled", + "logo_url", + "redirect_url" + ] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/logo_url", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateConsumerLogoURL", + "documented_path": "/obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/logo_url", + "fields": [ + "app_name", + "app_type", + "certificate_pem", + "company", + "consumer_id", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "description", + "developer_email", + "enabled", + "logo_url", + "redirect_url" + ] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/name", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateConsumerName", + "documented_path": "/obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/name", + "fields": [ + "app_name", + "app_type", + "certificate_pem", + "company", + "consumer_id", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "description", + "developer_email", + "enabled", + "logo_url", + "redirect_url" + ] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/redirect_url", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateConsumerRedirectURL", + "documented_path": "/obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/redirect_url", + "fields": [ + "app_name", + "app_type", + "certificate_pem", + "company", + "consumer_id", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "description", + "developer_email", + "enabled", + "logo_url", + "redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getConsumer", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "fields": [ + "active_rate_limits", + "active_rate_limits.active_at_date", + "active_rate_limits.active_per_day_rate_limit", + "active_rate_limits.active_per_hour_rate_limit", + "active_rate_limits.active_per_minute_rate_limit", + "active_rate_limits.active_per_month_rate_limit", + "active_rate_limits.active_per_second_rate_limit", + "active_rate_limits.active_per_week_rate_limit", + "active_rate_limits.considered_rate_limit_ids", + "active_rate_limits.considered_rate_limit_ids[]", + "app_name", + "app_type", + "call_counters", + "call_counters.per_day", + "call_counters.per_day.calls_made", + "call_counters.per_day.reset_in_seconds", + "call_counters.per_day.status", + "call_counters.per_hour", + "call_counters.per_hour.calls_made", + "call_counters.per_hour.reset_in_seconds", + "call_counters.per_hour.status", + "call_counters.per_minute", + "call_counters.per_minute.calls_made", + "call_counters.per_minute.reset_in_seconds", + "call_counters.per_minute.status", + "call_counters.per_month", + "call_counters.per_month.calls_made", + "call_counters.per_month.reset_in_seconds", + "call_counters.per_month.status", + "call_counters.per_second", + "call_counters.per_second.calls_made", + "call_counters.per_second.reset_in_seconds", + "call_counters.per_second.status", + "call_counters.per_week", + "call_counters.per_week.calls_made", + "call_counters.per_week.reset_in_seconds", + "call_counters.per_week.status", + "certificate_info", + "certificate_info.issuer_domain_name", + "certificate_info.not_after", + "certificate_info.not_before", + "certificate_info.roles_info", + "certificate_info.subject_domain_name", + "certificate_pem", + "company", + "consumer_id", + "consumer_key", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "description", + "developer_email", + "enabled", + "logo_url", + "redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/active-rate-limits", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getActiveRateLimitsNow", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/active-rate-limits", + "fields": [ + "active_at_date", + "active_per_day_rate_limit", + "active_per_hour_rate_limit", + "active_per_minute_rate_limit", + "active_per_month_rate_limit", + "active_per_second_rate_limit", + "active_per_week_rate_limit", + "considered_rate_limit_ids", + "considered_rate_limit_ids[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/call-counters", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getConsumerCallCounters", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/call-counters", + "fields": [ + "per_day", + "per_day.calls_made", + "per_day.reset_in_seconds", + "per_day.status", + "per_hour", + "per_hour.calls_made", + "per_hour.reset_in_seconds", + "per_hour.status", + "per_minute", + "per_minute.calls_made", + "per_minute.reset_in_seconds", + "per_minute.status", + "per_month", + "per_month.calls_made", + "per_month.reset_in_seconds", + "per_month.status", + "per_second", + "per_second.calls_made", + "per_second.reset_in_seconds", + "per_second.status", + "per_week", + "per_week.calls_made", + "per_week.reset_in_seconds", + "per_week.status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getCallsLimit", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits", + "fields": [ + "limits", + "limits[]", + "limits[].created_at", + "limits[].from_date", + "limits[].per_day_call_limit", + "limits[].per_hour_call_limit", + "limits[].per_minute_call_limit", + "limits[].per_month_call_limit", + "limits[].per_second_call_limit", + "limits[].per_week_call_limit", + "limits[].rate_limiting_id", + "limits[].to_date", + "limits[].updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/rate-limiting", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-getRateLimitingInfo", + "documented_path": "/obp/v6.0.0/rate-limiting", + "fields": [ + "enabled", + "is_active", + "service_available", + "technology" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getConsumer", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "fields": [ + "active_rate_limits", + "active_rate_limits.active_at_date", + "active_rate_limits.active_per_day_rate_limit", + "active_rate_limits.active_per_hour_rate_limit", + "active_rate_limits.active_per_minute_rate_limit", + "active_rate_limits.active_per_month_rate_limit", + "active_rate_limits.active_per_second_rate_limit", + "active_rate_limits.active_per_week_rate_limit", + "active_rate_limits.considered_rate_limit_ids", + "active_rate_limits.considered_rate_limit_ids[]", + "app_name", + "app_type", + "call_counters", + "call_counters.per_day", + "call_counters.per_day.calls_made", + "call_counters.per_day.reset_in_seconds", + "call_counters.per_day.status", + "call_counters.per_hour", + "call_counters.per_hour.calls_made", + "call_counters.per_hour.reset_in_seconds", + "call_counters.per_hour.status", + "call_counters.per_minute", + "call_counters.per_minute.calls_made", + "call_counters.per_minute.reset_in_seconds", + "call_counters.per_minute.status", + "call_counters.per_month", + "call_counters.per_month.calls_made", + "call_counters.per_month.reset_in_seconds", + "call_counters.per_month.status", + "call_counters.per_second", + "call_counters.per_second.calls_made", + "call_counters.per_second.reset_in_seconds", + "call_counters.per_second.status", + "call_counters.per_week", + "call_counters.per_week.calls_made", + "call_counters.per_week.reset_in_seconds", + "call_counters.per_week.status", + "certificate_info", + "certificate_info.issuer_domain_name", + "certificate_info.not_after", + "certificate_info.not_before", + "certificate_info.roles_info", + "certificate_info.subject_domain_name", + "certificate_pem", + "company", + "consumer_id", + "consumer_key", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "description", + "developer_email", + "enabled", + "logo_url", + "redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getCallsLimit", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits", + "fields": [ + "limits", + "limits[]", + "limits[].created_at", + "limits[].from_date", + "limits[].per_day_call_limit", + "limits[].per_hour_call_limit", + "limits[].per_minute_call_limit", + "limits[].per_month_call_limit", + "limits[].per_second_call_limit", + "limits[].per_week_call_limit", + "limits[].rate_limiting_id", + "limits[].to_date", + "limits[].updated_at" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits/RATE_LIMITING_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-deleteCallLimits", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits/RATE_LIMITING_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getConsumer", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "fields": [ + "active_rate_limits", + "active_rate_limits.active_at_date", + "active_rate_limits.active_per_day_rate_limit", + "active_rate_limits.active_per_hour_rate_limit", + "active_rate_limits.active_per_minute_rate_limit", + "active_rate_limits.active_per_month_rate_limit", + "active_rate_limits.active_per_second_rate_limit", + "active_rate_limits.active_per_week_rate_limit", + "active_rate_limits.considered_rate_limit_ids", + "active_rate_limits.considered_rate_limit_ids[]", + "app_name", + "app_type", + "call_counters", + "call_counters.per_day", + "call_counters.per_day.calls_made", + "call_counters.per_day.reset_in_seconds", + "call_counters.per_day.status", + "call_counters.per_hour", + "call_counters.per_hour.calls_made", + "call_counters.per_hour.reset_in_seconds", + "call_counters.per_hour.status", + "call_counters.per_minute", + "call_counters.per_minute.calls_made", + "call_counters.per_minute.reset_in_seconds", + "call_counters.per_minute.status", + "call_counters.per_month", + "call_counters.per_month.calls_made", + "call_counters.per_month.reset_in_seconds", + "call_counters.per_month.status", + "call_counters.per_second", + "call_counters.per_second.calls_made", + "call_counters.per_second.reset_in_seconds", + "call_counters.per_second.status", + "call_counters.per_week", + "call_counters.per_week.calls_made", + "call_counters.per_week.reset_in_seconds", + "call_counters.per_week.status", + "certificate_info", + "certificate_info.issuer_domain_name", + "certificate_info.not_after", + "certificate_info.not_before", + "certificate_info.roles_info", + "certificate_info.subject_domain_name", + "certificate_pem", + "company", + "consumer_id", + "consumer_key", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "description", + "developer_email", + "enabled", + "logo_url", + "redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getCallsLimit", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits", + "fields": [ + "limits", + "limits[]", + "limits[].created_at", + "limits[].from_date", + "limits[].per_day_call_limit", + "limits[].per_hour_call_limit", + "limits[].per_minute_call_limit", + "limits[].per_month_call_limit", + "limits[].per_second_call_limit", + "limits[].per_week_call_limit", + "limits[].rate_limiting_id", + "limits[].to_date", + "limits[].updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits/RATE_LIMITING_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-updateRateLimits", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits/RATE_LIMITING_ID", + "fields": [ + "from_date", + "per_day_call_limit", + "per_hour_call_limit", + "per_minute_call_limit", + "per_month_call_limit", + "per_second_call_limit", + "per_week_call_limit", + "to_date" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getConsumer", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID", + "fields": [ + "active_rate_limits", + "active_rate_limits.active_at_date", + "active_rate_limits.active_per_day_rate_limit", + "active_rate_limits.active_per_hour_rate_limit", + "active_rate_limits.active_per_minute_rate_limit", + "active_rate_limits.active_per_month_rate_limit", + "active_rate_limits.active_per_second_rate_limit", + "active_rate_limits.active_per_week_rate_limit", + "active_rate_limits.considered_rate_limit_ids", + "active_rate_limits.considered_rate_limit_ids[]", + "app_name", + "app_type", + "call_counters", + "call_counters.per_day", + "call_counters.per_day.calls_made", + "call_counters.per_day.reset_in_seconds", + "call_counters.per_day.status", + "call_counters.per_hour", + "call_counters.per_hour.calls_made", + "call_counters.per_hour.reset_in_seconds", + "call_counters.per_hour.status", + "call_counters.per_minute", + "call_counters.per_minute.calls_made", + "call_counters.per_minute.reset_in_seconds", + "call_counters.per_minute.status", + "call_counters.per_month", + "call_counters.per_month.calls_made", + "call_counters.per_month.reset_in_seconds", + "call_counters.per_month.status", + "call_counters.per_second", + "call_counters.per_second.calls_made", + "call_counters.per_second.reset_in_seconds", + "call_counters.per_second.status", + "call_counters.per_week", + "call_counters.per_week.calls_made", + "call_counters.per_week.reset_in_seconds", + "call_counters.per_week.status", + "certificate_info", + "certificate_info.issuer_domain_name", + "certificate_info.not_after", + "certificate_info.not_before", + "certificate_info.roles_info", + "certificate_info.subject_domain_name", + "certificate_pem", + "company", + "consumer_id", + "consumer_key", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "description", + "developer_email", + "enabled", + "logo_url", + "redirect_url" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createCallLimits", + "documented_path": "/obp/v6.0.0/management/consumers/CONSUMER_ID/consumer/rate-limits", + "fields": [ + "api_name", + "api_version", + "created_at", + "from_date", + "per_day_call_limit", + "per_hour_call_limit", + "per_minute_call_limit", + "per_month_call_limit", + "per_second_call_limit", + "per_week_call_limit", + "rate_limiting_id", + "to_date", + "updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/consumers/CONSUMER_ID/scopes", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-addScope", + "documented_path": "/obp/v7.0.0/consumers/CONSUMER_ID/scopes", + "fields": [ + "bank_id", + "role_name", + "scope_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/platform-apps", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createPlatformApp", + "documented_path": "/obp/v7.0.0/management/platform-apps", + "fields": [ + "consumer_id", + "consumer_name", + "declared_at", + "label", + "marked_at", + "marked_by_user_id", + "required_scopes", + "required_scopes[]", + "required_scopes[].bank_id", + "required_scopes[].held", + "required_scopes[].needed_for", + "required_scopes[].optional", + "required_scopes[].role_name", + "state", + "version" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/platform-apps/CONSUMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-deletePlatformApp", + "documented_path": "/obp/v7.0.0/management/platform-apps/CONSUMER_ID", + "fields": [] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/attribute", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createCustomerAttribute", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/attribute", + "fields": [ + "customer_attribute_id", + "name", + "type", + "value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCustomerByCustomerId", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID", + "fields": [ + "bank_id", + "branch_id", + "credit_limit", + "credit_limit.amount", + "credit_limit.currency", + "credit_rating", + "credit_rating.rating", + "credit_rating.source", + "customer_attributes", + "customer_attributes[]", + "customer_attributes[].customer_attribute_id", + "customer_attributes[].name", + "customer_attributes[].type", + "customer_attributes[].value", + "customer_id", + "customer_number", + "customer_type", + "date_of_birth", + "dependants", + "dob_of_dependants", + "dob_of_dependants[]", + "email", + "employment_status", + "face_image", + "face_image.date", + "face_image.url", + "highest_education_attained", + "kyc_status", + "last_ok_date", + "legal_name", + "mobile_phone_number", + "name_suffix", + "parent_customer_id", + "relationship_status", + "title" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/retail-customers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getRetailCustomersAtOneBank", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/retail-customers", + "fields": [ + "customers", + "customers[]", + "customers[].bank_id", + "customers[].branch_id", + "customers[].credit_limit", + "customers[].credit_limit.amount", + "customers[].credit_limit.currency", + "customers[].credit_rating", + "customers[].credit_rating.rating", + "customers[].credit_rating.source", + "customers[].customer_id", + "customers[].customer_number", + "customers[].customer_type", + "customers[].date_of_birth", + "customers[].dependants", + "customers[].dob_of_dependants", + "customers[].dob_of_dependants[]", + "customers[].email", + "customers[].employment_status", + "customers[].face_image", + "customers[].face_image.date", + "customers[].face_image.url", + "customers[].highest_education_attained", + "customers[].kyc_status", + "customers[].last_ok_date", + "customers[].legal_name", + "customers[].mobile_phone_number", + "customers[].name_suffix", + "customers[].parent_customer_id", + "customers[].relationship_status", + "customers[].title" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/corporate-customers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCorporateCustomersAtOneBank", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/corporate-customers", + "fields": [ + "customers", + "customers[]", + "customers[].bank_id", + "customers[].branch_id", + "customers[].credit_limit", + "customers[].credit_limit.amount", + "customers[].credit_limit.currency", + "customers[].credit_rating", + "customers[].credit_rating.rating", + "customers[].credit_rating.source", + "customers[].customer_id", + "customers[].customer_number", + "customers[].customer_type", + "customers[].date_of_birth", + "customers[].dependants", + "customers[].dob_of_dependants", + "customers[].dob_of_dependants[]", + "customers[].email", + "customers[].employment_status", + "customers[].face_image", + "customers[].face_image.date", + "customers[].face_image.url", + "customers[].highest_education_attained", + "customers[].kyc_status", + "customers[].last_ok_date", + "customers[].legal_name", + "customers[].mobile_phone_number", + "customers[].name_suffix", + "customers[].parent_customer_id", + "customers[].relationship_status", + "customers[].title" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links/customers/CUSTOMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getUserCustomerLinksByCustomerId", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links/customers/CUSTOMER_ID", + "fields": [ + "user_customer_links", + "user_customer_links[]", + "user_customer_links[].customer_id", + "user_customer_links[].date_inserted", + "user_customer_links[].is_active", + "user_customer_links[].user_customer_link_id", + "user_customer_links[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/owner/account", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getPrivateAccountByIdFull", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account", + "fields": [ + "account_attributes", + "account_attributes[]", + "account_attributes[].account_attribute_id", + "account_attributes[].name", + "account_attributes[].product_code", + "account_attributes[].product_instance_code", + "account_attributes[].type", + "account_attributes[].value", + "account_routings", + "account_routings[]", + "account_routings[].address", + "account_routings[].scheme", + "balance", + "balance.amount", + "balance.currency", + "bank_id", + "id", + "label", + "number", + "owners", + "owners[]", + "owners[].display_name", + "owners[].id", + "owners[].provider", + "product_code", + "tags", + "tags[]", + "tags[].date", + "tags[].id", + "tags[].user", + "tags[].user.display_name", + "tags[].user.id", + "tags[].user.provider", + "tags[].value", + "views_available", + "views_available[]", + "views_available[].account_id", + "views_available[].alias", + "views_available[].allowed_actions", + "views_available[].allowed_actions[]", + "views_available[].bank_id", + "views_available[].can_grant_access_to_views", + "views_available[].can_grant_access_to_views[]", + "views_available[].can_revoke_access_to_views", + "views_available[].can_revoke_access_to_views[]", + "views_available[].description", + "views_available[].hide_metadata_if_alias_used", + "views_available[].is_firehose", + "views_available[].is_public", + "views_available[].is_system", + "views_available[].metadata_view", + "views_available[].view_id", + "views_available[].view_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/owner/transactions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getTransactionsForBankAccount", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions", + "fields": [ + "transactions", + "transactions[]", + "transactions[].details", + "transactions[].details.completed", + "transactions[].details.description", + "transactions[].details.new_balance", + "transactions[].details.new_balance.amount", + "transactions[].details.new_balance.currency", + "transactions[].details.posted", + "transactions[].details.type", + "transactions[].details.value", + "transactions[].details.value.amount", + "transactions[].details.value.currency", + "transactions[].metadata", + "transactions[].metadata.comments", + "transactions[].metadata.comments[]", + "transactions[].metadata.comments[].date", + "transactions[].metadata.comments[].id", + "transactions[].metadata.comments[].user", + "transactions[].metadata.comments[].user.display_name", + "transactions[].metadata.comments[].user.id", + "transactions[].metadata.comments[].user.provider", + "transactions[].metadata.comments[].value", + "transactions[].metadata.images", + "transactions[].metadata.images[]", + "transactions[].metadata.images[].URL", + "transactions[].metadata.images[].date", + "transactions[].metadata.images[].id", + "transactions[].metadata.images[].label", + "transactions[].metadata.images[].user", + "transactions[].metadata.images[].user.display_name", + "transactions[].metadata.images[].user.id", + "transactions[].metadata.images[].user.provider", + "transactions[].metadata.narrative", + "transactions[].metadata.tags", + "transactions[].metadata.tags[]", + "transactions[].metadata.tags[].date", + "transactions[].metadata.tags[].id", + "transactions[].metadata.tags[].user", + "transactions[].metadata.tags[].user.display_name", + "transactions[].metadata.tags[].user.id", + "transactions[].metadata.tags[].user.provider", + "transactions[].metadata.tags[].value", + "transactions[].metadata.where", + "transactions[].metadata.where.date", + "transactions[].metadata.where.latitude", + "transactions[].metadata.where.longitude", + "transactions[].metadata.where.user", + "transactions[].metadata.where.user.display_name", + "transactions[].metadata.where.user.id", + "transactions[].metadata.where.user.provider", + "transactions[].other_account", + "transactions[].other_account.account_id", + "transactions[].other_account.account_routings", + "transactions[].other_account.account_routings[]", + "transactions[].other_account.account_routings[].address", + "transactions[].other_account.account_routings[].scheme", + "transactions[].other_account.bank_id", + "transactions[].other_account.bank_routing", + "transactions[].other_account.bank_routing.address", + "transactions[].other_account.bank_routing.scheme", + "transactions[].other_account.holder", + "transactions[].other_account.holder.is_alias", + "transactions[].other_account.holder.name", + "transactions[].other_account.metadata", + "transactions[].other_account.metadata.URL", + "transactions[].other_account.metadata.corporate_location", + "transactions[].other_account.metadata.corporate_location.date", + "transactions[].other_account.metadata.corporate_location.latitude", + "transactions[].other_account.metadata.corporate_location.longitude", + "transactions[].other_account.metadata.corporate_location.user", + "transactions[].other_account.metadata.corporate_location.user.display_name", + "transactions[].other_account.metadata.corporate_location.user.id", + "transactions[].other_account.metadata.corporate_location.user.provider", + "transactions[].other_account.metadata.image_URL", + "transactions[].other_account.metadata.more_info", + "transactions[].other_account.metadata.open_corporates_URL", + "transactions[].other_account.metadata.physical_location", + "transactions[].other_account.metadata.physical_location.date", + "transactions[].other_account.metadata.physical_location.latitude", + "transactions[].other_account.metadata.physical_location.longitude", + "transactions[].other_account.metadata.physical_location.user", + "transactions[].other_account.metadata.physical_location.user.display_name", + "transactions[].other_account.metadata.physical_location.user.id", + "transactions[].other_account.metadata.physical_location.user.provider", + "transactions[].other_account.metadata.private_alias", + "transactions[].other_account.metadata.public_alias", + "transactions[].this_account", + "transactions[].this_account.account_id", + "transactions[].this_account.account_routings", + "transactions[].this_account.account_routings[]", + "transactions[].this_account.account_routings[].address", + "transactions[].this_account.account_routings[].scheme", + "transactions[].this_account.bank_id", + "transactions[].this_account.bank_routing", + "transactions[].this_account.bank_routing.address", + "transactions[].this_account.bank_routing.scheme", + "transactions[].this_account.holders", + "transactions[].this_account.holders[]", + "transactions[].this_account.holders[].is_alias", + "transactions[].this_account.holders[].name", + "transactions[].transaction_attributes", + "transactions[].transaction_attributes[]", + "transactions[].transaction_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCustomersAtOneBank", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/customers", + "fields": [ + "customers", + "customers[]", + "customers[].bank_id", + "customers[].branch_id", + "customers[].credit_limit", + "customers[].credit_limit.amount", + "customers[].credit_limit.currency", + "customers[].credit_rating", + "customers[].credit_rating.rating", + "customers[].credit_rating.source", + "customers[].customer_id", + "customers[].customer_number", + "customers[].customer_type", + "customers[].date_of_birth", + "customers[].dependants", + "customers[].dob_of_dependants", + "customers[].dob_of_dependants[]", + "customers[].email", + "customers[].employment_status", + "customers[].face_image", + "customers[].face_image.date", + "customers[].face_image.url", + "customers[].highest_education_attained", + "customers[].kyc_status", + "customers[].last_ok_date", + "customers[].legal_name", + "customers[].mobile_phone_number", + "customers[].name_suffix", + "customers[].parent_customer_id", + "customers[].relationship_status", + "customers[].title" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID/children", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCustomerChildren", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID/children", + "fields": [ + "customers", + "customers[]", + "customers[].bank_id", + "customers[].branch_id", + "customers[].credit_limit", + "customers[].credit_limit.amount", + "customers[].credit_limit.currency", + "customers[].credit_rating", + "customers[].credit_rating.rating", + "customers[].credit_rating.source", + "customers[].customer_id", + "customers[].customer_number", + "customers[].customer_type", + "customers[].date_of_birth", + "customers[].dependants", + "customers[].dob_of_dependants", + "customers[].dob_of_dependants[]", + "customers[].email", + "customers[].employment_status", + "customers[].face_image", + "customers[].face_image.date", + "customers[].face_image.url", + "customers[].highest_education_attained", + "customers[].kyc_status", + "customers[].last_ok_date", + "customers[].legal_name", + "customers[].mobile_phone_number", + "customers[].name_suffix", + "customers[].parent_customer_id", + "customers[].relationship_status", + "customers[].title" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user-id/USER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUserByUserId", + "documented_path": "/obp/v6.0.0/users/user-id/USER_ID", + "fields": [ + "agreements", + "agreements[]", + "agreements[].text", + "agreements[].type", + "created_date", + "email", + "email_validated", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "first_name", + "is_deleted", + "is_locked", + "last_activity_date", + "last_marketing_agreement_signed_date", + "last_name", + "last_used_locale", + "provider", + "provider_id", + "recent_operation_ids", + "recent_operation_ids[]", + "updated_date", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/retail-customers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getRetailCustomersAtOneBank", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/retail-customers", + "fields": [ + "customers", + "customers[]", + "customers[].bank_id", + "customers[].branch_id", + "customers[].credit_limit", + "customers[].credit_limit.amount", + "customers[].credit_limit.currency", + "customers[].credit_rating", + "customers[].credit_rating.rating", + "customers[].credit_rating.source", + "customers[].customer_id", + "customers[].customer_number", + "customers[].customer_type", + "customers[].date_of_birth", + "customers[].dependants", + "customers[].dob_of_dependants", + "customers[].dob_of_dependants[]", + "customers[].email", + "customers[].employment_status", + "customers[].face_image", + "customers[].face_image.date", + "customers[].face_image.url", + "customers[].highest_education_attained", + "customers[].kyc_status", + "customers[].last_ok_date", + "customers[].legal_name", + "customers[].mobile_phone_number", + "customers[].name_suffix", + "customers[].parent_customer_id", + "customers[].relationship_status", + "customers[].title" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/system/diagnostics/deployment", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDeploymentChecks", + "documented_path": "/obp/v7.0.0/management/system/diagnostics/deployment", + "fields": [ + "api_instance_id", + "checked_at", + "checks", + "checks[]", + "checks[].area", + "checks[].basis", + "checks[].evidence", + "checks[].evidence[]", + "checks[].evidence[].name", + "checks[].evidence[].value", + "checks[].id", + "checks[].message", + "checks[].props", + "checks[].props[]", + "checks[].status", + "checks[].title", + "errors", + "warnings", + "window_minutes" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDomainApis", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis", + "fields": [ + "domain_apis", + "domain_apis[]", + "domain_apis[].bank_id", + "domain_apis[].base_path", + "domain_apis[].created_at", + "domain_apis[].created_by_user_id", + "domain_apis[].description", + "domain_apis[].domain_api_id", + "domain_apis[].is_publicly_discoverable", + "domain_apis[].openapi_url", + "domain_apis[].title", + "domain_apis[].updated_at", + "domain_apis[].url", + "domain_apis[].version" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis/DOMAIN_API_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDomainApi", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/domain-apis/DOMAIN_API_ID", + "fields": [ + "bank_id", + "base_path", + "created_at", + "created_by_user_id", + "description", + "domain_api_id", + "is_publicly_discoverable", + "openapi_url", + "title", + "updated_at", + "url", + "version" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/resource-docs/v7.0.0/obp", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsObp", + "documented_path": "/obp/v7.0.0/resource-docs/API_VERSION/obp", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getBankLevelDynamicEndpoints", + "documented_path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints", + "fields": [ + "dynamic_endpoints", + "dynamic_endpoints[]", + "dynamic_endpoints[].dynamic_endpoint_id", + "dynamic_endpoints[].swagger_string", + "dynamic_endpoints[].swagger_string.definitions", + "dynamic_endpoints[].swagger_string.definitions.AccountName", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.balance", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.balance.example", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.balance.format", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.balance.type", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.name", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.name.example", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.name.type", + "dynamic_endpoints[].swagger_string.definitions.AccountName.type", + "dynamic_endpoints[].swagger_string.host", + "dynamic_endpoints[].swagger_string.info", + "dynamic_endpoints[].swagger_string.info.title", + "dynamic_endpoints[].swagger_string.info.version", + "dynamic_endpoints[].swagger_string.paths", + "dynamic_endpoints[].swagger_string.paths./accounts", + "dynamic_endpoints[].swagger_string.paths./accounts.post", + "dynamic_endpoints[].swagger_string.paths./accounts.post.consumes", + "dynamic_endpoints[].swagger_string.paths./accounts.post.consumes[]", + "dynamic_endpoints[].swagger_string.paths./accounts.post.consumes[].s", + "dynamic_endpoints[].swagger_string.paths./accounts.post.description", + "dynamic_endpoints[].swagger_string.paths./accounts.post.operationId", + "dynamic_endpoints[].swagger_string.paths./accounts.post.produces", + "dynamic_endpoints[].swagger_string.paths./accounts.post.produces[]", + "dynamic_endpoints[].swagger_string.paths./accounts.post.produces[].s", + "dynamic_endpoints[].swagger_string.paths./accounts.post.responses", + "dynamic_endpoints[].swagger_string.paths./accounts.post.responses.201", + "dynamic_endpoints[].swagger_string.paths./accounts.post.responses.201.description", + "dynamic_endpoints[].swagger_string.paths./accounts.post.responses.201.schema", + "dynamic_endpoints[].swagger_string.paths./accounts.post.responses.201.schema.$ref", + "dynamic_endpoints[].swagger_string.paths./accounts.post.summary", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.consumes", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.consumes[]", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.consumes[].s", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.description", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.operationId", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.produces", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.produces[]", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.produces[].s", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.responses", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.responses.200", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.responses.200.description", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.responses.200.schema", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.responses.200.schema.$ref", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.summary", + "dynamic_endpoints[].swagger_string.schemes", + "dynamic_endpoints[].swagger_string.schemes[]", + "dynamic_endpoints[].swagger_string.schemes[].s", + "dynamic_endpoints[].swagger_string.swagger", + "dynamic_endpoints[].user_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteBankLevelDynamicEndpoint", + "documented_path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getAllBankLevelEndpointMappings", + "documented_path": "/obp/v5.1.0/management/banks/BANK_ID/endpoint-mappings", + "fields": [ + "endpoint-mappings", + "endpoint-mappings[]", + "endpoint-mappings[].endpoint_mapping_id", + "endpoint-mappings[].operation_id", + "endpoint-mappings[].request_mapping", + "endpoint-mappings[].response_mapping", + "endpoint-mappings[].response_mapping.balance", + "endpoint-mappings[].response_mapping.balance.entity", + "endpoint-mappings[].response_mapping.balance.field", + "endpoint-mappings[].response_mapping.balance.query", + "endpoint-mappings[].response_mapping.name", + "endpoint-mappings[].response_mapping.name.entity", + "endpoint-mappings[].response_mapping.name.field", + "endpoint-mappings[].response_mapping.name.query" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/json-schema-validations", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getAllJsonSchemaValidations", + "documented_path": "/obp/v5.1.0/management/json-schema-validations", + "fields": [ + "json_schema_validations", + "json_schema_validations[]", + "json_schema_validations[].json_schema", + "json_schema_validations[].json_schema.$schema", + "json_schema_validations[].json_schema.additionalProperties", + "json_schema_validations[].json_schema.description", + "json_schema_validations[].json_schema.properties", + "json_schema_validations[].json_schema.properties.xxx_id", + "json_schema_validations[].json_schema.properties.xxx_id.examples", + "json_schema_validations[].json_schema.properties.xxx_id.examples[]", + "json_schema_validations[].json_schema.properties.xxx_id.maxLength", + "json_schema_validations[].json_schema.properties.xxx_id.minLength", + "json_schema_validations[].json_schema.properties.xxx_id.type", + "json_schema_validations[].json_schema.required", + "json_schema_validations[].json_schema.required[]", + "json_schema_validations[].json_schema.title", + "json_schema_validations[].json_schema.type", + "json_schema_validations[].operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getBankLevelDynamicEndpoint", + "documented_path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "fields": [ + "dynamic_endpoint_id", + "swagger_string", + "swagger_string.definitions", + "swagger_string.definitions.AccountName", + "swagger_string.definitions.AccountName.properties", + "swagger_string.definitions.AccountName.properties.balance", + "swagger_string.definitions.AccountName.properties.balance.example", + "swagger_string.definitions.AccountName.properties.balance.format", + "swagger_string.definitions.AccountName.properties.balance.type", + "swagger_string.definitions.AccountName.properties.name", + "swagger_string.definitions.AccountName.properties.name.example", + "swagger_string.definitions.AccountName.properties.name.type", + "swagger_string.definitions.AccountName.type", + "swagger_string.host", + "swagger_string.info", + "swagger_string.info.title", + "swagger_string.info.version", + "swagger_string.paths", + "swagger_string.paths./accounts", + "swagger_string.paths./accounts.post", + "swagger_string.paths./accounts.post.consumes", + "swagger_string.paths./accounts.post.consumes[]", + "swagger_string.paths./accounts.post.consumes[].s", + "swagger_string.paths./accounts.post.description", + "swagger_string.paths./accounts.post.operationId", + "swagger_string.paths./accounts.post.produces", + "swagger_string.paths./accounts.post.produces[]", + "swagger_string.paths./accounts.post.produces[].s", + "swagger_string.paths./accounts.post.responses", + "swagger_string.paths./accounts.post.responses.201", + "swagger_string.paths./accounts.post.responses.201.description", + "swagger_string.paths./accounts.post.responses.201.schema", + "swagger_string.paths./accounts.post.responses.201.schema.$ref", + "swagger_string.paths./accounts.post.summary", + "swagger_string.paths./accounts/{account_id}", + "swagger_string.paths./accounts/{account_id}.get", + "swagger_string.paths./accounts/{account_id}.get.consumes", + "swagger_string.paths./accounts/{account_id}.get.consumes[]", + "swagger_string.paths./accounts/{account_id}.get.consumes[].s", + "swagger_string.paths./accounts/{account_id}.get.description", + "swagger_string.paths./accounts/{account_id}.get.operationId", + "swagger_string.paths./accounts/{account_id}.get.produces", + "swagger_string.paths./accounts/{account_id}.get.produces[]", + "swagger_string.paths./accounts/{account_id}.get.produces[].s", + "swagger_string.paths./accounts/{account_id}.get.responses", + "swagger_string.paths./accounts/{account_id}.get.responses.200", + "swagger_string.paths./accounts/{account_id}.get.responses.200.description", + "swagger_string.paths./accounts/{account_id}.get.responses.200.schema", + "swagger_string.paths./accounts/{account_id}.get.responses.200.schema.$ref", + "swagger_string.paths./accounts/{account_id}.get.summary", + "swagger_string.schemes", + "swagger_string.schemes[]", + "swagger_string.schemes[].s", + "swagger_string.swagger", + "user_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteBankLevelDynamicEndpoint", + "documented_path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "fields": [] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createBankLevelDynamicEndpoint", + "documented_path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints", + "fields": [ + "dynamic_endpoint_id", + "swagger_string", + "swagger_string.definitions", + "swagger_string.definitions.AccountName", + "swagger_string.definitions.AccountName.properties", + "swagger_string.definitions.AccountName.properties.balance", + "swagger_string.definitions.AccountName.properties.balance.example", + "swagger_string.definitions.AccountName.properties.balance.format", + "swagger_string.definitions.AccountName.properties.balance.type", + "swagger_string.definitions.AccountName.properties.name", + "swagger_string.definitions.AccountName.properties.name.example", + "swagger_string.definitions.AccountName.properties.name.type", + "swagger_string.definitions.AccountName.type", + "swagger_string.host", + "swagger_string.info", + "swagger_string.info.title", + "swagger_string.info.version", + "swagger_string.paths", + "swagger_string.paths./accounts", + "swagger_string.paths./accounts.post", + "swagger_string.paths./accounts.post.consumes", + "swagger_string.paths./accounts.post.consumes[]", + "swagger_string.paths./accounts.post.consumes[].s", + "swagger_string.paths./accounts.post.description", + "swagger_string.paths./accounts.post.operationId", + "swagger_string.paths./accounts.post.produces", + "swagger_string.paths./accounts.post.produces[]", + "swagger_string.paths./accounts.post.produces[].s", + "swagger_string.paths./accounts.post.responses", + "swagger_string.paths./accounts.post.responses.201", + "swagger_string.paths./accounts.post.responses.201.description", + "swagger_string.paths./accounts.post.responses.201.schema", + "swagger_string.paths./accounts.post.responses.201.schema.$ref", + "swagger_string.paths./accounts.post.summary", + "swagger_string.paths./accounts/{account_id}", + "swagger_string.paths./accounts/{account_id}.get", + "swagger_string.paths./accounts/{account_id}.get.consumes", + "swagger_string.paths./accounts/{account_id}.get.consumes[]", + "swagger_string.paths./accounts/{account_id}.get.consumes[].s", + "swagger_string.paths./accounts/{account_id}.get.description", + "swagger_string.paths./accounts/{account_id}.get.operationId", + "swagger_string.paths./accounts/{account_id}.get.produces", + "swagger_string.paths./accounts/{account_id}.get.produces[]", + "swagger_string.paths./accounts/{account_id}.get.produces[].s", + "swagger_string.paths./accounts/{account_id}.get.responses", + "swagger_string.paths./accounts/{account_id}.get.responses.200", + "swagger_string.paths./accounts/{account_id}.get.responses.200.description", + "swagger_string.paths./accounts/{account_id}.get.responses.200.schema", + "swagger_string.paths./accounts/{account_id}.get.responses.200.schema.$ref", + "swagger_string.paths./accounts/{account_id}.get.summary", + "swagger_string.schemes", + "swagger_string.schemes[]", + "swagger_string.schemes[].s", + "swagger_string.swagger", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/dynamic-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getDynamicEndpoints", + "documented_path": "/obp/v6.0.0/management/dynamic-endpoints", + "fields": [ + "dynamic_endpoints", + "dynamic_endpoints[]", + "dynamic_endpoints[].dynamic_endpoint_id", + "dynamic_endpoints[].swagger_string", + "dynamic_endpoints[].swagger_string.definitions", + "dynamic_endpoints[].swagger_string.definitions.AccountName", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.balance", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.balance.example", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.balance.format", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.balance.type", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.name", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.name.example", + "dynamic_endpoints[].swagger_string.definitions.AccountName.properties.name.type", + "dynamic_endpoints[].swagger_string.definitions.AccountName.type", + "dynamic_endpoints[].swagger_string.host", + "dynamic_endpoints[].swagger_string.info", + "dynamic_endpoints[].swagger_string.info.title", + "dynamic_endpoints[].swagger_string.info.version", + "dynamic_endpoints[].swagger_string.paths", + "dynamic_endpoints[].swagger_string.paths./accounts", + "dynamic_endpoints[].swagger_string.paths./accounts.post", + "dynamic_endpoints[].swagger_string.paths./accounts.post.consumes", + "dynamic_endpoints[].swagger_string.paths./accounts.post.consumes[]", + "dynamic_endpoints[].swagger_string.paths./accounts.post.consumes[].s", + "dynamic_endpoints[].swagger_string.paths./accounts.post.description", + "dynamic_endpoints[].swagger_string.paths./accounts.post.operationId", + "dynamic_endpoints[].swagger_string.paths./accounts.post.produces", + "dynamic_endpoints[].swagger_string.paths./accounts.post.produces[]", + "dynamic_endpoints[].swagger_string.paths./accounts.post.produces[].s", + "dynamic_endpoints[].swagger_string.paths./accounts.post.responses", + "dynamic_endpoints[].swagger_string.paths./accounts.post.responses.201", + "dynamic_endpoints[].swagger_string.paths./accounts.post.responses.201.description", + "dynamic_endpoints[].swagger_string.paths./accounts.post.responses.201.schema", + "dynamic_endpoints[].swagger_string.paths./accounts.post.responses.201.schema.$ref", + "dynamic_endpoints[].swagger_string.paths./accounts.post.summary", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.consumes", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.consumes[]", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.consumes[].s", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.description", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.operationId", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.produces", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.produces[]", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.produces[].s", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.responses", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.responses.200", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.responses.200.description", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.responses.200.schema", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.responses.200.schema.$ref", + "dynamic_endpoints[].swagger_string.paths./accounts/{account_id}.get.summary", + "dynamic_endpoints[].swagger_string.schemes", + "dynamic_endpoints[].swagger_string.schemes[]", + "dynamic_endpoints[].swagger_string.schemes[].s", + "dynamic_endpoints[].swagger_string.swagger", + "dynamic_endpoints[].user_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteDynamicEndpoint", + "documented_path": "/obp/v6.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/endpoint-mappings", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getAllEndpointMappings", + "documented_path": "/obp/v5.1.0/management/endpoint-mappings", + "fields": [ + "endpoint-mappings", + "endpoint-mappings[]", + "endpoint-mappings[].endpoint_mapping_id", + "endpoint-mappings[].operation_id", + "endpoint-mappings[].request_mapping", + "endpoint-mappings[].response_mapping", + "endpoint-mappings[].response_mapping.balance", + "endpoint-mappings[].response_mapping.balance.entity", + "endpoint-mappings[].response_mapping.balance.field", + "endpoint-mappings[].response_mapping.balance.query", + "endpoint-mappings[].response_mapping.name", + "endpoint-mappings[].response_mapping.name.entity", + "endpoint-mappings[].response_mapping.name.field", + "endpoint-mappings[].response_mapping.name.query" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/json-schema-validations", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getAllJsonSchemaValidations", + "documented_path": "/obp/v5.1.0/management/json-schema-validations", + "fields": [ + "json_schema_validations", + "json_schema_validations[]", + "json_schema_validations[].json_schema", + "json_schema_validations[].json_schema.$schema", + "json_schema_validations[].json_schema.additionalProperties", + "json_schema_validations[].json_schema.description", + "json_schema_validations[].json_schema.properties", + "json_schema_validations[].json_schema.properties.xxx_id", + "json_schema_validations[].json_schema.properties.xxx_id.examples", + "json_schema_validations[].json_schema.properties.xxx_id.examples[]", + "json_schema_validations[].json_schema.properties.xxx_id.maxLength", + "json_schema_validations[].json_schema.properties.xxx_id.minLength", + "json_schema_validations[].json_schema.properties.xxx_id.type", + "json_schema_validations[].json_schema.required", + "json_schema_validations[].json_schema.required[]", + "json_schema_validations[].json_schema.title", + "json_schema_validations[].json_schema.type", + "json_schema_validations[].operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getDynamicEndpoint", + "documented_path": "/obp/v6.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "fields": [ + "dynamic_endpoint_id", + "swagger_string", + "swagger_string.definitions", + "swagger_string.definitions.AccountName", + "swagger_string.definitions.AccountName.properties", + "swagger_string.definitions.AccountName.properties.balance", + "swagger_string.definitions.AccountName.properties.balance.example", + "swagger_string.definitions.AccountName.properties.balance.format", + "swagger_string.definitions.AccountName.properties.balance.type", + "swagger_string.definitions.AccountName.properties.name", + "swagger_string.definitions.AccountName.properties.name.example", + "swagger_string.definitions.AccountName.properties.name.type", + "swagger_string.definitions.AccountName.type", + "swagger_string.host", + "swagger_string.info", + "swagger_string.info.title", + "swagger_string.info.version", + "swagger_string.paths", + "swagger_string.paths./accounts", + "swagger_string.paths./accounts.post", + "swagger_string.paths./accounts.post.consumes", + "swagger_string.paths./accounts.post.consumes[]", + "swagger_string.paths./accounts.post.consumes[].s", + "swagger_string.paths./accounts.post.description", + "swagger_string.paths./accounts.post.operationId", + "swagger_string.paths./accounts.post.produces", + "swagger_string.paths./accounts.post.produces[]", + "swagger_string.paths./accounts.post.produces[].s", + "swagger_string.paths./accounts.post.responses", + "swagger_string.paths./accounts.post.responses.201", + "swagger_string.paths./accounts.post.responses.201.description", + "swagger_string.paths./accounts.post.responses.201.schema", + "swagger_string.paths./accounts.post.responses.201.schema.$ref", + "swagger_string.paths./accounts.post.summary", + "swagger_string.paths./accounts/{account_id}", + "swagger_string.paths./accounts/{account_id}.get", + "swagger_string.paths./accounts/{account_id}.get.consumes", + "swagger_string.paths./accounts/{account_id}.get.consumes[]", + "swagger_string.paths./accounts/{account_id}.get.consumes[].s", + "swagger_string.paths./accounts/{account_id}.get.description", + "swagger_string.paths./accounts/{account_id}.get.operationId", + "swagger_string.paths./accounts/{account_id}.get.produces", + "swagger_string.paths./accounts/{account_id}.get.produces[]", + "swagger_string.paths./accounts/{account_id}.get.produces[].s", + "swagger_string.paths./accounts/{account_id}.get.responses", + "swagger_string.paths./accounts/{account_id}.get.responses.200", + "swagger_string.paths./accounts/{account_id}.get.responses.200.description", + "swagger_string.paths./accounts/{account_id}.get.responses.200.schema", + "swagger_string.paths./accounts/{account_id}.get.responses.200.schema.$ref", + "swagger_string.paths./accounts/{account_id}.get.summary", + "swagger_string.schemes", + "swagger_string.schemes[]", + "swagger_string.schemes[].s", + "swagger_string.swagger", + "user_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteDynamicEndpoint", + "documented_path": "/obp/v6.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID", + "fields": [] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/dynamic-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createDynamicEndpoint", + "documented_path": "/obp/v6.0.0/management/dynamic-endpoints", + "fields": [ + "dynamic_endpoint_id", + "swagger_string", + "swagger_string.definitions", + "swagger_string.definitions.AccountName", + "swagger_string.definitions.AccountName.properties", + "swagger_string.definitions.AccountName.properties.balance", + "swagger_string.definitions.AccountName.properties.balance.example", + "swagger_string.definitions.AccountName.properties.balance.format", + "swagger_string.definitions.AccountName.properties.balance.type", + "swagger_string.definitions.AccountName.properties.name", + "swagger_string.definitions.AccountName.properties.name.example", + "swagger_string.definitions.AccountName.properties.name.type", + "swagger_string.definitions.AccountName.type", + "swagger_string.host", + "swagger_string.info", + "swagger_string.info.title", + "swagger_string.info.version", + "swagger_string.paths", + "swagger_string.paths./accounts", + "swagger_string.paths./accounts.post", + "swagger_string.paths./accounts.post.consumes", + "swagger_string.paths./accounts.post.consumes[]", + "swagger_string.paths./accounts.post.consumes[].s", + "swagger_string.paths./accounts.post.description", + "swagger_string.paths./accounts.post.operationId", + "swagger_string.paths./accounts.post.produces", + "swagger_string.paths./accounts.post.produces[]", + "swagger_string.paths./accounts.post.produces[].s", + "swagger_string.paths./accounts.post.responses", + "swagger_string.paths./accounts.post.responses.201", + "swagger_string.paths./accounts.post.responses.201.description", + "swagger_string.paths./accounts.post.responses.201.schema", + "swagger_string.paths./accounts.post.responses.201.schema.$ref", + "swagger_string.paths./accounts.post.summary", + "swagger_string.paths./accounts/{account_id}", + "swagger_string.paths./accounts/{account_id}.get", + "swagger_string.paths./accounts/{account_id}.get.consumes", + "swagger_string.paths./accounts/{account_id}.get.consumes[]", + "swagger_string.paths./accounts/{account_id}.get.consumes[].s", + "swagger_string.paths./accounts/{account_id}.get.description", + "swagger_string.paths./accounts/{account_id}.get.operationId", + "swagger_string.paths./accounts/{account_id}.get.produces", + "swagger_string.paths./accounts/{account_id}.get.produces[]", + "swagger_string.paths./accounts/{account_id}.get.produces[].s", + "swagger_string.paths./accounts/{account_id}.get.responses", + "swagger_string.paths./accounts/{account_id}.get.responses.200", + "swagger_string.paths./accounts/{account_id}.get.responses.200.description", + "swagger_string.paths./accounts/{account_id}.get.responses.200.schema", + "swagger_string.paths./accounts/{account_id}.get.responses.200.schema.$ref", + "swagger_string.paths./accounts/{account_id}.get.summary", + "swagger_string.schemes", + "swagger_string.schemes[]", + "swagger_string.schemes[].s", + "swagger_string.swagger", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/diagnostics/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getDynamicEntityDiagnostics", + "documented_path": "/obp/v6.0.0/management/diagnostics/dynamic-entities", + "fields": [ + "issues", + "issues[]", + "issues[].bank_id", + "issues[].entity_name", + "issues[].error_message", + "issues[].example_value", + "issues[].field_name", + "orphaned_entities", + "orphaned_entities[]", + "orphaned_entities[].bank_id", + "orphaned_entities[].entity_name", + "orphaned_entities[].record_count", + "scanned_entities", + "scanned_entities[]", + "total_issues" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityDefinitions", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[].auth_mode", + "dynamic_entities[].bank_id", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.description", + "dynamic_entities[].schema.properties.language.example", + "dynamic_entities[].schema.properties.language.maxLength", + "dynamic_entities[].schema.properties.language.minLength", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.description", + "dynamic_entities[].schema.properties.theme.example", + "dynamic_entities[].schema.properties.theme.indexed", + "dynamic_entities[].schema.properties.theme.maxLength", + "dynamic_entities[].schema.properties.theme.minLength", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/diagnostics/dynamic-entities/orphaned-records", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-cleanupOrphanedDynamicEntityRecords", + "documented_path": "/obp/v6.0.0/management/diagnostics/dynamic-entities/orphaned-records", + "fields": [ + "deleted_orphaned_entities", + "deleted_orphaned_entities[]", + "deleted_orphaned_entities[].bank_id", + "deleted_orphaned_entities[].entity_name", + "deleted_orphaned_entities[].record_count", + "total_records_deleted" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityDefinitions", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[].auth_mode", + "dynamic_entities[].bank_id", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.description", + "dynamic_entities[].schema.properties.language.example", + "dynamic_entities[].schema.properties.language.maxLength", + "dynamic_entities[].schema.properties.language.minLength", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.description", + "dynamic_entities[].schema.properties.theme.example", + "dynamic_entities[].schema.properties.theme.indexed", + "dynamic_entities[].schema.properties.theme.maxLength", + "dynamic_entities[].schema.properties.theme.minLength", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/personal-dynamic-entities/available", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAvailablePersonalDynamicEntities", + "documented_path": "/obp/v6.0.0/personal-dynamic-entities/available", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[]._links", + "dynamic_entities[]._links.related", + "dynamic_entities[]._links.related[]", + "dynamic_entities[]._links.related[].href", + "dynamic_entities[]._links.related[].method", + "dynamic_entities[]._links.related[].rel", + "dynamic_entities[].auth_mode", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/personal-dynamic-entities/available", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAvailablePersonalDynamicEntities", + "documented_path": "/obp/v6.0.0/personal-dynamic-entities/available", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[]._links", + "dynamic_entities[]._links.related", + "dynamic_entities[]._links.related[]", + "dynamic_entities[]._links.related[].href", + "dynamic_entities[]._links.related[].method", + "dynamic_entities[]._links.related[].rel", + "dynamic_entities[].auth_mode", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityDefinitions", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[].auth_mode", + "dynamic_entities[].bank_id", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.description", + "dynamic_entities[].schema.properties.language.example", + "dynamic_entities[].schema.properties.language.maxLength", + "dynamic_entities[].schema.properties.language.minLength", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.description", + "dynamic_entities[].schema.properties.theme.example", + "dynamic_entities[].schema.properties.theme.indexed", + "dynamic_entities[].schema.properties.theme.maxLength", + "dynamic_entities[].schema.properties.theme.minLength", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityDefinitions", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[].auth_mode", + "dynamic_entities[].bank_id", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.description", + "dynamic_entities[].schema.properties.language.example", + "dynamic_entities[].schema.properties.language.maxLength", + "dynamic_entities[].schema.properties.language.minLength", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.description", + "dynamic_entities[].schema.properties.theme.example", + "dynamic_entities[].schema.properties.theme.indexed", + "dynamic_entities[].schema.properties.theme.maxLength", + "dynamic_entities[].schema.properties.theme.minLength", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createDynamicEntityDefinition", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "auth_mode", + "bank_id", + "dynamic_entity_id", + "entity_name", + "has_community_access", + "has_personal_entity", + "has_public_access", + "personal_requires_role", + "schema", + "schema.description", + "schema.properties", + "schema.properties.language", + "schema.properties.language.description", + "schema.properties.language.example", + "schema.properties.language.maxLength", + "schema.properties.language.minLength", + "schema.properties.language.type", + "schema.properties.theme", + "schema.properties.theme.description", + "schema.properties.theme.example", + "schema.properties.theme.indexed", + "schema.properties.theme.maxLength", + "schema.properties.theme.minLength", + "schema.properties.theme.type", + "schema.required", + "schema.required[]", + "schema.required[].s", + "use_row_level_access", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/OBPv6.0.0/openapi", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsOpenAPI31", + "documented_path": "/obp/v6.0.0/resource-docs/API_VERSION/openapi", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/OBPv6.0.0/openapi.yaml", + "docs_from": "https://k8s.openbankproject.com", + "missing": true + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entity-web-hooks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityWebhooksAtBank", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entity-web-hooks", + "fields": [ + "web_hooks", + "web_hooks[]", + "web_hooks[].bank_id", + "web_hooks[].created_at", + "web_hooks[].created_by_user_id", + "web_hooks[].description", + "web_hooks[].dynamic_entity_id", + "web_hooks[].entity_name", + "web_hooks[].events", + "web_hooks[].events[]", + "web_hooks[].field_conditions", + "web_hooks[].field_conditions[]", + "web_hooks[].field_conditions[].field", + "web_hooks[].field_conditions[].from", + "web_hooks[].field_conditions[].from.value", + "web_hooks[].field_conditions[].to", + "web_hooks[].field_conditions[].to.value", + "web_hooks[].is_active", + "web_hooks[].signature_status", + "web_hooks[].updated_at", + "web_hooks[].url", + "web_hooks[].webhook_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityWebhook", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID", + "fields": [ + "bank_id", + "created_at", + "created_by_user_id", + "description", + "dynamic_entity_id", + "entity_name", + "events", + "events[]", + "field_conditions", + "field_conditions[]", + "field_conditions[].field", + "field_conditions[].from", + "field_conditions[].from.value", + "field_conditions[].to", + "field_conditions[].to.value", + "is_active", + "signature_status", + "updated_at", + "url", + "webhook_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID/deliveries", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityWebhookDeliveries", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/web-hooks/WEBHOOK_ID/deliveries", + "fields": [ + "deliveries", + "deliveries[]", + "deliveries[].attempts", + "deliveries[].created_at", + "deliveries[].event_id", + "deliveries[].event_name", + "deliveries[].last_error", + "deliveries[].last_http_status", + "deliveries[].record_id", + "deliveries[].status", + "deliveries[].updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/resource-docs/v7.0.0/obp", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsObp", + "documented_path": "/obp/v7.0.0/resource-docs/API_VERSION/obp", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/resource-docs/v7.0.0/obp", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsObp", + "documented_path": "/obp/v7.0.0/resource-docs/API_VERSION/obp", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/dynamic-resource-docs", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getAllDynamicResourceDocs", + "documented_path": "/obp/v5.1.0/management/dynamic-resource-docs", + "fields": [ + "dynamic-resource-docs", + "dynamic-resource-docs[]", + "dynamic-resource-docs[].bank_id", + "dynamic-resource-docs[].description", + "dynamic-resource-docs[].dynamic_resource_doc_id", + "dynamic-resource-docs[].error_response_bodies", + "dynamic-resource-docs[].example_request_body", + "dynamic-resource-docs[].example_request_body._optional_fields_", + "dynamic-resource-docs[].example_request_body._optional_fields_[]", + "dynamic-resource-docs[].example_request_body._optional_fields_[].s", + "dynamic-resource-docs[].example_request_body.age", + "dynamic-resource-docs[].example_request_body.hobby", + "dynamic-resource-docs[].example_request_body.hobby[]", + "dynamic-resource-docs[].example_request_body.hobby[].s", + "dynamic-resource-docs[].example_request_body.name", + "dynamic-resource-docs[].method_body", + "dynamic-resource-docs[].partial_function_name", + "dynamic-resource-docs[].programming_lang", + "dynamic-resource-docs[].request_url", + "dynamic-resource-docs[].request_verb", + "dynamic-resource-docs[].roles", + "dynamic-resource-docs[].success_response_body", + "dynamic-resource-docs[].success_response_body._optional_fields_", + "dynamic-resource-docs[].success_response_body._optional_fields_[]", + "dynamic-resource-docs[].success_response_body._optional_fields_[].s", + "dynamic-resource-docs[].success_response_body.age", + "dynamic-resource-docs[].success_response_body.hobby", + "dynamic-resource-docs[].success_response_body.hobby[]", + "dynamic-resource-docs[].success_response_body.hobby[].s", + "dynamic-resource-docs[].success_response_body.my_user_id", + "dynamic-resource-docs[].success_response_body.name", + "dynamic-resource-docs[].summary", + "dynamic-resource-docs[].tags" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteDynamicResourceDoc", + "documented_path": "/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getDynamicResourceDoc", + "documented_path": "/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID", + "fields": [ + "bank_id", + "description", + "dynamic_resource_doc_id", + "error_response_bodies", + "example_request_body", + "example_request_body._optional_fields_", + "example_request_body._optional_fields_[]", + "example_request_body._optional_fields_[].s", + "example_request_body.age", + "example_request_body.hobby", + "example_request_body.hobby[]", + "example_request_body.hobby[].s", + "example_request_body.name", + "method_body", + "partial_function_name", + "programming_lang", + "request_url", + "request_verb", + "roles", + "success_response_body", + "success_response_body._optional_fields_", + "success_response_body._optional_fields_[]", + "success_response_body._optional_fields_[].s", + "success_response_body.age", + "success_response_body.hobby", + "success_response_body.hobby[]", + "success_response_body.hobby[].s", + "success_response_body.my_user_id", + "success_response_body.name", + "summary", + "tags" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/resource-docs/v7.0.0/obp", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsObp", + "documented_path": "/obp/v7.0.0/resource-docs/API_VERSION/obp", + "fields": [] + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteDynamicResourceDoc", + "documented_path": "/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-updateDynamicResourceDoc", + "documented_path": "/obp/v5.1.0/management/dynamic-resource-docs/DYNAMIC_RESOURCE_DOC_ID", + "fields": [ + "bank_id", + "description", + "dynamic_resource_doc_id", + "error_response_bodies", + "example_request_body", + "example_request_body._optional_fields_", + "example_request_body._optional_fields_[]", + "example_request_body._optional_fields_[].s", + "example_request_body.age", + "example_request_body.hobby", + "example_request_body.hobby[]", + "example_request_body.hobby[].s", + "example_request_body.name", + "method_body", + "partial_function_name", + "programming_lang", + "request_url", + "request_verb", + "roles", + "success_response_body", + "success_response_body._optional_fields_", + "success_response_body._optional_fields_[]", + "success_response_body._optional_fields_[].s", + "success_response_body.age", + "success_response_body.hobby", + "success_response_body.hobby[]", + "success_response_body.hobby[].s", + "success_response_body.my_user_id", + "success_response_body.name", + "summary", + "tags" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/dynamic-resource-docs", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createDynamicResourceDoc", + "documented_path": "/obp/v5.1.0/management/dynamic-resource-docs", + "fields": [ + "bank_id", + "description", + "dynamic_resource_doc_id", + "error_response_bodies", + "example_request_body", + "example_request_body._optional_fields_", + "example_request_body._optional_fields_[]", + "example_request_body._optional_fields_[].s", + "example_request_body.age", + "example_request_body.hobby", + "example_request_body.hobby[]", + "example_request_body.hobby[].s", + "example_request_body.name", + "method_body", + "partial_function_name", + "programming_lang", + "request_url", + "request_verb", + "roles", + "success_response_body", + "success_response_body._optional_fields_", + "success_response_body._optional_fields_[]", + "success_response_body._optional_fields_[].s", + "success_response_body.age", + "success_response_body.hobby", + "success_response_body.hobby[]", + "success_response_body.hobby[].s", + "success_response_body.my_user_id", + "success_response_body.name", + "summary", + "tags" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/files", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getFilesOfSpace", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/files", + "fields": [ + "files", + "files[]", + "files[].bank_id", + "files[].created_at", + "files[].file_id", + "files[].file_name", + "files[].is_personal", + "files[].is_public", + "files[].media_type", + "files[].on_behalf_of_user_id", + "files[].owner_user_id", + "files[].scan_status", + "files[].scan_status_reason", + "files[].sha256", + "files[].size_in_bytes", + "files[].user_id", + "pagination", + "pagination.limit", + "pagination.offset", + "pagination.total" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/banks/BANK_ID/files", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createFile", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/files", + "fields": [ + "bank_id", + "created_at", + "file_id", + "file_name", + "is_personal", + "is_public", + "media_type", + "on_behalf_of_user_id", + "owner_user_id", + "scan_status", + "scan_status_reason", + "sha256", + "size_in_bytes", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/api/glossary/TITLE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getGlossaryItem", + "documented_path": "/obp/v7.0.0/api/glossary/TITLE", + "fields": [ + "created_at", + "created_by_user_id", + "description", + "description.html", + "description.markdown", + "glossary_item_id", + "is_dynamic", + "overrides_static_item", + "shadows_static_glossary_item", + "title", + "updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/resource-docs/v7.0.0/obp", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsObp", + "documented_path": "/obp/v7.0.0/resource-docs/API_VERSION/obp", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/json-schema-validations", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getAllJsonSchemaValidations", + "documented_path": "/obp/v5.1.0/management/json-schema-validations", + "fields": [ + "json_schema_validations", + "json_schema_validations[]", + "json_schema_validations[].json_schema", + "json_schema_validations[].json_schema.$schema", + "json_schema_validations[].json_schema.additionalProperties", + "json_schema_validations[].json_schema.description", + "json_schema_validations[].json_schema.properties", + "json_schema_validations[].json_schema.properties.xxx_id", + "json_schema_validations[].json_schema.properties.xxx_id.examples", + "json_schema_validations[].json_schema.properties.xxx_id.examples[]", + "json_schema_validations[].json_schema.properties.xxx_id.maxLength", + "json_schema_validations[].json_schema.properties.xxx_id.minLength", + "json_schema_validations[].json_schema.properties.xxx_id.type", + "json_schema_validations[].json_schema.required", + "json_schema_validations[].json_schema.required[]", + "json_schema_validations[].json_schema.title", + "json_schema_validations[].json_schema.type", + "json_schema_validations[].operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getJsonSchemaValidation", + "documented_path": "/obp/v5.1.0/management/json-schema-validations/OPERATION_ID", + "fields": [ + "json_schema", + "json_schema.$schema", + "json_schema.additionalProperties", + "json_schema.description", + "json_schema.properties", + "json_schema.properties.xxx_id", + "json_schema.properties.xxx_id.examples", + "json_schema.properties.xxx_id.examples[]", + "json_schema.properties.xxx_id.maxLength", + "json_schema.properties.xxx_id.minLength", + "json_schema.properties.xxx_id.type", + "json_schema.required", + "json_schema.required[]", + "json_schema.title", + "json_schema.type", + "operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/customers/CUSTOMER_ID/accounts-minimal", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getAccountsMinimalByCustomerId", + "documented_path": "/obp/v5.1.0/customers/CUSTOMER_ID/accounts-minimal", + "fields": [ + "accounts", + "accounts[]", + "accounts[].account_id", + "accounts[].bank_id", + "accounts[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAccountsAtBank", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts", + "fields": [ + "accounts", + "accounts[]", + "accounts[].account_id", + "accounts[].bank_id", + "accounts[].label", + "accounts[].views_available", + "accounts[].views_available[]", + "accounts[].views_available[].id", + "accounts[].views_available[].is_public", + "accounts[].views_available[].short_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getMandates", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates", + "fields": [ + "mandates", + "mandates[]", + "mandates[].account_id", + "mandates[].bank_id", + "mandates[].created_by_user_id", + "mandates[].customer_id", + "mandates[].description", + "mandates[].legal_text", + "mandates[].mandate_id", + "mandates[].mandate_name", + "mandates[].mandate_reference", + "mandates[].status", + "mandates[].updated_by_user_id", + "mandates[].valid_from", + "mandates[].valid_to" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCustomersAtOneBank", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/customers", + "fields": [ + "customers", + "customers[]", + "customers[].bank_id", + "customers[].branch_id", + "customers[].credit_limit", + "customers[].credit_limit.amount", + "customers[].credit_limit.currency", + "customers[].credit_rating", + "customers[].credit_rating.rating", + "customers[].credit_rating.source", + "customers[].customer_id", + "customers[].customer_number", + "customers[].customer_type", + "customers[].date_of_birth", + "customers[].dependants", + "customers[].dob_of_dependants", + "customers[].dob_of_dependants[]", + "customers[].email", + "customers[].employment_status", + "customers[].face_image", + "customers[].face_image.date", + "customers[].face_image.url", + "customers[].highest_education_attained", + "customers[].kyc_status", + "customers[].last_ok_date", + "customers[].legal_name", + "customers[].mobile_phone_number", + "customers[].name_suffix", + "customers[].parent_customer_id", + "customers[].relationship_status", + "customers[].title" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getMandates", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates", + "fields": [ + "mandates", + "mandates[]", + "mandates[].account_id", + "mandates[].bank_id", + "mandates[].created_by_user_id", + "mandates[].customer_id", + "mandates[].description", + "mandates[].legal_text", + "mandates[].mandate_id", + "mandates[].mandate_name", + "mandates[].mandate_reference", + "mandates[].status", + "mandates[].updated_by_user_id", + "mandates[].valid_from", + "mandates[].valid_to" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates/MANDATE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getMandate", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates/MANDATE_ID", + "fields": [ + "account_id", + "bank_id", + "created_by_user_id", + "customer_id", + "description", + "legal_text", + "mandate_id", + "mandate_name", + "mandate_reference", + "status", + "updated_by_user_id", + "valid_from", + "valid_to" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/provisions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getMandateProvisions", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/provisions", + "fields": [ + "provisions", + "provisions[]", + "provisions[].conditions", + "provisions[].is_active", + "provisions[].legal_reference", + "provisions[].linked_abac_rule_id", + "provisions[].linked_challenge_type", + "provisions[].linked_view_id", + "provisions[].mandate_id", + "provisions[].provision_description", + "provisions[].provision_id", + "provisions[].provision_name", + "provisions[].provision_type", + "provisions[].signatory_requirements", + "provisions[].signatory_requirements[]", + "provisions[].signatory_requirements[].panel_id", + "provisions[].signatory_requirements[].required_count", + "provisions[].sort_order" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/provisions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createMandateProvision", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/provisions", + "fields": [ + "conditions", + "is_active", + "legal_reference", + "linked_abac_rule_id", + "linked_challenge_type", + "linked_view_id", + "mandate_id", + "provision_description", + "provision_id", + "provision_name", + "provision_type", + "signatory_requirements", + "signatory_requirements[]", + "signatory_requirements[].panel_id", + "signatory_requirements[].required_count", + "sort_order" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSignatoryPanels", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels", + "fields": [ + "signatory_panels", + "signatory_panels[]", + "signatory_panels[].description", + "signatory_panels[].mandate_id", + "signatory_panels[].panel_id", + "signatory_panels[].panel_name", + "signatory_panels[].user_ids", + "signatory_panels[].user_ids[]" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createSignatoryPanel", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels", + "fields": [ + "description", + "mandate_id", + "panel_id", + "panel_name", + "user_ids", + "user_ids[]" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createMandate", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates", + "fields": [ + "account_id", + "bank_id", + "created_by_user_id", + "customer_id", + "description", + "legal_text", + "mandate_id", + "mandate_name", + "mandate_reference", + "status", + "updated_by_user_id", + "valid_from", + "valid_to" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/system/diagnostics/metrics/run", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-triggerMetricsArchiveRun", + "documented_path": "/obp/v7.0.0/management/system/diagnostics/metrics/run", + "fields": [ + "message", + "run", + "run.api_instance_id", + "run.duration_ms", + "run.ended_at", + "run.remark", + "run.rows_deleted_from_archive", + "run.rows_moved_to_archive", + "run.run_id", + "run.started_at", + "run.success", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/system/diagnostics/metrics", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getMetricsDiagnostics", + "documented_path": "/obp/v7.0.0/management/system/diagnostics/metrics", + "fields": [ + "checks", + "checks[]", + "checks[].message", + "checks[].name", + "checks[].status", + "config", + "config.enable_metrics_scheduler", + "config.retain_archive_metrics_days", + "config.retain_metrics_days", + "config.retain_metrics_move_limit", + "config.retain_metrics_scheduler_interval_in_seconds", + "config.write_metrics", + "everything_as_expected", + "last_run", + "last_run.api_instance_id", + "last_run.duration_ms", + "last_run.ended_at", + "last_run.remark", + "last_run.rows_deleted_from_archive", + "last_run.rows_moved_to_archive", + "last_run.run_id", + "last_run.started_at", + "last_run.success", + "last_successful_run", + "last_successful_run.api_instance_id", + "last_successful_run.duration_ms", + "last_successful_run.ended_at", + "last_successful_run.remark", + "last_successful_run.rows_deleted_from_archive", + "last_successful_run.rows_moved_to_archive", + "last_successful_run.run_id", + "last_successful_run.started_at", + "last_successful_run.success", + "metric", + "metric.count", + "metric.newest_record_age_days", + "metric.newest_record_date", + "metric.oldest_record_age_days", + "metric.oldest_record_date", + "metric.table_name", + "metric_archive", + "metric_archive.count", + "metric_archive.newest_record_age_days", + "metric_archive.newest_record_date", + "metric_archive.oldest_record_age_days", + "metric_archive.oldest_record_date", + "metric_archive.table_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/metrics", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getMetrics", + "documented_path": "/obp/v6.0.0/management/metrics", + "fields": [ + "metrics", + "metrics[]", + "metrics[].api_instance_id", + "metrics[].app_name", + "metrics[].auth_type", + "metrics[].certificate_trust", + "metrics[].certificate_trust_detail", + "metrics[].consent_reference_id", + "metrics[].consumer_id", + "metrics[].correlation_id", + "metrics[].date", + "metrics[].developer_email", + "metrics[].duration", + "metrics[].forwarded_for", + "metrics[].implemented_by_partial_function", + "metrics[].implemented_in_version", + "metrics[].operation_id", + "metrics[].response_body", + "metrics[].response_body.code", + "metrics[].response_body.message", + "metrics[].source_ip", + "metrics[].status_code", + "metrics[].target_ip", + "metrics[].url", + "metrics[].user_id", + "metrics[].username", + "metrics[].verb" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/system/diagnostics/deployment", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDeploymentChecks", + "documented_path": "/obp/v7.0.0/management/system/diagnostics/deployment", + "fields": [ + "api_instance_id", + "checked_at", + "checks", + "checks[]", + "checks[].area", + "checks[].basis", + "checks[].evidence", + "checks[].evidence[]", + "checks[].evidence[].name", + "checks[].evidence[].value", + "checks[].id", + "checks[].message", + "checks[].props", + "checks[].props[]", + "checks[].status", + "checks[].title", + "errors", + "warnings", + "window_minutes" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getApiProducts", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products", + "fields": [ + "api_products", + "api_products[]", + "api_products[].api_product_code", + "api_products[].api_product_id", + "api_products[].attributes", + "api_products[].attributes[]", + "api_products[].attributes[].api_product_attribute_id", + "api_products[].attributes[].api_product_code", + "api_products[].attributes[].bank_id", + "api_products[].attributes[].is_active", + "api_products[].attributes[].name", + "api_products[].attributes[].type", + "api_products[].attributes[].value", + "api_products[].bank_id", + "api_products[].category", + "api_products[].collection_id", + "api_products[].description", + "api_products[].monthly_subscription_amount", + "api_products[].monthly_subscription_currency", + "api_products[].more_info_url", + "api_products[].name", + "api_products[].parent_api_product_code", + "api_products[].per_day_call_limit", + "api_products[].per_hour_call_limit", + "api_products[].per_minute_call_limit", + "api_products[].per_month_call_limit", + "api_products[].per_second_call_limit", + "api_products[].per_week_call_limit", + "api_products[].tags", + "api_products[].tags[]", + "api_products[].terms_and_conditions_url" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-deleteApiProduct", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getApiProduct", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "fields": [ + "api_product_code", + "api_product_id", + "attributes", + "attributes[]", + "attributes[].api_product_attribute_id", + "attributes[].api_product_code", + "attributes[].bank_id", + "attributes[].is_active", + "attributes[].name", + "attributes[].type", + "attributes[].value", + "bank_id", + "category", + "collection_id", + "description", + "monthly_subscription_amount", + "monthly_subscription_currency", + "more_info_url", + "name", + "parent_api_product_code", + "per_day_call_limit", + "per_hour_call_limit", + "per_minute_call_limit", + "per_month_call_limit", + "per_second_call_limit", + "per_week_call_limit", + "tags", + "tags[]", + "terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getApiProduct", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "fields": [ + "api_product_code", + "api_product_id", + "attributes", + "attributes[]", + "attributes[].api_product_attribute_id", + "attributes[].api_product_code", + "attributes[].bank_id", + "attributes[].is_active", + "attributes[].name", + "attributes[].type", + "attributes[].value", + "bank_id", + "category", + "collection_id", + "description", + "monthly_subscription_amount", + "monthly_subscription_currency", + "more_info_url", + "name", + "parent_api_product_code", + "per_day_call_limit", + "per_hour_call_limit", + "per_minute_call_limit", + "per_month_call_limit", + "per_second_call_limit", + "per_week_call_limit", + "tags", + "tags[]", + "terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getMyApiCollections", + "documented_path": "/obp/v6.0.0/my/api-collections", + "fields": [ + "api_collections", + "api_collections[]", + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description", + "api_collections[].is_sharable", + "api_collections[].user_id" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createOrUpdateApiProduct", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "fields": [ + "api_product_code", + "api_product_id", + "attributes", + "attributes[]", + "attributes[].api_product_attribute_id", + "attributes[].api_product_code", + "attributes[].bank_id", + "attributes[].is_active", + "attributes[].name", + "attributes[].type", + "attributes[].value", + "bank_id", + "category", + "collection_id", + "description", + "monthly_subscription_amount", + "monthly_subscription_currency", + "more_info_url", + "name", + "parent_api_product_code", + "per_day_call_limit", + "per_hour_call_limit", + "per_minute_call_limit", + "per_month_call_limit", + "per_second_call_limit", + "per_week_call_limit", + "tags", + "tags[]", + "terms_and_conditions_url" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE/attribute", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createApiProductAttribute", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE/attribute", + "fields": [ + "api_product_attribute_id", + "api_product_code", + "bank_id", + "is_active", + "name", + "type", + "value" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-deleteApiProduct", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createOrUpdateApiProduct", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "fields": [ + "api_product_code", + "api_product_id", + "attributes", + "attributes[]", + "attributes[].api_product_attribute_id", + "attributes[].api_product_code", + "attributes[].bank_id", + "attributes[].is_active", + "attributes[].name", + "attributes[].type", + "attributes[].value", + "bank_id", + "category", + "collection_id", + "description", + "monthly_subscription_amount", + "monthly_subscription_currency", + "more_info_url", + "name", + "parent_api_product_code", + "per_day_call_limit", + "per_hour_call_limit", + "per_minute_call_limit", + "per_month_call_limit", + "per_second_call_limit", + "per_week_call_limit", + "tags", + "tags[]", + "terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections/name/API_COLLECTION_NAME", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getMyApiCollectionByName", + "documented_path": "/obp/v6.0.0/my/api-collections/name/API_COLLECTION_NAME", + "fields": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/product-collections/COLLECTION_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-getProductCollection", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/product-collections/COLLECTION_CODE", + "fields": [ + "collection_code", + "products", + "products[]", + "products[].bank_id", + "products[].category", + "products[].code", + "products[].description", + "products[].details", + "products[].family", + "products[].meta", + "products[].meta.license", + "products[].meta.license.id", + "products[].meta.license.name", + "products[].more_info_url", + "products[].name", + "products[].parent_product_code", + "products[].product_attributes", + "products[].product_attributes[]", + "products[].product_attributes[].name", + "products[].product_attributes[].product_attribute_id", + "products[].product_attributes[].product_code", + "products[].product_attributes[].type", + "products[].product_attributes[].value", + "products[].super_family" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getMyApiCollections", + "documented_path": "/obp/v6.0.0/my/api-collections", + "fields": [ + "api_collections", + "api_collections[]", + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description", + "api_collections[].is_sharable", + "api_collections[].user_id" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createOrUpdateApiProduct", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "fields": [ + "api_product_code", + "api_product_id", + "attributes", + "attributes[]", + "attributes[].api_product_attribute_id", + "attributes[].api_product_code", + "attributes[].bank_id", + "attributes[].is_active", + "attributes[].name", + "attributes[].type", + "attributes[].value", + "bank_id", + "category", + "collection_id", + "description", + "monthly_subscription_amount", + "monthly_subscription_currency", + "more_info_url", + "name", + "parent_api_product_code", + "per_day_call_limit", + "per_hour_call_limit", + "per_minute_call_limit", + "per_month_call_limit", + "per_second_call_limit", + "per_week_call_limit", + "tags", + "tags[]", + "terms_and_conditions_url" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE/attribute", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createApiProductAttribute", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE/attribute", + "fields": [ + "api_product_attribute_id", + "api_product_code", + "bank_id", + "is_active", + "name", + "type", + "value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/products", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getProductsV600", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/products", + "fields": [ + "products", + "products[]", + "products[].bank_id", + "products[].description", + "products[].meta", + "products[].meta.license", + "products[].meta.license.id", + "products[].meta.license.name", + "products[].more_info_url", + "products[].name", + "products[].parent_product_code", + "products[].product_code", + "products[].tags", + "products[].tags[]", + "products[].terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-getProduct", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE", + "fields": [ + "attributes", + "attributes[]", + "attributes[].name", + "attributes[].product_attribute_id", + "attributes[].product_code", + "attributes[].type", + "attributes[].value", + "bank_id", + "description", + "fees", + "fees[]", + "fees[].is_active", + "fees[].more_info", + "fees[].name", + "fees[].product_fee_id", + "fees[].value", + "fees[].value.amount", + "fees[].value.currency", + "fees[].value.frequency", + "fees[].value.type", + "meta", + "meta.license", + "meta.license.id", + "meta.license.name", + "more_info_url", + "name", + "parent_product_code", + "product_code", + "terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/products/PRODUCT_CODE/tags", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getProductTagsV600", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/products/PRODUCT_CODE/tags", + "fields": [ + "tags", + "tags[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-getProduct", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE", + "fields": [ + "attributes", + "attributes[]", + "attributes[].name", + "attributes[].product_attribute_id", + "attributes[].product_code", + "attributes[].type", + "attributes[].value", + "bank_id", + "description", + "fees", + "fees[]", + "fees[].is_active", + "fees[].more_info", + "fees[].name", + "fees[].product_fee_id", + "fees[].value", + "fees[].value.amount", + "fees[].value.currency", + "fees[].value.frequency", + "fees[].value.type", + "meta", + "meta.license", + "meta.license.id", + "meta.license.name", + "more_info_url", + "name", + "parent_product_code", + "product_code", + "terms_and_conditions_url" + ] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-createProduct", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE", + "fields": [ + "bank_id", + "description", + "meta", + "meta.license", + "meta.license.id", + "meta.license.name", + "more_info_url", + "name", + "parent_product_code", + "product_code", + "terms_and_conditions_url" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attribute", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createProductAttribute", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attribute", + "fields": [ + "bank_id", + "is_active", + "name", + "product_attribute_id", + "product_code", + "type", + "value" + ] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-updateProductAttribute", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attributes/PRODUCT_ATTRIBUTE_ID", + "fields": [ + "bank_id", + "is_active", + "name", + "product_attribute_id", + "product_code", + "type", + "value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/products/PRODUCT_CODE/tags", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getProductTagsV600", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/products/PRODUCT_CODE/tags", + "fields": [ + "tags", + "tags[]" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/products/PRODUCT_CODE/tags", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-updateProductTagsV600", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/products/PRODUCT_CODE/tags", + "fields": [ + "tags", + "tags[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/products", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAllProductsV600", + "documented_path": "/obp/v6.0.0/products", + "fields": [ + "products", + "products[]", + "products[].bank_id", + "products[].description", + "products[].meta", + "products[].meta.license", + "products[].meta.license.id", + "products[].meta.license.name", + "products[].more_info_url", + "products[].name", + "products[].parent_product_code", + "products[].product_code", + "products[].tags", + "products[].tags[]", + "products[].terms_and_conditions_url" + ] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-createProduct", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE", + "fields": [ + "bank_id", + "description", + "meta", + "meta.license", + "meta.license.id", + "meta.license.name", + "more_info_url", + "name", + "parent_product_code", + "product_code", + "terms_and_conditions_url" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attribute", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createProductAttribute", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/products/PRODUCT_CODE/attribute", + "fields": [ + "bank_id", + "is_active", + "name", + "product_attribute_id", + "product_code", + "type", + "value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/entitlement-requests", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getAllEntitlementRequests", + "documented_path": "/obp/v6.0.0/entitlement-requests", + "fields": [ + "entitlement_requests", + "entitlement_requests[]", + "entitlement_requests[].bank_id", + "entitlement_requests[].created", + "entitlement_requests[].entitlement_request_id", + "entitlement_requests[].role_name", + "entitlement_requests[].user", + "entitlement_requests[].user.email", + "entitlement_requests[].user.entitlements", + "entitlement_requests[].user.entitlements.list", + "entitlement_requests[].user.entitlements.list[]", + "entitlement_requests[].user.entitlements.list[].bank_id", + "entitlement_requests[].user.entitlements.list[].entitlement_id", + "entitlement_requests[].user.entitlements.list[].role_name", + "entitlement_requests[].user.provider", + "entitlement_requests[].user.provider_id", + "entitlement_requests[].user.user_id", + "entitlement_requests[].user.username" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/entitlement-requests/ENTITLEMENT_REQUEST_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-deleteEntitlementRequest", + "documented_path": "/obp/v6.0.0/entitlement-requests/ENTITLEMENT_REQUEST_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-getAllEntitlements", + "documented_path": "/obp/v6.0.0/entitlements", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].entitlement_id", + "list[].role_name", + "list[].user_id", + "list[].username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBank", + "documented_path": "/obp/v6.0.0/banks/BANK_ID", + "fields": [ + "attributes", + "attributes[]", + "attributes[].name", + "attributes[].value", + "bank_code", + "bank_id", + "bank_routings", + "bank_routings[]", + "bank_routings[].address", + "bank_routings[].scheme", + "full_name", + "logo", + "website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-getAllEntitlements", + "documented_path": "/obp/v6.0.0/entitlements", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].entitlement_id", + "list[].role_name", + "list[].user_id", + "list[].username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user_id/USER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getUserByUserId", + "documented_path": "/obp/v6.0.0/users/user_id/USER_ID", + "fields": [ + "agreements", + "agreements[]", + "agreements[].text", + "agreements[].type", + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "is_deleted", + "is_locked", + "last_marketing_agreement_signed_date", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.1.0-getRoles", + "documented_path": "/obp/v6.0.0/roles", + "fields": [ + "roles", + "roles[]", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/USER_ID/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getEntitlements", + "documented_path": "/obp/v6.0.0/users/USER_ID/entitlements", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].entitlement_id", + "list[].role_name", + "list[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.1.0-getRoles", + "documented_path": "/obp/v6.0.0/roles", + "fields": [ + "roles", + "roles[]", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getGroups", + "documented_path": "/obp/v6.0.0/management/groups", + "fields": [ + "groups", + "groups[]", + "groups[].bank_id", + "groups[].group_description", + "groups[].group_id", + "groups[].group_name", + "groups[].is_enabled", + "groups[].list_of_roles", + "groups[].list_of_roles[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups/GROUP_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getGroup", + "documented_path": "/obp/v6.0.0/management/groups/GROUP_ID", + "fields": [ + "bank_id", + "group_description", + "group_id", + "group_name", + "is_enabled", + "list_of_roles", + "list_of_roles[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups/GROUP_ID/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getGroupEntitlements", + "documented_path": "/obp/v6.0.0/management/groups/GROUP_ID/entitlements", + "fields": [ + "entitlements", + "entitlements[]", + "entitlements[].bank_id", + "entitlements[].created_by_process", + "entitlements[].entitlement_id", + "entitlements[].group_id", + "entitlements[].role_name", + "entitlements[].user_id", + "entitlements[].username" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/groups/GROUP_ID/sync-members", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-syncGroupMembers", + "documented_path": "/obp/v7.0.0/management/groups/GROUP_ID/sync-members", + "fields": [ + "bank_id", + "dry_run", + "group_id", + "members", + "members[]", + "members[].entitlements_created", + "members[].entitlements_created[]", + "members[].entitlements_deleted", + "members[].entitlements_deleted[]", + "members[].entitlements_moved", + "members[].entitlements_moved[]", + "members[].entitlements_moved[].role_name", + "members[].entitlements_moved[].to_group_id", + "members[].user_id", + "members[].username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups/GROUP_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getGroup", + "documented_path": "/obp/v6.0.0/management/groups/GROUP_ID", + "fields": [ + "bank_id", + "group_description", + "group_id", + "group_name", + "is_enabled", + "list_of_roles", + "list_of_roles[]" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/groups/GROUP_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-deleteGroup", + "documented_path": "/obp/v6.0.0/management/groups/GROUP_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups/GROUP_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getGroup", + "documented_path": "/obp/v6.0.0/management/groups/GROUP_ID", + "fields": [ + "bank_id", + "group_description", + "group_id", + "group_name", + "is_enabled", + "list_of_roles", + "list_of_roles[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.1.0-getRoles", + "documented_path": "/obp/v6.0.0/roles", + "fields": [ + "roles", + "roles[]", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/groups/GROUP_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-updateGroup", + "documented_path": "/obp/v6.0.0/management/groups/GROUP_ID", + "fields": [ + "bank_id", + "group_description", + "group_id", + "group_name", + "is_enabled", + "list_of_roles", + "list_of_roles[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.1.0-getRoles", + "documented_path": "/obp/v6.0.0/roles", + "fields": [ + "roles", + "roles[]", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getGroups", + "documented_path": "/obp/v6.0.0/management/groups", + "fields": [ + "groups", + "groups[]", + "groups[].bank_id", + "groups[].group_description", + "groups[].group_id", + "groups[].group_name", + "groups[].is_enabled", + "groups[].list_of_roles", + "groups[].list_of_roles[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups/GROUP_ID/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getGroupEntitlements", + "documented_path": "/obp/v6.0.0/management/groups/GROUP_ID/entitlements", + "fields": [ + "entitlements", + "entitlements[]", + "entitlements[].bank_id", + "entitlements[].created_by_process", + "entitlements[].entitlement_id", + "entitlements[].group_id", + "entitlements[].role_name", + "entitlements[].user_id", + "entitlements[].username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getGroups", + "documented_path": "/obp/v6.0.0/management/groups", + "fields": [ + "groups", + "groups[]", + "groups[].bank_id", + "groups[].group_description", + "groups[].group_id", + "groups[].group_name", + "groups[].is_enabled", + "groups[].list_of_roles", + "groups[].list_of_roles[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUsers", + "documented_path": "/obp/v6.0.0/users", + "fields": [ + "users", + "users[]", + "users[].agreements", + "users[].agreements[]", + "users[].agreements[].text", + "users[].agreements[].type", + "users[].created_date", + "users[].email", + "users[].email_validated", + "users[].entitlements", + "users[].entitlements.list", + "users[].entitlements.list[]", + "users[].entitlements.list[].bank_id", + "users[].entitlements.list[].entitlement_id", + "users[].entitlements.list[].role_name", + "users[].first_name", + "users[].is_deleted", + "users[].is_locked", + "users[].last_marketing_agreement_signed_date", + "users[].last_name", + "users[].last_used_locale", + "users[].provider", + "users[].provider_id", + "users[].updated_date", + "users[].user_id", + "users[].username", + "users[].views", + "users[].views.list", + "users[].views.list[]", + "users[].views.list[].account_id", + "users[].views.list[].bank_id", + "users[].views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/roles-with-entitlement-counts", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getRolesWithEntitlementCountsAtAllBanks", + "documented_path": "/obp/v6.0.0/management/roles-with-entitlement-counts", + "fields": [ + "roles", + "roles[]", + "roles[].entitlement_count", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-getAllEntitlements", + "documented_path": "/obp/v6.0.0/entitlements", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].entitlement_id", + "list[].role_name", + "list[].user_id", + "list[].username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.1.0-getRoles", + "documented_path": "/obp/v6.0.0/roles", + "fields": [ + "roles", + "roles[]", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionPolicies", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "fields": [ + "retention_policies", + "retention_policies[]", + "retention_policies[].action", + "retention_policies[].archive_days", + "retention_policies[].bank_id", + "retention_policies[].cascade", + "retention_policies[].condition", + "retention_policies[].condition.field", + "retention_policies[].condition.value", + "retention_policies[].created_at", + "retention_policies[].created_by_user_id", + "retention_policies[].date_basis", + "retention_policies[].description", + "retention_policies[].enabled", + "retention_policies[].entity_name", + "retention_policies[].name", + "retention_policies[].requires_approval", + "retention_policies[].resource_type", + "retention_policies[].retain_days", + "retention_policies[].retention_policy_id", + "retention_policies[].updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createRetentionPolicy", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "fields": [ + "action", + "archive_days", + "bank_id", + "cascade", + "condition", + "condition.field", + "condition.value", + "created_at", + "created_by_user_id", + "date_basis", + "description", + "enabled", + "entity_name", + "name", + "requires_approval", + "resource_type", + "retain_days", + "retention_policy_id", + "updated_at" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-deleteRetentionPolicy", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionPolicy", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "fields": [ + "action", + "archive_days", + "bank_id", + "cascade", + "condition", + "condition.field", + "condition.value", + "created_at", + "created_by_user_id", + "date_basis", + "description", + "enabled", + "entity_name", + "name", + "requires_approval", + "resource_type", + "retain_days", + "retention_policy_id", + "updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateRetentionPolicy", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "fields": [ + "action", + "archive_days", + "bank_id", + "cascade", + "condition", + "condition.field", + "condition.value", + "created_at", + "created_by_user_id", + "date_basis", + "description", + "enabled", + "entity_name", + "name", + "requires_approval", + "resource_type", + "retain_days", + "retention_policy_id", + "updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID/preview", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionPolicyPreview", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID/preview", + "fields": [ + "action", + "archive_enabled", + "archive_entries_due_count", + "bank_id", + "can_execute", + "count_is_capped", + "cutoff_date", + "delete_enabled", + "due_count", + "entity_name", + "held_count", + "matched_count", + "max_items_per_run", + "minimum_retain_days", + "oldest_trigger_date", + "requires_approval", + "resource_type", + "retention_policy_id", + "sample_resource_ids", + "sample_resource_ids[]" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID/runs", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createRetentionRun", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID/runs", + "fields": [ + "anonymised_count", + "approval_comment", + "approval_decision", + "approved_by_user_id", + "archived_count", + "bank_id", + "deleted_count", + "ended_at", + "failed_count", + "held_count", + "matched_count", + "message", + "mode", + "requested_at", + "requested_by_user_id", + "retention_policy_id", + "retention_run_id", + "started_at", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionRuns", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs", + "fields": [ + "retention_runs", + "retention_runs[]", + "retention_runs[].anonymised_count", + "retention_runs[].approval_comment", + "retention_runs[].approval_decision", + "retention_runs[].approved_by_user_id", + "retention_runs[].archived_count", + "retention_runs[].bank_id", + "retention_runs[].deleted_count", + "retention_runs[].ended_at", + "retention_runs[].failed_count", + "retention_runs[].held_count", + "retention_runs[].matched_count", + "retention_runs[].message", + "retention_runs[].mode", + "retention_runs[].requested_at", + "retention_runs[].requested_by_user_id", + "retention_runs[].retention_policy_id", + "retention_runs[].retention_run_id", + "retention_runs[].started_at", + "retention_runs[].status" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-archive", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionArchiveEntries", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-archive", + "fields": [ + "retention_archive_entries", + "retention_archive_entries[]", + "retention_archive_entries[].archived_at", + "retention_archive_entries[].bank_id", + "retention_archive_entries[].delete_after", + "retention_archive_entries[].entity_name", + "retention_archive_entries[].has_content", + "retention_archive_entries[].owner_user_id", + "retention_archive_entries[].resource_id", + "retention_archive_entries[].resource_type", + "retention_archive_entries[].retention_archive_id", + "retention_archive_entries[].retention_policy_id", + "retention_archive_entries[].retention_run_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-archive/RETENTION_ARCHIVE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionArchiveEntry", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-archive/RETENTION_ARCHIVE_ID", + "fields": [ + "archived_at", + "bank_id", + "data", + "data.data", + "data.data.status", + "data.data.title", + "data.dynamic_data_id", + "data.entity_name", + "delete_after", + "entity_name", + "has_content", + "owner_user_id", + "resource_id", + "resource_type", + "retention_archive_id", + "retention_policy_id", + "retention_run_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-archive/RETENTION_ARCHIVE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionArchiveEntry", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-archive/RETENTION_ARCHIVE_ID", + "fields": [ + "archived_at", + "bank_id", + "data", + "data.data", + "data.data.status", + "data.data.title", + "data.dynamic_data_id", + "data.entity_name", + "delete_after", + "entity_name", + "has_content", + "owner_user_id", + "resource_id", + "resource_type", + "retention_archive_id", + "retention_policy_id", + "retention_run_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-holds", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionHolds", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-holds", + "fields": [ + "retention_holds", + "retention_holds[]", + "retention_holds[].bank_id", + "retention_holds[].entity_name", + "retention_holds[].is_active", + "retention_holds[].placed_at", + "retention_holds[].placed_by_user_id", + "retention_holds[].reason", + "retention_holds[].resource_id", + "retention_holds[].resource_type", + "retention_holds[].retention_hold_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-holds", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createRetentionHold", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-holds", + "fields": [ + "bank_id", + "entity_name", + "is_active", + "placed_at", + "placed_by_user_id", + "reason", + "resource_id", + "resource_type", + "retention_hold_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-holds/RETENTION_HOLD_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-deleteRetentionHold", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-holds/RETENTION_HOLD_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionPolicies", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "fields": [ + "retention_policies", + "retention_policies[]", + "retention_policies[].action", + "retention_policies[].archive_days", + "retention_policies[].bank_id", + "retention_policies[].cascade", + "retention_policies[].condition", + "retention_policies[].condition.field", + "retention_policies[].condition.value", + "retention_policies[].created_at", + "retention_policies[].created_by_user_id", + "retention_policies[].date_basis", + "retention_policies[].description", + "retention_policies[].enabled", + "retention_policies[].entity_name", + "retention_policies[].name", + "retention_policies[].requires_approval", + "retention_policies[].resource_type", + "retention_policies[].retain_days", + "retention_policies[].retention_policy_id", + "retention_policies[].updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionRuns", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs", + "fields": [ + "retention_runs", + "retention_runs[]", + "retention_runs[].anonymised_count", + "retention_runs[].approval_comment", + "retention_runs[].approval_decision", + "retention_runs[].approved_by_user_id", + "retention_runs[].archived_count", + "retention_runs[].bank_id", + "retention_runs[].deleted_count", + "retention_runs[].ended_at", + "retention_runs[].failed_count", + "retention_runs[].held_count", + "retention_runs[].matched_count", + "retention_runs[].message", + "retention_runs[].mode", + "retention_runs[].requested_at", + "retention_runs[].requested_by_user_id", + "retention_runs[].retention_policy_id", + "retention_runs[].retention_run_id", + "retention_runs[].started_at", + "retention_runs[].status" + ] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs/RETENTION_RUN_ID/approval", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateRetentionRunApproval", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs/RETENTION_RUN_ID/approval", + "fields": [ + "anonymised_count", + "approval_comment", + "approval_decision", + "approved_by_user_id", + "archived_count", + "bank_id", + "deleted_count", + "ended_at", + "failed_count", + "held_count", + "matched_count", + "message", + "mode", + "requested_at", + "requested_by_user_id", + "retention_policy_id", + "retention_run_id", + "started_at", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs/RETENTION_RUN_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionRun", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs/RETENTION_RUN_ID", + "fields": [ + "anonymised_count", + "approval_comment", + "approval_decision", + "approved_by_user_id", + "archived_count", + "bank_id", + "deleted_count", + "ended_at", + "failed_count", + "held_count", + "matched_count", + "message", + "mode", + "requested_at", + "requested_by_user_id", + "retention_policy_id", + "retention_run_id", + "started_at", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs/RETENTION_RUN_ID/items", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionRunItems", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs/RETENTION_RUN_ID/items", + "fields": [ + "retention_run_items", + "retention_run_items[]", + "retention_run_items[].action", + "retention_run_items[].bank_id", + "retention_run_items[].disposed_at", + "retention_run_items[].owner_user_id", + "retention_run_items[].parent_resource_id", + "retention_run_items[].parent_resource_type", + "retention_run_items[].resource_id", + "retention_run_items[].resource_type", + "retention_run_items[].retention_archive_id", + "retention_run_items[].retention_policy_id", + "retention_run_items[].retention_run_id", + "retention_run_items[].retention_run_item_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/aggregate-metrics", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAggregateMetrics", + "documented_path": "/obp/v6.0.0/management/aggregate-metrics", + "fields": [ + "average_response_time", + "consent_call_count", + "count", + "distinct_consent_count", + "distinct_consumer_count", + "distinct_user_count", + "maximum_response_time", + "minimum_response_time" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUsers", + "documented_path": "/obp/v6.0.0/users", + "fields": [ + "users", + "users[]", + "users[].agreements", + "users[].agreements[]", + "users[].agreements[].text", + "users[].agreements[].type", + "users[].created_date", + "users[].email", + "users[].email_validated", + "users[].entitlements", + "users[].entitlements.list", + "users[].entitlements.list[]", + "users[].entitlements.list[].bank_id", + "users[].entitlements.list[].entitlement_id", + "users[].entitlements.list[].role_name", + "users[].first_name", + "users[].is_deleted", + "users[].is_locked", + "users[].last_marketing_agreement_signed_date", + "users[].last_name", + "users[].last_used_locale", + "users[].provider", + "users[].provider_id", + "users[].updated_date", + "users[].user_id", + "users[].username", + "users[].views", + "users[].views.list", + "users[].views.list[]", + "users[].views.list[].account_id", + "users[].views.list[].bank_id", + "users[].views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/consumers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getConsumers", + "documented_path": "/obp/v7.0.0/management/consumers", + "fields": [ + "consumers", + "consumers[]", + "consumers[].app_name", + "consumers[].app_type", + "consumers[].certificate_pem", + "consumers[].company", + "consumers[].consumer_id", + "consumers[].created", + "consumers[].created_by_user", + "consumers[].created_by_user.email", + "consumers[].created_by_user.provider", + "consumers[].created_by_user.provider_id", + "consumers[].created_by_user.user_id", + "consumers[].created_by_user.username", + "consumers[].description", + "consumers[].developer_email", + "consumers[].enabled", + "consumers[].logo_url", + "consumers[].redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/aggregate-metrics", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAggregateMetrics", + "documented_path": "/obp/v6.0.0/management/aggregate-metrics", + "fields": [ + "average_response_time", + "consent_call_count", + "count", + "distinct_consent_count", + "distinct_consumer_count", + "distinct_user_count", + "maximum_response_time", + "minimum_response_time" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/metrics/top-consumers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getTopConsumers", + "documented_path": "/obp/v7.0.0/management/metrics/top-consumers", + "fields": [ + "top_consumers", + "top_consumers[]", + "top_consumers[].app_name", + "top_consumers[].consumer_id", + "top_consumers[].count", + "top_consumers[].developer_email" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/aggregate-metrics", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAggregateMetrics", + "documented_path": "/obp/v6.0.0/management/aggregate-metrics", + "fields": [ + "average_response_time", + "consent_call_count", + "count", + "distinct_consent_count", + "distinct_consumer_count", + "distinct_user_count", + "maximum_response_time", + "minimum_response_time" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/metrics/top-users", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getTopUsers", + "documented_path": "/obp/v7.0.0/management/metrics/top-users", + "fields": [ + "top_users", + "top_users[]", + "top_users[].count", + "top_users[].user_id", + "top_users[].username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUsers", + "documented_path": "/obp/v6.0.0/users", + "fields": [ + "users", + "users[]", + "users[].agreements", + "users[].agreements[]", + "users[].agreements[].text", + "users[].agreements[].type", + "users[].created_date", + "users[].email", + "users[].email_validated", + "users[].entitlements", + "users[].entitlements.list", + "users[].entitlements.list[]", + "users[].entitlements.list[].bank_id", + "users[].entitlements.list[].entitlement_id", + "users[].entitlements.list[].role_name", + "users[].first_name", + "users[].is_deleted", + "users[].is_locked", + "users[].last_marketing_agreement_signed_date", + "users[].last_name", + "users[].last_used_locale", + "users[].provider", + "users[].provider_id", + "users[].updated_date", + "users[].user_id", + "users[].username", + "users[].views", + "users[].views.list", + "users[].views.list[]", + "users[].views.list[].account_id", + "users[].views.list[].bank_id", + "users[].views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/cache/config", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCacheConfig", + "documented_path": "/obp/v6.0.0/system/cache/config", + "fields": [ + "environment", + "global_prefix", + "in_memory_status", + "in_memory_status.available", + "in_memory_status.current_size", + "instance_id", + "redis_status", + "redis_status.available", + "redis_status.port", + "redis_status.url", + "redis_status.use_ssl" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/cache/info", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCacheInfo", + "documented_path": "/obp/v6.0.0/system/cache/info", + "fields": [ + "namespaces", + "namespaces[]", + "namespaces[].category", + "namespaces[].current_version", + "namespaces[].description", + "namespaces[].key_count", + "namespaces[].namespace_id", + "namespaces[].prefix", + "namespaces[].storage_location", + "namespaces[].ttl_info", + "redis_available", + "total_keys" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/config-props", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getConfigProps", + "documented_path": "/obp/v6.0.0/management/config-props", + "fields": [ + "config_props", + "config_props[]", + "config_props[].name", + "config_props[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/database/pool", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getDatabasePoolInfo", + "documented_path": "/obp/v6.0.0/system/database/pool", + "fields": [ + "active_connections", + "connection_timeout_ms", + "idle_connections", + "idle_timeout_ms", + "keepalive_time_ms", + "max_lifetime_ms", + "maximum_pool_size", + "minimum_idle", + "pool_name", + "threads_awaiting_connection", + "total_connections" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getAllApiCollections", + "documented_path": "/obp/v6.0.0/management/api-collections", + "fields": [ + "api_collections", + "api_collections[]", + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description", + "api_collections[].is_sharable", + "api_collections[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections/featured", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getFeaturedApiCollectionsAdmin", + "documented_path": "/obp/v6.0.0/management/api-collections/featured", + "fields": [ + "featured_api_collections", + "featured_api_collections[]", + "featured_api_collections[].api_collection_id", + "featured_api_collections[].featured_api_collection_id", + "featured_api_collections[].sort_order" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getAllApiCollections", + "documented_path": "/obp/v6.0.0/management/api-collections", + "fields": [ + "api_collections", + "api_collections[]", + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description", + "api_collections[].is_sharable", + "api_collections[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections/featured", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getFeaturedApiCollectionsAdmin", + "documented_path": "/obp/v6.0.0/management/api-collections/featured", + "fields": [ + "featured_api_collections", + "featured_api_collections[]", + "featured_api_collections[].api_collection_id", + "featured_api_collections[].featured_api_collection_id", + "featured_api_collections[].sort_order" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getAllApiCollections", + "documented_path": "/obp/v6.0.0/management/api-collections", + "fields": [ + "api_collections", + "api_collections[]", + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description", + "api_collections[].is_sharable", + "api_collections[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections/featured", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getFeaturedApiCollectionsAdmin", + "documented_path": "/obp/v6.0.0/management/api-collections/featured", + "fields": [ + "featured_api_collections", + "featured_api_collections[]", + "featured_api_collections[].api_collection_id", + "featured_api_collections[].featured_api_collection_id", + "featured_api_collections[].sort_order" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getAllApiCollections", + "documented_path": "/obp/v6.0.0/management/api-collections", + "fields": [ + "api_collections", + "api_collections[]", + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description", + "api_collections[].is_sharable", + "api_collections[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/api-collections/featured", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getFeaturedApiCollectionsAdmin", + "documented_path": "/obp/v6.0.0/management/api-collections/featured", + "fields": [ + "featured_api_collections", + "featured_api_collections[]", + "featured_api_collections[].api_collection_id", + "featured_api_collections[].featured_api_collection_id", + "featured_api_collections[].sort_order" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/features", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getFeatures", + "documented_path": "/obp/v6.0.0/features", + "fields": [ + "allow_abac_account_access", + "allow_account_deletion", + "allow_account_firehose", + "allow_customer_firehose", + "allow_dauth", + "allow_direct_login", + "allow_gateway_login", + "allow_just_in_time_entitlements", + "allow_oauth2_login", + "allow_public_views", + "allow_sandbox_account_creation", + "allow_sandbox_data_import" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/log-cache/all", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-logCacheAllEndpoint", + "documented_path": "/obp/v6.0.0/system/log-cache/all", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/log-cache/debug", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-logCacheDebugEndpoint", + "documented_path": "/obp/v6.0.0/system/log-cache/debug", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/log-cache/error", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-logCacheErrorEndpoint", + "documented_path": "/obp/v6.0.0/system/log-cache/error", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/log-cache/info", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-logCacheInfoEndpoint", + "documented_path": "/obp/v6.0.0/system/log-cache/info", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/log-cache/warning", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-logCacheWarningEndpoint", + "documented_path": "/obp/v6.0.0/system/log-cache/warning", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/migrations", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getMigrations", + "documented_path": "/obp/v6.0.0/system/migrations", + "fields": [ + "migration_script_logs", + "migration_script_logs[]", + "migration_script_logs[].commit_id", + "migration_script_logs[].created_at", + "migration_script_logs[].duration_in_ms", + "migration_script_logs[].end_date", + "migration_script_logs[].is_successful", + "migration_script_logs[].migration_script_log_id", + "migration_script_logs[].name", + "migration_script_logs[].remark", + "migration_script_logs[].start_date", + "migration_script_logs[].updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/ip-penalties", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getIpPenalties", + "documented_path": "/obp/v7.0.0/management/ip-penalties", + "fields": [ + "ip_penalties", + "ip_penalties[]", + "ip_penalties[].created_at", + "ip_penalties[].created_by_user_id", + "ip_penalties[].expires_at", + "ip_penalties[].ip_address", + "ip_penalties[].per_minute_limit", + "ip_penalties[].reason" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/ip-penalties", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createIpPenalty", + "documented_path": "/obp/v7.0.0/management/ip-penalties", + "fields": [ + "created_at", + "created_by_user_id", + "expires_at", + "ip_address", + "per_minute_limit", + "reason" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/ip-penalties/IP_ADDRESS", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-deleteIpPenalty", + "documented_path": "/obp/v7.0.0/management/ip-penalties/IP_ADDRESS", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/rate-limiter-config", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRateLimiterConfig", + "documented_path": "/obp/v7.0.0/management/rate-limiter-config", + "fields": [ + "rate_limiters", + "rate_limiters[]", + "rate_limiters[].enabled", + "rate_limiters[].error_code", + "rate_limiters[].keyed_by", + "rate_limiters[].limits", + "rate_limiters[].limits[]", + "rate_limiters[].limits[].covers", + "rate_limiters[].limits[].global_per_hour", + "rate_limiters[].limits[].mode", + "rate_limiters[].limits[].per_day", + "rate_limiters[].limits[].per_hour", + "rate_limiters[].limits[].per_minute", + "rate_limiters[].limits[].scope", + "rate_limiters[].mode", + "rate_limiters[].name", + "rate_limiters[].order", + "rate_limiters[].props_prefix", + "rate_limiters[].runs" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/rate-limits", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getConsumerRateLimits", + "documented_path": "/obp/v7.0.0/management/rate-limits", + "fields": [ + "rate_limits", + "rate_limits[]", + "rate_limits[].consumer_id", + "rate_limits[].consumer_name", + "rate_limits[].created_at", + "rate_limits[].from_date", + "rate_limits[].is_active", + "rate_limits[].per_day_call_limit", + "rate_limits[].per_hour_call_limit", + "rate_limits[].per_minute_call_limit", + "rate_limits[].per_month_call_limit", + "rate_limits[].per_second_call_limit", + "rate_limits[].per_week_call_limit", + "rate_limits[].rate_limiting_id", + "rate_limits[].to_date", + "rate_limits[].updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/system/scheduler/job-locks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getSchedulerJobs", + "documented_path": "/obp/v7.0.0/management/system/scheduler/job-locks", + "fields": [ + "count", + "jobs", + "jobs[]", + "jobs[].age_seconds", + "jobs[].api_instance_id", + "jobs[].job_id", + "jobs[].name", + "jobs[].started_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/system/scheduler/job-locks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getSchedulerJobs", + "documented_path": "/obp/v7.0.0/management/system/scheduler/job-locks", + "fields": [ + "count", + "jobs", + "jobs[]", + "jobs[].age_seconds", + "jobs[].api_instance_id", + "jobs[].job_id", + "jobs[].name", + "jobs[].started_at" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/system/scheduler/job-locks/JOB_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-deleteSchedulerJob", + "documented_path": "/obp/v7.0.0/management/system/scheduler/job-locks/JOB_ID", + "fields": [] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/self-test-emails", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createTestEmail", + "documented_path": "/obp/v7.0.0/management/self-test-emails", + "fields": [ + "from", + "message_id", + "subject", + "to" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/signal-channels/stats", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSignalStats", + "documented_path": "/obp/v6.0.0/signal-channels/stats", + "fields": [ + "channels", + "channels[]", + "channels[].channel_name", + "channels[].message_count", + "channels[].ttl_seconds", + "total_channels", + "total_messages" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/signal-channels", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSignalChannels", + "documented_path": "/obp/v6.0.0/signal-channels", + "fields": [ + "channels", + "channels[]", + "channels[].channel_name", + "channels[].message_count", + "channels[].ttl_seconds" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/signal-channels/CHANNEL_NAME", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-deleteSignalChannel", + "documented_path": "/obp/v6.0.0/signal-channels/CHANNEL_NAME", + "fields": [ + "channel_name", + "deleted" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/signal-channels/CHANNEL_NAME/messages", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSignalMessages", + "documented_path": "/obp/v6.0.0/signal-channels/CHANNEL_NAME/messages", + "fields": [ + "channel_name", + "has_more", + "latest_sequence", + "messages", + "messages[]", + "messages[].channel_name", + "messages[].message_id", + "messages[].message_type", + "messages[].payload", + "messages[].payload.agent_name", + "messages[].payload.capabilities", + "messages[].payload.capabilities[]", + "messages[].payload.capabilities[].s", + "messages[].sender_consumer_id", + "messages[].sender_user_id", + "messages[].sequence", + "messages[].timestamp", + "next_after_sequence", + "total_count", + "visible_count" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/signal-channels/CHANNEL_NAME/messages", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-publishSignalMessage", + "documented_path": "/obp/v6.0.0/signal-channels/CHANNEL_NAME/messages", + "fields": [ + "channel_message_count", + "channel_name", + "message_id", + "sequence", + "timestamp" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/webui-props", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getWebUiProps", + "documented_path": "/obp/v6.0.0/webui-props", + "fields": [ + "webui_props", + "webui_props[]", + "webui_props[].name", + "webui_props[].source", + "webui_props[].value", + "webui_props[].web_ui_props_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/webui-props", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getWebUiProps", + "documented_path": "/obp/v6.0.0/webui-props", + "fields": [ + "webui_props", + "webui_props[]", + "webui_props[].name", + "webui_props[].source", + "webui_props[].value", + "webui_props[].web_ui_props_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/webui-props", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getWebUiProps", + "documented_path": "/obp/v6.0.0/webui-props", + "fields": [ + "webui_props", + "webui_props[]", + "webui_props[].name", + "webui_props[].source", + "webui_props[].value", + "webui_props[].web_ui_props_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/telemetry", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getTelemetry", + "documented_path": "/obp/v7.0.0/management/telemetry", + "fields": [ + "api_instance_id", + "git_commit", + "meters", + "meters[]", + "meters[].measurements", + "meters[].name", + "meters[].tags", + "meters[].type", + "port", + "port.enabled", + "port.path", + "port.port" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/traffic/top-callers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getTrafficSources", + "documented_path": "/obp/v7.0.0/management/traffic/top-callers", + "fields": [ + "addresses", + "addresses[]", + "addresses[].consumer_ids", + "addresses[].consumer_ids[]", + "addresses[].endpoints", + "addresses[].endpoints[]", + "addresses[].error", + "addresses[].first_seen", + "addresses[].ip_address", + "addresses[].last_seen", + "addresses[].refused", + "addresses[].requests", + "addresses[].status_2xx", + "addresses[].status_4xx", + "addresses[].status_5xx", + "addresses[].unmatched", + "api_instance_id", + "callers_and_endpoints", + "callers_and_endpoints[]", + "callers_and_endpoints[].caller", + "callers_and_endpoints[].caller_kind", + "callers_and_endpoints[].endpoint", + "callers_and_endpoints[].error", + "callers_and_endpoints[].last_seen", + "callers_and_endpoints[].max_duration_ms", + "callers_and_endpoints[].mean_duration_ms", + "callers_and_endpoints[].refused", + "callers_and_endpoints[].requests", + "callers_and_endpoints[].status_2xx", + "callers_and_endpoints[].status_4xx", + "callers_and_endpoints[].status_5xx", + "consumers", + "consumers[]", + "consumers[].application_name", + "consumers[].consumer_id", + "consumers[].endpoints", + "consumers[].endpoints[]", + "consumers[].error", + "consumers[].first_seen", + "consumers[].last_ip_address", + "consumers[].last_seen", + "consumers[].refused", + "consumers[].requests", + "consumers[].status_2xx", + "consumers[].status_4xx", + "consumers[].status_5xx", + "consumers[].unmatched", + "window_minutes" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/user-invitations", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getUserInvitations", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/user-invitations", + "fields": [ + "company", + "country", + "email", + "first_name", + "last_name", + "purpose", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/entitlement-requests", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getEntitlementRequestsForCurrentUser", + "documented_path": "/obp/v6.0.0/my/entitlement-requests", + "fields": [ + "entitlement_requests", + "entitlement_requests[]", + "entitlement_requests[].bank_id", + "entitlement_requests[].created", + "entitlement_requests[].entitlement_request_id", + "entitlement_requests[].role_name", + "entitlement_requests[].user", + "entitlement_requests[].user.email", + "entitlement_requests[].user.entitlements", + "entitlement_requests[].user.entitlements.list", + "entitlement_requests[].user.entitlements.list[]", + "entitlement_requests[].user.entitlements.list[].bank_id", + "entitlement_requests[].user.entitlements.list[].entitlement_id", + "entitlement_requests[].user.entitlements.list[].role_name", + "entitlement_requests[].user.provider", + "entitlement_requests[].user.provider_id", + "entitlement_requests[].user.user_id", + "entitlement_requests[].user.username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/consents", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getMyConsents", + "documented_path": "/obp/v6.0.0/my/consents", + "fields": [ + "consents", + "consents[]", + "consents[].api_standard", + "consents[].api_version", + "consents[].consent_id", + "consents[].consent_reference_id", + "consents[].consumer_id", + "consents[].created_by_user_id", + "consents[].jwt", + "consents[].jwt_expires_at", + "consents[].jwt_payload", + "consents[].last_action_date", + "consents[].last_usage_date", + "consents[].status" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/my/consents/CONSENT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-revokeMyConsent", + "documented_path": "/obp/v6.0.0/my/consents/CONSENT_ID", + "fields": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/consumers/CONSUMER_ID/scopes", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getScopes", + "documented_path": "/obp/v5.1.0/consumers/CONSUMER_ID/scopes", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].role_name", + "list[].scope_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/consumers/current", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCurrentConsumer", + "documented_path": "/obp/v6.0.0/consumers/current", + "fields": [ + "active_rate_limits", + "active_rate_limits.active_at_date", + "active_rate_limits.active_per_day_rate_limit", + "active_rate_limits.active_per_hour_rate_limit", + "active_rate_limits.active_per_minute_rate_limit", + "active_rate_limits.active_per_month_rate_limit", + "active_rate_limits.active_per_second_rate_limit", + "active_rate_limits.active_per_week_rate_limit", + "active_rate_limits.considered_rate_limit_ids", + "active_rate_limits.considered_rate_limit_ids[]", + "app_name", + "app_type", + "call_counters", + "call_counters.per_day", + "call_counters.per_day.calls_made", + "call_counters.per_day.reset_in_seconds", + "call_counters.per_day.status", + "call_counters.per_hour", + "call_counters.per_hour.calls_made", + "call_counters.per_hour.reset_in_seconds", + "call_counters.per_hour.status", + "call_counters.per_minute", + "call_counters.per_minute.calls_made", + "call_counters.per_minute.reset_in_seconds", + "call_counters.per_minute.status", + "call_counters.per_month", + "call_counters.per_month.calls_made", + "call_counters.per_month.reset_in_seconds", + "call_counters.per_month.status", + "call_counters.per_second", + "call_counters.per_second.calls_made", + "call_counters.per_second.reset_in_seconds", + "call_counters.per_second.status", + "call_counters.per_week", + "call_counters.per_week.calls_made", + "call_counters.per_week.reset_in_seconds", + "call_counters.per_week.status", + "consumer_id", + "description" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getEntitlementsForCurrentUser", + "documented_path": "/obp/v6.0.0/my/entitlements", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].entitlement_id", + "list[].role_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.1.0-getRoles", + "documented_path": "/obp/v6.0.0/roles", + "fields": [ + "roles", + "roles[]", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/USER_ID/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.0.0-addEntitlement", + "documented_path": "/obp/v6.0.0/users/USER_ID/entitlements", + "fields": [ + "bank_id", + "entitlement_id", + "role_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUsers", + "documented_path": "/obp/v6.0.0/users", + "fields": [ + "users", + "users[]", + "users[].agreements", + "users[].agreements[]", + "users[].agreements[].text", + "users[].agreements[].type", + "users[].created_date", + "users[].email", + "users[].email_validated", + "users[].entitlements", + "users[].entitlements.list", + "users[].entitlements.list[]", + "users[].entitlements.list[].bank_id", + "users[].entitlements.list[].entitlement_id", + "users[].entitlements.list[].role_name", + "users[].first_name", + "users[].is_deleted", + "users[].is_locked", + "users[].last_marketing_agreement_signed_date", + "users[].last_name", + "users[].last_used_locale", + "users[].provider", + "users[].provider_id", + "users[].updated_date", + "users[].user_id", + "users[].username", + "users[].views", + "users[].views.list", + "users[].views.list[]", + "users[].views.list[].account_id", + "users[].views.list[].bank_id", + "users[].views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/providers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getProviders", + "documented_path": "/obp/v6.0.0/providers", + "fields": [ + "providers", + "providers[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/roles", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.1.0-getRoles", + "documented_path": "/obp/v6.0.0/roles", + "fields": [ + "roles", + "roles[]", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUsers", + "documented_path": "/obp/v6.0.0/users", + "fields": [ + "users", + "users[]", + "users[].agreements", + "users[].agreements[]", + "users[].agreements[].text", + "users[].agreements[].type", + "users[].created_date", + "users[].email", + "users[].email_validated", + "users[].entitlements", + "users[].entitlements.list", + "users[].entitlements.list[]", + "users[].entitlements.list[].bank_id", + "users[].entitlements.list[].entitlement_id", + "users[].entitlements.list[].role_name", + "users[].first_name", + "users[].is_deleted", + "users[].is_locked", + "users[].last_marketing_agreement_signed_date", + "users[].last_name", + "users[].last_used_locale", + "users[].provider", + "users[].provider_id", + "users[].updated_date", + "users[].user_id", + "users[].username", + "users[].views", + "users[].views.list", + "users[].views.list[]", + "users[].views.list[].account_id", + "users[].views.list[].bank_id", + "users[].views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/provider/PROVIDER/username/USERNAME", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getUserByProviderAndUsername", + "documented_path": "/obp/v6.0.0/users/provider/PROVIDER/username/USERNAME", + "fields": [ + "agreements", + "agreements[]", + "agreements[].text", + "agreements[].type", + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "first_name", + "is_deleted", + "is_locked", + "last_marketing_agreement_signed_date", + "last_name", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getUserLockStatus", + "documented_path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "fields": [ + "bad_attempts_since_last_success_or_reset", + "last_failure_date", + "username" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/locks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-lockUserByProviderAndUsername", + "documented_path": "/obp/v6.0.0/users/PROVIDER/USERNAME/locks", + "fields": [ + "last_lock_date", + "type_of_lock", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/provider/PROVIDER/username/USERNAME", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getUserByProviderAndUsername", + "documented_path": "/obp/v6.0.0/users/provider/PROVIDER/username/USERNAME", + "fields": [ + "agreements", + "agreements[]", + "agreements[].text", + "agreements[].type", + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "first_name", + "is_deleted", + "is_locked", + "last_marketing_agreement_signed_date", + "last_name", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getUserLockStatus", + "documented_path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "fields": [ + "bad_attempts_since_last_success_or_reset", + "last_failure_date", + "username" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-unlockUserByProviderAndUsername", + "documented_path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "fields": [ + "bad_attempts_since_last_success_or_reset", + "last_failure_date", + "username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/provider/PROVIDER/username/USERNAME", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getUserByProviderAndUsername", + "documented_path": "/obp/v6.0.0/users/provider/PROVIDER/username/USERNAME", + "fields": [ + "agreements", + "agreements[]", + "agreements[].text", + "agreements[].type", + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "first_name", + "is_deleted", + "is_locked", + "last_marketing_agreement_signed_date", + "last_name", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/users/user-id/USER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getUserByUserId", + "documented_path": "/obp/v7.0.0/users/user-id/USER_ID", + "fields": [ + "agreements", + "agreements[]", + "agreements[].text", + "agreements[].type", + "created_date", + "email", + "email_validated", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "first_name", + "is_deleted", + "is_locked", + "last_activity_date", + "last_marketing_agreement_signed_date", + "last_name", + "last_used_locale", + "mobile_phone_number", + "mobile_phone_number_is_validated", + "mobile_phone_number_validated_date", + "provider", + "provider_id", + "recent_operation_ids", + "recent_operation_ids[]", + "updated_date", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getUserLockStatus", + "documented_path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "fields": [ + "bad_attempts_since_last_success_or_reset", + "last_failure_date", + "username" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/locks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-lockUserByProviderAndUsername", + "documented_path": "/obp/v6.0.0/users/PROVIDER/USERNAME/locks", + "fields": [ + "last_lock_date", + "type_of_lock", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user-id/USER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUserByUserId", + "documented_path": "/obp/v6.0.0/users/user-id/USER_ID", + "fields": [ + "agreements", + "agreements[]", + "agreements[].text", + "agreements[].type", + "created_date", + "email", + "email_validated", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "first_name", + "is_deleted", + "is_locked", + "last_activity_date", + "last_marketing_agreement_signed_date", + "last_name", + "last_used_locale", + "provider", + "provider_id", + "recent_operation_ids", + "recent_operation_ids[]", + "updated_date", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/user/reset-password-url", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-resetPasswordUrl", + "documented_path": "/obp/v6.0.0/management/user/reset-password-url", + "fields": [ + "status", + "to" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user-id/USER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUserByUserId", + "documented_path": "/obp/v6.0.0/users/user-id/USER_ID", + "fields": [ + "agreements", + "agreements[]", + "agreements[].text", + "agreements[].type", + "created_date", + "email", + "email_validated", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "first_name", + "is_deleted", + "is_locked", + "last_activity_date", + "last_marketing_agreement_signed_date", + "last_name", + "last_used_locale", + "provider", + "provider_id", + "recent_operation_ids", + "recent_operation_ids[]", + "updated_date", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getUserLockStatus", + "documented_path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "fields": [ + "bad_attempts_since_last_success_or_reset", + "last_failure_date", + "username" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-unlockUserByProviderAndUsername", + "documented_path": "/obp/v6.0.0/users/PROVIDER/USERNAME/lock-status", + "fields": [ + "bad_attempts_since_last_success_or_reset", + "last_failure_date", + "username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user-id/USER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUserByUserId", + "documented_path": "/obp/v6.0.0/users/user-id/USER_ID", + "fields": [ + "agreements", + "agreements[]", + "agreements[].text", + "agreements[].type", + "created_date", + "email", + "email_validated", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "first_name", + "is_deleted", + "is_locked", + "last_activity_date", + "last_marketing_agreement_signed_date", + "last_name", + "last_used_locale", + "provider", + "provider_id", + "recent_operation_ids", + "recent_operation_ids[]", + "updated_date", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/user-id/USER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUserByUserId", + "documented_path": "/obp/v6.0.0/users/user-id/USER_ID", + "fields": [ + "agreements", + "agreements[]", + "agreements[].text", + "agreements[].type", + "created_date", + "email", + "email_validated", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "first_name", + "is_deleted", + "is_locked", + "last_activity_date", + "last_marketing_agreement_signed_date", + "last_name", + "last_used_locale", + "provider", + "provider_id", + "recent_operation_ids", + "recent_operation_ids[]", + "updated_date", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/users/validation-emails", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createValidationEmail", + "documented_path": "/obp/v7.0.0/users/validation-emails", + "fields": [ + "message" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/features", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getFeatures", + "documented_path": "/obp/v6.0.0/features", + "fields": [ + "allow_abac_account_access", + "allow_account_deletion", + "allow_account_firehose", + "allow_customer_firehose", + "allow_dauth", + "allow_direct_login", + "allow_gateway_login", + "allow_just_in_time_entitlements", + "allow_oauth2_login", + "allow_public_views", + "allow_sandbox_account_creation", + "allow_sandbox_data_import" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/current", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCurrentUser", + "documented_path": "/obp/v6.0.0/users/current", + "fields": [ + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityDefinitions", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[].auth_mode", + "dynamic_entities[].bank_id", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.description", + "dynamic_entities[].schema.properties.language.example", + "dynamic_entities[].schema.properties.language.maxLength", + "dynamic_entities[].schema.properties.language.minLength", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.description", + "dynamic_entities[].schema.properties.theme.example", + "dynamic_entities[].schema.properties.theme.indexed", + "dynamic_entities[].schema.properties.theme.maxLength", + "dynamic_entities[].schema.properties.theme.minLength", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/abac-rules", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createAbacRule", + "documented_path": "/obp/v6.0.0/management/abac-rules", + "fields": [ + "abac_rule_id", + "created_by_user_id", + "description", + "is_active", + "policy", + "rule_code", + "rule_name", + "updated_by_user_id" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/abac-rules/ABAC_RULE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-updateAbacRule", + "documented_path": "/obp/v6.0.0/management/abac-rules/ABAC_RULE_ID", + "fields": [ + "abac_rule_id", + "created_by_user_id", + "description", + "is_active", + "policy", + "rule_code", + "rule_name", + "updated_by_user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/abac-rules/ABAC_RULE_ID/execute", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-executeAbacRule", + "documented_path": "/obp/v6.0.0/management/abac-rules/ABAC_RULE_ID/execute", + "fields": [ + "result" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/aggregate-metrics", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAggregateMetrics", + "documented_path": "/obp/v6.0.0/management/aggregate-metrics", + "fields": [ + "average_response_time", + "consent_call_count", + "count", + "distinct_consent_count", + "distinct_consumer_count", + "distinct_user_count", + "maximum_response_time", + "minimum_response_time" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/api-collections", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createMyApiCollection", + "documented_path": "/obp/v6.0.0/my/api-collections", + "fields": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable", + "user_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteMyApiCollection", + "documented_path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "fields": [ + "value" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-updateMyApiCollection", + "documented_path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "fields": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable", + "user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createMyApiCollectionEndpointById", + "documented_path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints", + "fields": [ + "api_collection_endpoint_id", + "api_collection_id", + "operation_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/my/consents/IMPLICIT", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-createConsent", + "documented_path": "/obp/v5.1.0/my/consents/IMPLICIT", + "fields": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/users/current/consumers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-getConsumersForCurrentUser", + "documented_path": "/obp/v6.0.0/management/users/current/consumers", + "fields": [ + "consumers", + "consumers[]", + "consumers[].app_name", + "consumers[].app_type", + "consumers[].consumer_id", + "consumers[].created", + "consumers[].created_by_user", + "consumers[].created_by_user.email", + "consumers[].created_by_user.provider", + "consumers[].created_by_user.provider_id", + "consumers[].created_by_user.user_id", + "consumers[].created_by_user.username", + "consumers[].description", + "consumers[].developer_email", + "consumers[].enabled", + "consumers[].redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/accounts", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-corePrivateAccountsAllBanks", + "documented_path": "/obp/v6.0.0/my/accounts", + "fields": [ + "accounts", + "accounts[]", + "accounts[].account_routings", + "accounts[].account_routings[]", + "accounts[].account_routings[].address", + "accounts[].account_routings[].scheme", + "accounts[].account_type", + "accounts[].bank_id", + "accounts[].id", + "accounts[].label", + "accounts[].views", + "accounts[].views[]", + "accounts[].views[].description", + "accounts[].views[].id", + "accounts[].views[].is_public", + "accounts[].views[].short_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getEntitlementsForCurrentUser", + "documented_path": "/obp/v6.0.0/my/entitlements", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].entitlement_id", + "list[].role_name" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-answerConsentChallenge", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge", + "fields": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/cache/namespaces/invalidate", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-invalidateCacheNamespace", + "documented_path": "/obp/v6.0.0/management/cache/namespaces/invalidate", + "fields": [ + "namespace_id", + "new_version", + "old_version", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/connector/metrics", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.2.0-getConnectorMetrics", + "documented_path": "/obp/v6.0.0/management/connector/metrics", + "fields": [ + "metrics", + "metrics[]", + "metrics[].connector_name", + "metrics[].correlation_id", + "metrics[].date", + "metrics[].duration", + "metrics[].function_name" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createSystemChatRoom", + "documented_path": "/obp/v6.0.0/chat-rooms", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-updateBankLevelDynamicEndpointHost", + "documented_path": "/obp/v6.0.0/management/banks/BANK_ID/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host", + "fields": [ + "host" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-updateDynamicEndpointHost", + "documented_path": "/obp/v6.0.0/management/dynamic-endpoints/DYNAMIC_ENDPOINT_ID/host", + "fields": [ + "host" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-deleteDynamicEntityDefinition", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID", + "fields": [] + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/cascade/DYNAMIC_ENTITY_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-deleteDynamicEntityDefinitionCascade", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/cascade/DYNAMIC_ENTITY_ID", + "fields": [] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/backup", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-backupDynamicEntityDefinition", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID/backup", + "fields": [ + "auth_mode", + "bank_id", + "dynamic_entity_id", + "entity_name", + "has_community_access", + "has_personal_entity", + "has_public_access", + "personal_requires_role", + "schema", + "schema.description", + "schema.properties", + "schema.properties.language", + "schema.properties.language.description", + "schema.properties.language.example", + "schema.properties.language.maxLength", + "schema.properties.language.minLength", + "schema.properties.language.type", + "schema.properties.theme", + "schema.properties.theme.description", + "schema.properties.theme.example", + "schema.properties.theme.indexed", + "schema.properties.theme.maxLength", + "schema.properties.theme.minLength", + "schema.properties.theme.type", + "schema.required", + "schema.required[]", + "schema.required[].s", + "use_row_level_access", + "user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/api-collections/featured", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createFeaturedApiCollection", + "documented_path": "/obp/v6.0.0/management/api-collections/featured", + "fields": [ + "api_collection_id", + "featured_api_collection_id", + "sort_order" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/api-collections/featured/API_COLLECTION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-deleteFeaturedApiCollection", + "documented_path": "/obp/v6.0.0/management/api-collections/featured/API_COLLECTION_ID", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/api-collections/featured/API_COLLECTION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-updateFeaturedApiCollection", + "documented_path": "/obp/v6.0.0/management/api-collections/featured/API_COLLECTION_ID", + "fields": [ + "api_collection_id", + "featured_api_collection_id", + "sort_order" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/files/FILE_ID/content", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getFileContent", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/files/FILE_ID/content", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/connector-methods", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getAllConnectorMethods", + "documented_path": "/obp/v6.0.0/management/connector-methods", + "fields": [ + "connectors_methods", + "connectors_methods[]", + "connectors_methods[].connector_method_id", + "connectors_methods[].method_body", + "connectors_methods[].method_name", + "connectors_methods[].programming_lang" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/method_routings", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-getMethodRoutings", + "documented_path": "/obp/v5.1.0/management/method_routings", + "fields": [ + "method_routings", + "method_routings[]", + "method_routings[].bank_id_pattern", + "method_routings[].connector_name", + "method_routings[].is_bank_id_exact_match", + "method_routings[].method_name", + "method_routings[].method_routing_id", + "method_routings[].parameters", + "method_routings[].parameters[]", + "method_routings[].parameters[].key", + "method_routings[].parameters[].value" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/management/method_routings", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-createMethodRouting", + "documented_path": "/obp/v5.1.0/management/method_routings", + "fields": [ + "bank_id_pattern", + "connector_name", + "is_bank_id_exact_match", + "method_name", + "method_routing_id", + "parameters", + "parameters[]", + "parameters[].key", + "parameters[].value" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/management/method_routings/METHOD_ROUTING_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-deleteMethodRouting", + "documented_path": "/obp/v5.1.0/management/method_routings/METHOD_ROUTING_ID", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v5.1.0/management/method_routings/METHOD_ROUTING_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-updateMethodRouting", + "documented_path": "/obp/v5.1.0/management/method_routings/METHOD_ROUTING_ID", + "fields": [ + "bank_id_pattern", + "connector_name", + "is_bank_id_exact_match", + "method_name", + "method_routing_id", + "parameters", + "parameters[]", + "parameters[].key", + "parameters[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/customer-account-links", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-getCustomerAccountLinksByBankIdAccountId", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/customer-account-links", + "fields": [ + "links", + "links[]", + "links[].account_id", + "links[].bank_id", + "links[].customer_account_link_id", + "links[].customer_id", + "links[].relationship_type" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/owner/account", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getPrivateAccountByIdFull", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account", + "fields": [ + "account_attributes", + "account_attributes[]", + "account_attributes[].account_attribute_id", + "account_attributes[].name", + "account_attributes[].product_code", + "account_attributes[].product_instance_code", + "account_attributes[].type", + "account_attributes[].value", + "account_routings", + "account_routings[]", + "account_routings[].address", + "account_routings[].scheme", + "balance", + "balance.amount", + "balance.currency", + "bank_id", + "id", + "label", + "number", + "owners", + "owners[]", + "owners[].display_name", + "owners[].id", + "owners[].provider", + "product_code", + "tags", + "tags[]", + "tags[].date", + "tags[].id", + "tags[].user", + "tags[].user.display_name", + "tags[].user.id", + "tags[].user.provider", + "tags[].value", + "views_available", + "views_available[]", + "views_available[].account_id", + "views_available[].alias", + "views_available[].allowed_actions", + "views_available[].allowed_actions[]", + "views_available[].bank_id", + "views_available[].can_grant_access_to_views", + "views_available[].can_grant_access_to_views[]", + "views_available[].can_revoke_access_to_views", + "views_available[].can_revoke_access_to_views[]", + "views_available[].description", + "views_available[].hide_metadata_if_alias_used", + "views_available[].is_firehose", + "views_available[].is_public", + "views_available[].is_system", + "views_available[].metadata_view", + "views_available[].view_id", + "views_available[].view_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCustomerByCustomerId", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID", + "fields": [ + "bank_id", + "branch_id", + "credit_limit", + "credit_limit.amount", + "credit_limit.currency", + "credit_rating", + "credit_rating.rating", + "credit_rating.source", + "customer_attributes", + "customer_attributes[]", + "customer_attributes[].customer_attribute_id", + "customer_attributes[].name", + "customer_attributes[].type", + "customer_attributes[].value", + "customer_id", + "customer_number", + "customer_type", + "date_of_birth", + "dependants", + "dob_of_dependants", + "dob_of_dependants[]", + "email", + "employment_status", + "face_image", + "face_image.date", + "face_image.url", + "highest_education_attained", + "kyc_status", + "last_ok_date", + "legal_name", + "mobile_phone_number", + "name_suffix", + "parent_customer_id", + "relationship_status", + "title" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/BANK_ACCOUNT_ID/views", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.2.1-createViewForBankAccount", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/BANK_ACCOUNT_ID/views", + "fields": [ + "alias", + "can_add_comment", + "can_add_corporate_location", + "can_add_image", + "can_add_image_url", + "can_add_more_info", + "can_add_open_corporates_url", + "can_add_physical_location", + "can_add_private_alias", + "can_add_public_alias", + "can_add_tag", + "can_add_url", + "can_add_where_tag", + "can_delete_comment", + "can_delete_corporate_location", + "can_delete_image", + "can_delete_physical_location", + "can_delete_tag", + "can_delete_where_tag", + "can_edit_owner_comment", + "can_see_bank_account_balance", + "can_see_bank_account_bank_name", + "can_see_bank_account_currency", + "can_see_bank_account_iban", + "can_see_bank_account_label", + "can_see_bank_account_national_identifier", + "can_see_bank_account_number", + "can_see_bank_account_owners", + "can_see_bank_account_swift_bic", + "can_see_bank_account_type", + "can_see_comments", + "can_see_corporate_location", + "can_see_image_url", + "can_see_images", + "can_see_more_info", + "can_see_open_corporates_url", + "can_see_other_account_bank_name", + "can_see_other_account_iban", + "can_see_other_account_kind", + "can_see_other_account_metadata", + "can_see_other_account_national_identifier", + "can_see_other_account_number", + "can_see_other_account_swift_bic", + "can_see_owner_comment", + "can_see_physical_location", + "can_see_private_alias", + "can_see_public_alias", + "can_see_tags", + "can_see_transaction_amount", + "can_see_transaction_balance", + "can_see_transaction_currency", + "can_see_transaction_description", + "can_see_transaction_finish_date", + "can_see_transaction_metadata", + "can_see_transaction_other_bank_account", + "can_see_transaction_start_date", + "can_see_transaction_this_bank_account", + "can_see_transaction_type", + "can_see_url", + "can_see_where_tag", + "description", + "hide_metadata_if_alias_used", + "id", + "is_public", + "short_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/customer-account-links", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-getCustomerAccountLinksByCustomerId", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/customer-account-links", + "fields": [ + "links", + "links[]", + "links[].account_id", + "links[].bank_id", + "links[].customer_account_link_id", + "links[].customer_id", + "links[].relationship_type" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/owner/account", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getPrivateAccountByIdFull", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account", + "fields": [ + "account_attributes", + "account_attributes[]", + "account_attributes[].account_attribute_id", + "account_attributes[].name", + "account_attributes[].product_code", + "account_attributes[].product_instance_code", + "account_attributes[].type", + "account_attributes[].value", + "account_routings", + "account_routings[]", + "account_routings[].address", + "account_routings[].scheme", + "balance", + "balance.amount", + "balance.currency", + "bank_id", + "id", + "label", + "number", + "owners", + "owners[]", + "owners[].display_name", + "owners[].id", + "owners[].provider", + "product_code", + "tags", + "tags[]", + "tags[].date", + "tags[].id", + "tags[].user", + "tags[].user.display_name", + "tags[].user.id", + "tags[].user.provider", + "tags[].value", + "views_available", + "views_available[]", + "views_available[].account_id", + "views_available[].alias", + "views_available[].allowed_actions", + "views_available[].allowed_actions[]", + "views_available[].bank_id", + "views_available[].can_grant_access_to_views", + "views_available[].can_grant_access_to_views[]", + "views_available[].can_revoke_access_to_views", + "views_available[].can_revoke_access_to_views[]", + "views_available[].description", + "views_available[].hide_metadata_if_alias_used", + "views_available[].is_firehose", + "views_available[].is_public", + "views_available[].is_system", + "views_available[].metadata_view", + "views_available[].view_id", + "views_available[].view_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCustomerByCustomerId", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID", + "fields": [ + "bank_id", + "branch_id", + "credit_limit", + "credit_limit.amount", + "credit_limit.currency", + "credit_rating", + "credit_rating.rating", + "credit_rating.source", + "customer_attributes", + "customer_attributes[]", + "customer_attributes[].customer_attribute_id", + "customer_attributes[].name", + "customer_attributes[].type", + "customer_attributes[].value", + "customer_id", + "customer_number", + "customer_type", + "date_of_birth", + "dependants", + "dob_of_dependants", + "dob_of_dependants[]", + "email", + "employment_status", + "face_image", + "face_image.date", + "face_image.url", + "highest_education_attained", + "kyc_status", + "last_ok_date", + "legal_name", + "mobile_phone_number", + "name_suffix", + "parent_customer_id", + "relationship_status", + "title" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID/customer-links", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCustomerLinksByCustomerId", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/customers/CUSTOMER_ID/customer-links", + "fields": [ + "customer_links", + "customer_links[]", + "customer_links[].bank_id", + "customer_links[].customer_id", + "customer_links[].customer_link_id", + "customer_links[].date_inserted", + "customer_links[].date_updated", + "customer_links[].other_bank_id", + "customer_links[].other_customer_id", + "customer_links[].relationship_to" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/entitlement-requests", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-addEntitlementRequest", + "documented_path": "/obp/v6.0.0/entitlement-requests", + "fields": [ + "bank_id", + "created", + "entitlement_request_id", + "role_name", + "user", + "user.email", + "user.entitlements", + "user.entitlements.list", + "user.entitlements.list[]", + "user.entitlements.list[].bank_id", + "user.entitlements.list[].entitlement_id", + "user.entitlements.list[].role_name", + "user.provider", + "user.provider_id", + "user.user_id", + "user.username" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/users/USER_ID/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-addEntitlement", + "documented_path": "/obp/v7.0.0/users/USER_ID/entitlements", + "fields": [] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/entitlements/ENTITLEMENT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-deleteEntitlement", + "documented_path": "/obp/v6.0.0/entitlements/ENTITLEMENT_ID", + "fields": [] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/management/groups", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createGroup", + "documented_path": "/obp/v6.0.0/management/groups", + "fields": [ + "bank_id", + "group_description", + "group_id", + "group_name", + "is_enabled", + "list_of_roles", + "list_of_roles[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getGroups", + "documented_path": "/obp/v6.0.0/management/groups", + "fields": [ + "groups", + "groups[]", + "groups[].bank_id", + "groups[].group_description", + "groups[].group_id", + "groups[].group_name", + "groups[].is_enabled", + "groups[].list_of_roles", + "groups[].list_of_roles[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/groups/GROUP_ID/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getGroupEntitlements", + "documented_path": "/obp/v6.0.0/management/groups/GROUP_ID/entitlements", + "fields": [ + "entitlements", + "entitlements[]", + "entitlements[].bank_id", + "entitlements[].created_by_process", + "entitlements[].entitlement_id", + "entitlements[].group_id", + "entitlements[].role_name", + "entitlements[].user_id", + "entitlements[].username" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/USER_ID/group-entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-addUserToGroup", + "documented_path": "/obp/v6.0.0/users/USER_ID/group-entitlements", + "fields": [ + "bank_id", + "entitlements_created", + "entitlements_created[]", + "entitlements_skipped", + "entitlements_skipped[]", + "group_id", + "group_name", + "target_entitlements", + "target_entitlements[]", + "user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/system-views", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-createSystemView", + "documented_path": "/obp/v6.0.0/system-views", + "fields": [ + "alias", + "can_add_comment", + "can_add_corporate_location", + "can_add_counterparty", + "can_add_image", + "can_add_image_url", + "can_add_more_info", + "can_add_open_corporates_url", + "can_add_physical_location", + "can_add_private_alias", + "can_add_public_alias", + "can_add_tag", + "can_add_transaction_request_to_any_account", + "can_add_transaction_request_to_own_account", + "can_add_url", + "can_add_where_tag", + "can_create_direct_debit", + "can_create_standing_order", + "can_delete_comment", + "can_delete_corporate_location", + "can_delete_image", + "can_delete_physical_location", + "can_delete_tag", + "can_delete_where_tag", + "can_edit_owner_comment", + "can_grant_access_to_views", + "can_grant_access_to_views[]", + "can_query_available_funds", + "can_revoke_access_to_views", + "can_revoke_access_to_views[]", + "can_see_bank_account_balance", + "can_see_bank_account_bank_name", + "can_see_bank_account_credit_limit", + "can_see_bank_account_currency", + "can_see_bank_account_iban", + "can_see_bank_account_label", + "can_see_bank_account_national_identifier", + "can_see_bank_account_number", + "can_see_bank_account_owners", + "can_see_bank_account_routing_address", + "can_see_bank_account_routing_scheme", + "can_see_bank_account_swift_bic", + "can_see_bank_account_type", + "can_see_bank_routing_address", + "can_see_bank_routing_scheme", + "can_see_comments", + "can_see_corporate_location", + "can_see_image_url", + "can_see_images", + "can_see_more_info", + "can_see_open_corporates_url", + "can_see_other_account_bank_name", + "can_see_other_account_iban", + "can_see_other_account_kind", + "can_see_other_account_metadata", + "can_see_other_account_national_identifier", + "can_see_other_account_number", + "can_see_other_account_routing_address", + "can_see_other_account_routing_scheme", + "can_see_other_account_swift_bic", + "can_see_other_bank_routing_address", + "can_see_other_bank_routing_scheme", + "can_see_owner_comment", + "can_see_physical_location", + "can_see_private_alias", + "can_see_public_alias", + "can_see_tags", + "can_see_transaction_amount", + "can_see_transaction_balance", + "can_see_transaction_currency", + "can_see_transaction_description", + "can_see_transaction_finish_date", + "can_see_transaction_metadata", + "can_see_transaction_other_bank_account", + "can_see_transaction_start_date", + "can_see_transaction_this_bank_account", + "can_see_transaction_type", + "can_see_url", + "can_see_where_tag", + "description", + "hide_metadata_if_alias_used", + "id", + "is_public", + "is_system", + "metadata_view", + "short_name" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/system-views/SYS_VIEW_ID", + "docs_from": "https://k8s.openbankproject.com", + "missing": true + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/system/connectors", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getConnectors", + "documented_path": "/obp/v6.0.0/system/connectors", + "fields": [ + "connectors", + "connectors[]", + "connectors[].connector_name", + "connectors[].is_available_in_method_routing" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/user-invitation", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createUserInvitation", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/user-invitation", + "fields": [ + "company", + "country", + "email", + "first_name", + "last_name", + "purpose", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/personal-data-fields", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getPersonalDataFields", + "documented_path": "/obp/v6.0.0/my/personal-data-fields", + "fields": [ + "user_attributes", + "user_attributes[]", + "user_attributes[].insert_date", + "user_attributes[].is_personal", + "user_attributes[].name", + "user_attributes[].type", + "user_attributes[].user_attribute_id", + "user_attributes[].value" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/personal-data-fields", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createPersonalDataField", + "documented_path": "/obp/v6.0.0/my/personal-data-fields", + "fields": [ + "insert_date", + "is_personal", + "name", + "type", + "user_attribute_id", + "value" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-updatePersonalDataField", + "documented_path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "fields": [ + "insert_date", + "is_personal", + "name", + "type", + "user_attribute_id", + "value" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/webui_props/WEBUI_PROP_NAME", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createOrUpdateWebUiProps", + "documented_path": "/obp/v6.0.0/management/webui_props/WEBUI_PROP_NAME", + "fields": [ + "name", + "value", + "web_ui_props_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/management/webui_props/WEBUI_PROP_NAME", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-deleteWebUiProps", + "documented_path": "/obp/v6.0.0/management/webui_props/WEBUI_PROP_NAME", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/webui_props/WEBUI_PROP_NAME", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createOrUpdateWebUiProps", + "documented_path": "/obp/v6.0.0/management/webui_props/WEBUI_PROP_NAME", + "fields": [ + "name", + "value", + "web_ui_props_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/current", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCurrentUser", + "documented_path": "/obp/v6.0.0/users/current", + "fields": [ + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/current", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getCurrentUser", + "documented_path": "/obp/v6.0.0/users/current", + "fields": [ + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/app-directory", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAppDirectory", + "documented_path": "/obp/v6.0.0/app-directory", + "fields": [ + "app_directory", + "app_directory[]", + "app_directory[].name", + "app_directory[].value" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createUserCustomerLinks", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links", + "fields": [ + "customer_id", + "date_inserted", + "is_active", + "user_customer_link_id", + "user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/customers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createCustomer", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/customers", + "fields": [ + "bank_id", + "branch_id", + "credit_limit", + "credit_limit.amount", + "credit_limit.currency", + "credit_rating", + "credit_rating.rating", + "credit_rating.source", + "customer_id", + "customer_number", + "customer_type", + "date_of_birth", + "dependants", + "dob_of_dependants", + "dob_of_dependants[]", + "email", + "employment_status", + "face_image", + "face_image.date", + "face_image.url", + "highest_education_attained", + "kyc_status", + "last_ok_date", + "legal_name", + "mobile_phone_number", + "name_suffix", + "parent_customer_id", + "relationship_status", + "title" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/my/customers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getMyCustomersAtBank", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/my/customers", + "fields": [ + "customers", + "customers[]", + "customers[].bank_id", + "customers[].credit_limit", + "customers[].credit_limit.amount", + "customers[].credit_limit.currency", + "customers[].credit_rating", + "customers[].credit_rating.rating", + "customers[].credit_rating.source", + "customers[].customer_id", + "customers[].customer_number", + "customers[].date_of_birth", + "customers[].dependants", + "customers[].dob_of_dependants", + "customers[].dob_of_dependants[]", + "customers[].email", + "customers[].employment_status", + "customers[].face_image", + "customers[].face_image.date", + "customers[].face_image.url", + "customers[].highest_education_attained", + "customers[].kyc_status", + "customers[].last_ok_date", + "customers[].legal_name", + "customers[].mobile_phone_number", + "customers[].relationship_status" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/files", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getFilesAttachedToRecord", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/files", + "fields": [ + "files", + "files[]", + "files[].bank_id", + "files[].created_at", + "files[].file_id", + "files[].file_name", + "files[].is_personal", + "files[].is_public", + "files[].media_type", + "files[].on_behalf_of_user_id", + "files[].owner_user_id", + "files[].scan_status", + "files[].scan_status_reason", + "files[].sha256", + "files[].size_in_bytes", + "files[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/files/FILE_ID/content", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getFileContent", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/files/FILE_ID/content", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/banks/BANK_ID/files/FILE_ID/scan-status", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateFileScanStatus", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/files/FILE_ID/scan-status", + "fields": [ + "bank_id", + "created_at", + "file_id", + "file_name", + "is_personal", + "is_public", + "media_type", + "on_behalf_of_user_id", + "owner_user_id", + "scan_status", + "scan_status_reason", + "sha256", + "size_in_bytes", + "user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/banks/BANK_ID/my/files", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createMyFile", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/my/files", + "fields": [ + "bank_id", + "created_at", + "file_id", + "file_name", + "is_personal", + "is_public", + "media_type", + "on_behalf_of_user_id", + "owner_user_id", + "scan_status", + "scan_status_reason", + "sha256", + "size_in_bytes", + "user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createDynamicEntityDefinition", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "auth_mode", + "bank_id", + "dynamic_entity_id", + "entity_name", + "has_community_access", + "has_personal_entity", + "has_public_access", + "personal_requires_role", + "schema", + "schema.description", + "schema.properties", + "schema.properties.language", + "schema.properties.language.description", + "schema.properties.language.example", + "schema.properties.language.maxLength", + "schema.properties.language.minLength", + "schema.properties.language.type", + "schema.properties.theme", + "schema.properties.theme.description", + "schema.properties.theme.example", + "schema.properties.theme.indexed", + "schema.properties.theme.maxLength", + "schema.properties.theme.minLength", + "schema.properties.theme.type", + "schema.required", + "schema.required[]", + "schema.required[].s", + "use_row_level_access", + "user_id" + ] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateDynamicEntityDefinition", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID", + "fields": [ + "auth_mode", + "bank_id", + "dynamic_entity_id", + "entity_name", + "has_community_access", + "has_personal_entity", + "has_public_access", + "personal_requires_role", + "schema", + "schema.description", + "schema.properties", + "schema.properties.language", + "schema.properties.language.description", + "schema.properties.language.example", + "schema.properties.language.maxLength", + "schema.properties.language.minLength", + "schema.properties.language.type", + "schema.properties.theme", + "schema.properties.theme.description", + "schema.properties.theme.example", + "schema.properties.theme.indexed", + "schema.properties.theme.maxLength", + "schema.properties.theme.minLength", + "schema.properties.theme.type", + "schema.required", + "schema.required[]", + "schema.required[].s", + "use_row_level_access", + "user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/banks/BANK_ID/customers/CUSTOMER_ID/emails", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-sendEmailToCustomer", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/customers/CUSTOMER_ID/emails", + "fields": [ + "bank_id", + "created_at", + "customer_id", + "message_id", + "reference", + "status", + "subject" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/well-known", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getOAuth2ServerWellKnown", + "documented_path": "/obp/v5.1.0/well-known", + "fields": [ + "jwks_uris", + "jwks_uris[]", + "jwks_uris[].jwks_uri" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/customers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getCustomersAtOneBank", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/customers", + "fields": [ + "customers", + "customers[]", + "customers[].bank_id", + "customers[].branch_id", + "customers[].credit_limit", + "customers[].credit_limit.amount", + "customers[].credit_limit.currency", + "customers[].credit_rating", + "customers[].credit_rating.rating", + "customers[].credit_rating.source", + "customers[].customer_attributes", + "customers[].customer_attributes[]", + "customers[].customer_attributes[].customer_attribute_id", + "customers[].customer_attributes[].name", + "customers[].customer_attributes[].type", + "customers[].customer_attributes[].value", + "customers[].customer_id", + "customers[].customer_number", + "customers[].customer_type", + "customers[].date_of_birth", + "customers[].dependants", + "customers[].dob_of_dependants", + "customers[].dob_of_dependants[]", + "customers[].email", + "customers[].employment_status", + "customers[].face_image", + "customers[].face_image.date", + "customers[].face_image.url", + "customers[].highest_education_attained", + "customers[].kyc_status", + "customers[].last_ok_date", + "customers[].legal_name", + "customers[].mobile_phone_number", + "customers[].name_suffix", + "customers[].parent_customer_id", + "customers[].relationship_status", + "customers[].title" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createUserCustomerLinks", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links", + "fields": [ + "customer_id", + "date_inserted", + "is_active", + "user_customer_link_id", + "user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/customers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createCustomer", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/customers", + "fields": [ + "bank_id", + "branch_id", + "credit_limit", + "credit_limit.amount", + "credit_limit.currency", + "credit_rating", + "credit_rating.rating", + "credit_rating.source", + "customer_id", + "customer_number", + "customer_type", + "date_of_birth", + "dependants", + "dob_of_dependants", + "dob_of_dependants[]", + "email", + "employment_status", + "face_image", + "face_image.date", + "face_image.url", + "highest_education_attained", + "kyc_status", + "last_ok_date", + "legal_name", + "mobile_phone_number", + "name_suffix", + "parent_customer_id", + "relationship_status", + "title" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionPolicies", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "fields": [ + "retention_policies", + "retention_policies[]", + "retention_policies[].action", + "retention_policies[].archive_days", + "retention_policies[].bank_id", + "retention_policies[].cascade", + "retention_policies[].condition", + "retention_policies[].condition.field", + "retention_policies[].condition.value", + "retention_policies[].created_at", + "retention_policies[].created_by_user_id", + "retention_policies[].date_basis", + "retention_policies[].description", + "retention_policies[].enabled", + "retention_policies[].entity_name", + "retention_policies[].name", + "retention_policies[].requires_approval", + "retention_policies[].resource_type", + "retention_policies[].retain_days", + "retention_policies[].retention_policy_id", + "retention_policies[].updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createRetentionPolicy", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies", + "fields": [ + "action", + "archive_days", + "bank_id", + "cascade", + "condition", + "condition.field", + "condition.value", + "created_at", + "created_by_user_id", + "date_basis", + "description", + "enabled", + "entity_name", + "name", + "requires_approval", + "resource_type", + "retain_days", + "retention_policy_id", + "updated_at" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-deleteRetentionPolicy", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateRetentionPolicy", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID", + "fields": [ + "action", + "archive_days", + "bank_id", + "cascade", + "condition", + "condition.field", + "condition.value", + "created_at", + "created_by_user_id", + "date_basis", + "description", + "enabled", + "entity_name", + "name", + "requires_approval", + "resource_type", + "retain_days", + "retention_policy_id", + "updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID/preview", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionPolicyPreview", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID/preview", + "fields": [ + "action", + "archive_enabled", + "archive_entries_due_count", + "bank_id", + "can_execute", + "count_is_capped", + "cutoff_date", + "delete_enabled", + "due_count", + "entity_name", + "held_count", + "matched_count", + "max_items_per_run", + "minimum_retain_days", + "oldest_trigger_date", + "requires_approval", + "resource_type", + "retention_policy_id", + "sample_resource_ids", + "sample_resource_ids[]" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID/runs", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createRetentionRun", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-policies/RETENTION_POLICY_ID/runs", + "fields": [ + "anonymised_count", + "approval_comment", + "approval_decision", + "approved_by_user_id", + "archived_count", + "bank_id", + "deleted_count", + "ended_at", + "failed_count", + "held_count", + "matched_count", + "message", + "mode", + "requested_at", + "requested_by_user_id", + "retention_policy_id", + "retention_run_id", + "started_at", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getRetentionRuns", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs", + "fields": [ + "retention_runs", + "retention_runs[]", + "retention_runs[].anonymised_count", + "retention_runs[].approval_comment", + "retention_runs[].approval_decision", + "retention_runs[].approved_by_user_id", + "retention_runs[].archived_count", + "retention_runs[].bank_id", + "retention_runs[].deleted_count", + "retention_runs[].ended_at", + "retention_runs[].failed_count", + "retention_runs[].held_count", + "retention_runs[].matched_count", + "retention_runs[].message", + "retention_runs[].mode", + "retention_runs[].requested_at", + "retention_runs[].requested_by_user_id", + "retention_runs[].retention_policy_id", + "retention_runs[].retention_run_id", + "retention_runs[].started_at", + "retention_runs[].status" + ] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs/RETENTION_RUN_ID/approval", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateRetentionRunApproval", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/retention-runs/RETENTION_RUN_ID/approval", + "fields": [ + "anonymised_count", + "approval_comment", + "approval_decision", + "approved_by_user_id", + "archived_count", + "bank_id", + "deleted_count", + "ended_at", + "failed_count", + "held_count", + "matched_count", + "message", + "mode", + "requested_at", + "requested_by_user_id", + "retention_policy_id", + "retention_run_id", + "started_at", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-getBank", + "documented_path": "/obp/v5.1.0/banks/BANK_ID", + "fields": [ + "attributes", + "attributes[]", + "attributes[].name", + "attributes[].value", + "bank_code", + "bank_routings", + "bank_routings[]", + "bank_routings[].address", + "bank_routings[].scheme", + "full_name", + "id", + "logo", + "website" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/entitlement-requests", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getEntitlementRequestsForCurrentUser", + "documented_path": "/obp/v5.1.0/my/entitlement-requests", + "fields": [ + "entitlement_requests", + "entitlement_requests[]", + "entitlement_requests[].bank_id", + "entitlement_requests[].created", + "entitlement_requests[].entitlement_request_id", + "entitlement_requests[].role_name", + "entitlement_requests[].user", + "entitlement_requests[].user.email", + "entitlement_requests[].user.entitlements", + "entitlement_requests[].user.entitlements.list", + "entitlement_requests[].user.entitlements.list[]", + "entitlement_requests[].user.entitlements.list[].bank_id", + "entitlement_requests[].user.entitlements.list[].entitlement_id", + "entitlement_requests[].user.entitlements.list[].role_name", + "entitlement_requests[].user.provider", + "entitlement_requests[].user.provider_id", + "entitlement_requests[].user.user_id", + "entitlement_requests[].user.username" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/current", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getCurrentUser", + "documented_path": "/obp/v5.1.0/users/current", + "fields": [ + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/entitlement-requests", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-addEntitlementRequest", + "documented_path": "/obp/v6.0.0/entitlement-requests", + "fields": [ + "bank_id", + "created", + "entitlement_request_id", + "role_name", + "user", + "user.email", + "user.entitlements", + "user.entitlements.list", + "user.entitlements.list[]", + "user.entitlements.list[].bank_id", + "user.entitlements.list[].entitlement_id", + "user.entitlements.list[].role_name", + "user.provider", + "user.provider_id", + "user.user_id", + "user.username" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/users", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getUsers", + "documented_path": "/obp/v7.0.0/users", + "fields": [ + "users", + "users[]", + "users[].agreements", + "users[].agreements[]", + "users[].agreements[].text", + "users[].agreements[].type", + "users[].created_date", + "users[].email", + "users[].email_validated", + "users[].entitlements", + "users[].entitlements.list", + "users[].entitlements.list[]", + "users[].entitlements.list[].bank_id", + "users[].entitlements.list[].entitlement_id", + "users[].entitlements.list[].role_name", + "users[].first_name", + "users[].is_deleted", + "users[].is_locked", + "users[].last_marketing_agreement_signed_date", + "users[].last_name", + "users[].last_used_locale", + "users[].provider", + "users[].provider_id", + "users[].updated_date", + "users[].user_id", + "users[].username", + "users[].views", + "users[].views.list", + "users[].views.list[]", + "users[].views.list[].account_id", + "users[].views.list[].bank_id", + "users[].views.list[].view_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/attribute", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createCustomerAttribute", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/customers/CUSTOMER_ID/attribute", + "fields": [ + "customer_attribute_id", + "name", + "type", + "value" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createUserCustomerLinks", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links", + "fields": [ + "customer_id", + "date_inserted", + "is_active", + "user_customer_link_id", + "user_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links/USER_CUSTOMER_LINK_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteUserCustomerLink", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links/USER_CUSTOMER_LINK_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links/customers/CUSTOMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getUserCustomerLinksByCustomerId", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/user_customer_links/customers/CUSTOMER_ID", + "fields": [ + "user_customer_links", + "user_customer_links[]", + "user_customer_links[].customer_id", + "user_customer_links[].date_inserted", + "user_customer_links[].is_active", + "user_customer_links[].user_customer_link_id", + "user_customer_links[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/user_id/USER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getUserByUserId", + "documented_path": "/obp/v5.1.0/users/user_id/USER_ID", + "fields": [ + "agreements", + "agreements[]", + "agreements[].text", + "agreements[].type", + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "is_deleted", + "is_locked", + "last_marketing_agreement_signed_date", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/customers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createCustomer", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/customers", + "fields": [ + "bank_id", + "branch_id", + "credit_limit", + "credit_limit.amount", + "credit_limit.currency", + "credit_rating", + "credit_rating.rating", + "credit_rating.source", + "customer_id", + "customer_number", + "customer_type", + "date_of_birth", + "dependants", + "dob_of_dependants", + "dob_of_dependants[]", + "email", + "employment_status", + "face_image", + "face_image.date", + "face_image.url", + "highest_education_attained", + "kyc_status", + "last_ok_date", + "legal_name", + "mobile_phone_number", + "name_suffix", + "parent_customer_id", + "relationship_status", + "title" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/current", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getCurrentUser", + "documented_path": "/obp/v5.1.0/users/current", + "fields": [ + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/root", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-root", + "documented_path": "/obp/v5.1.0/root", + "fields": [ + "connector", + "energy_source", + "energy_source.organisation", + "energy_source.organisation_website", + "git_commit", + "hosted_at", + "hosted_at.organisation", + "hosted_at.organisation_website", + "hosted_by", + "hosted_by.email", + "hosted_by.organisation", + "hosted_by.organisation_website", + "hosted_by.phone", + "hostname", + "local_identity_provider", + "resource_docs_requires_role", + "version", + "version_status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/app-directory", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAppDirectory", + "documented_path": "/obp/v6.0.0/app-directory", + "fields": [ + "app_directory", + "app_directory[]", + "app_directory[].name", + "app_directory[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/public/consent-config", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getConsentsConfig", + "documented_path": "/obp/v7.0.0/public/consent-config", + "fields": [ + "consents_allowed", + "max_time_to_live_in_seconds", + "sca_enabled" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/well-known", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getOAuth2ServerWellKnown", + "documented_path": "/obp/v5.1.0/well-known", + "fields": [ + "jwks_uris", + "jwks_uris[]", + "jwks_uris[].jwks_uri" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsObp", + "documented_path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/public/password-config", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getPasswordPolicy", + "documented_path": "/obp/v7.0.0/public/password-config", + "fields": [ + "description", + "policies", + "policies[]", + "policies[].allowed_characters", + "policies[].description", + "policies[].max_length", + "policies[].min_length", + "policies[].regex", + "policies[].required_character_classes", + "policies[].required_character_classes[]", + "policies[].required_character_classes[].name", + "policies[].required_character_classes[].regex" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemChatRooms", + "documented_path": "/obp/v6.0.0/chat-rooms", + "fields": [ + "chat_rooms", + "chat_rooms[]", + "chat_rooms[].bank_id", + "chat_rooms[].chat_room_id", + "chat_rooms[].created_at", + "chat_rooms[].created_by_provider", + "chat_rooms[].created_by_user_id", + "chat_rooms[].created_by_username", + "chat_rooms[].description", + "chat_rooms[].is_archived", + "chat_rooms[].is_open_room", + "chat_rooms[].joining_key", + "chat_rooms[].last_message_at", + "chat_rooms[].last_message_preview", + "chat_rooms[].last_message_sender_username", + "chat_rooms[].name", + "chat_rooms[].participant_count", + "chat_rooms[].unread_count", + "chat_rooms[].updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createSystemChatRoom", + "documented_path": "/obp/v6.0.0/chat-rooms", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/personal-data-fields", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getPersonalDataFields", + "documented_path": "/obp/v6.0.0/my/personal-data-fields", + "fields": [ + "user_attributes", + "user_attributes[]", + "user_attributes[].insert_date", + "user_attributes[].is_personal", + "user_attributes[].name", + "user_attributes[].type", + "user_attributes[].user_attribute_id", + "user_attributes[].value" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/personal-data-fields", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createPersonalDataField", + "documented_path": "/obp/v6.0.0/my/personal-data-fields", + "fields": [ + "insert_date", + "is_personal", + "name", + "type", + "user_attribute_id", + "value" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-updatePersonalDataField", + "documented_path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "fields": [ + "insert_date", + "is_personal", + "name", + "type", + "user_attribute_id", + "value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/personal-data-fields", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getPersonalDataFields", + "documented_path": "/obp/v6.0.0/my/personal-data-fields", + "fields": [ + "user_attributes", + "user_attributes[]", + "user_attributes[].insert_date", + "user_attributes[].is_personal", + "user_attributes[].name", + "user_attributes[].type", + "user_attributes[].user_attribute_id", + "user_attributes[].value" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/personal-data-fields", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createPersonalDataField", + "documented_path": "/obp/v6.0.0/my/personal-data-fields", + "fields": [ + "insert_date", + "is_personal", + "name", + "type", + "user_attribute_id", + "value" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-updatePersonalDataField", + "documented_path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "fields": [ + "insert_date", + "is_personal", + "name", + "type", + "user_attribute_id", + "value" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/users/current/auth-context-updates/SCA_METHOD", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-createUserAuthContextUpdateRequest", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/users/current/auth-context-updates/SCA_METHOD", + "fields": [ + "consumer_id", + "key", + "status", + "user_auth_context_update_id", + "user_id", + "value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/account-applications", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-createAccountApplication", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/account-applications", + "fields": [ + "account_application_id", + "customer", + "customer.bank_id", + "customer.branch_id", + "customer.credit_limit", + "customer.credit_limit.amount", + "customer.credit_limit.currency", + "customer.credit_rating", + "customer.credit_rating.rating", + "customer.credit_rating.source", + "customer.customer_id", + "customer.customer_number", + "customer.date_of_birth", + "customer.dependants", + "customer.dob_of_dependants", + "customer.dob_of_dependants[]", + "customer.email", + "customer.employment_status", + "customer.face_image", + "customer.face_image.date", + "customer.face_image.url", + "customer.highest_education_attained", + "customer.kyc_status", + "customer.last_ok_date", + "customer.legal_name", + "customer.mobile_phone_number", + "customer.name_suffix", + "customer.relationship_status", + "customer.title", + "date_of_application", + "product_code", + "status", + "user", + "user.email", + "user.provider", + "user.provider_id", + "user.user_id", + "user.username" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getApiProduct", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "fields": [ + "api_product_code", + "api_product_id", + "attributes", + "attributes[]", + "attributes[].api_product_attribute_id", + "attributes[].api_product_code", + "attributes[].bank_id", + "attributes[].is_active", + "attributes[].name", + "attributes[].type", + "attributes[].value", + "bank_id", + "category", + "collection_id", + "description", + "monthly_subscription_amount", + "monthly_subscription_currency", + "more_info_url", + "name", + "parent_api_product_code", + "per_day_call_limit", + "per_hour_call_limit", + "per_minute_call_limit", + "per_month_call_limit", + "per_second_call_limit", + "per_week_call_limit", + "tags", + "tags[]", + "terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/user/current/consents/CONSENT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getConsentByConsentId", + "documented_path": "/obp/v5.1.0/user/current/consents/CONSENT_ID", + "fields": [ + "consent_id", + "consent_request_id", + "consumer_id", + "jwt", + "scopes", + "scopes[]", + "scopes[].bank_id", + "scopes[].role_name", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/consumers/CONSUMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getConsumer", + "documented_path": "/obp/v5.1.0/management/consumers/CONSUMER_ID", + "fields": [ + "app_name", + "app_type", + "consumer_id", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "created_by_user_id", + "description", + "developer_email", + "enabled", + "redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/user/current/consents/CONSENT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getConsentByConsentId", + "documented_path": "/obp/v5.1.0/user/current/consents/CONSENT_ID", + "fields": [ + "consent_id", + "consent_request_id", + "consumer_id", + "jwt", + "scopes", + "scopes[]", + "scopes[].bank_id", + "scopes[].role_name", + "status" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/consents/CONSENT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-updateConsentStatus", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/consents/CONSENT_ID", + "fields": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/management/banks/BANK_ID/consents/CONSENT_ID/account-access", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-updateConsentAccountAccessByConsentId", + "documented_path": "/obp/v6.0.0/management/banks/BANK_ID/consents/CONSENT_ID/account-access", + "fields": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/accounts", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-corePrivateAccountsAllBanks", + "documented_path": "/obp/v6.0.0/my/accounts", + "fields": [ + "accounts", + "accounts[]", + "accounts[].account_routings", + "accounts[].account_routings[]", + "accounts[].account_routings[].address", + "accounts[].account_routings[].scheme", + "accounts[].account_type", + "accounts[].bank_id", + "accounts[].id", + "accounts[].label", + "accounts[].views", + "accounts[].views[]", + "accounts[].views[].description", + "accounts[].views[].id", + "accounts[].views[].is_public", + "accounts[].views[].short_name" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/users/current/auth-context-updates/AUTH_CONTEXT_UPDATE_ID/challenge", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-answerUserAuthContextUpdateChallenge", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/users/current/auth-context-updates/AUTH_CONTEXT_UPDATE_ID/challenge", + "fields": [ + "consumer_id", + "key", + "status", + "user_auth_context_update_id", + "user_id", + "value" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-getConsentRequest", + "documented_path": "/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID", + "fields": [ + "consent_request_id", + "consumer_id", + "payload", + "payload.account_access", + "payload.account_access[]", + "payload.account_access[].account_routing", + "payload.account_access[].account_routing.address", + "payload.account_access[].account_routing.scheme", + "payload.account_access[].view_id", + "payload.everything", + "payload.phone_number", + "payload.time_to_live", + "payload.valid_from" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID/IMPLICIT/consents", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-createConsentByConsentRequestIdImplicit", + "documented_path": "/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID/IMPLICIT/consents", + "fields": [ + "account_access", + "account_access.account_id", + "account_access.bank_id", + "account_access.helper_info", + "account_access.helper_info.counterparty_ids", + "account_access.helper_info.counterparty_ids[]", + "account_access.view_id", + "consent_id", + "consent_request_id", + "jwt", + "status" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-answerConsentChallenge", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge", + "fields": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/consumers/CONSUMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getConsumer", + "documented_path": "/obp/v5.1.0/management/consumers/CONSUMER_ID", + "fields": [ + "app_name", + "app_type", + "consumer_id", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "created_by_user_id", + "description", + "developer_email", + "enabled", + "redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/user/current/consents/CONSENT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getConsentByConsentId", + "documented_path": "/obp/v5.1.0/user/current/consents/CONSENT_ID", + "fields": [ + "consent_id", + "consent_request_id", + "consumer_id", + "jwt", + "scopes", + "scopes[]", + "scopes[].bank_id", + "scopes[].role_name", + "status" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/my/consumers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-createMyConsumer", + "documented_path": "/obp/v5.1.0/my/consumers", + "fields": [ + "app_name", + "app_type", + "certificate_info", + "certificate_info.issuer_domain_name", + "certificate_info.not_after", + "certificate_info.not_before", + "certificate_info.roles_info", + "certificate_info.subject_domain_name", + "certificate_pem", + "company", + "consumer_id", + "consumer_key", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "description", + "developer_email", + "enabled", + "logo_url", + "redirect_url" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-answerConsentChallenge", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/challenge", + "fields": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-getConsentRequest", + "documented_path": "/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID", + "fields": [ + "consent_request_id", + "consumer_id", + "payload", + "payload.account_access", + "payload.account_access[]", + "payload.account_access[].account_routing", + "payload.account_access[].account_routing.address", + "payload.account_access[].account_routing.scheme", + "payload.account_access[].view_id", + "payload.everything", + "payload.phone_number", + "payload.time_to_live", + "payload.valid_from" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID/IMPLICIT/consents", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-createConsentByConsentRequestIdImplicit", + "documented_path": "/obp/v5.1.0/consumer/consent-requests/CONSENT_REQUEST_ID/IMPLICIT/consents", + "fields": [ + "account_access", + "account_access.account_id", + "account_access.bank_id", + "account_access.helper_info", + "account_access.helper_info.counterparty_ids", + "account_access.helper_info.counterparty_ids[]", + "account_access.view_id", + "consent_id", + "consent_request_id", + "jwt", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/management/consumers/CONSUMER_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getConsumer", + "documented_path": "/obp/v5.1.0/management/consumers/CONSUMER_ID", + "fields": [ + "app_name", + "app_type", + "consumer_id", + "created", + "created_by_user", + "created_by_user.email", + "created_by_user.provider", + "created_by_user.provider_id", + "created_by_user.user_id", + "created_by_user.username", + "created_by_user_id", + "description", + "developer_email", + "enabled", + "redirect_url" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/GRANT_VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-answerTransactionRequestChallenge", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/GRANT_VIEW_ID/transaction-request-types/TRANSACTION_REQUEST_TYPE/transaction-requests/TRANSACTION_REQUEST_ID/challenge", + "fields": [ + "challenge", + "challenge.allowed_attempts", + "challenge.challenge_type", + "challenge.id", + "charge", + "charge.summary", + "charge.value", + "charge.value.amount", + "charge.value.currency", + "details", + "details.description", + "details.to_agent", + "details.to_agent.agent_number", + "details.to_agent.bank_id", + "details.to_counterparty", + "details.to_counterparty.counterparty_id", + "details.to_sandbox_tan", + "details.to_sandbox_tan.account_id", + "details.to_sandbox_tan.bank_id", + "details.to_sepa", + "details.to_sepa.iban", + "details.to_sepa_credit_transfers", + "details.to_sepa_credit_transfers.creditorAccount", + "details.to_sepa_credit_transfers.creditorAccount.iban", + "details.to_sepa_credit_transfers.creditorName", + "details.to_sepa_credit_transfers.debtorAccount", + "details.to_sepa_credit_transfers.debtorAccount.iban", + "details.to_sepa_credit_transfers.instructedAmount", + "details.to_sepa_credit_transfers.instructedAmount.amount", + "details.to_sepa_credit_transfers.instructedAmount.currency", + "details.to_simple", + "details.to_simple.otherAccountRoutingAddress", + "details.to_simple.otherAccountRoutingScheme", + "details.to_simple.otherAccountSecondaryRoutingAddress", + "details.to_simple.otherAccountSecondaryRoutingScheme", + "details.to_simple.otherBankRoutingAddress", + "details.to_simple.otherBankRoutingScheme", + "details.to_simple.otherBranchRoutingAddress", + "details.to_simple.otherBranchRoutingScheme", + "details.to_transfer_to_account", + "details.to_transfer_to_account.description", + "details.to_transfer_to_account.future_date", + "details.to_transfer_to_account.to", + "details.to_transfer_to_account.to.account", + "details.to_transfer_to_account.to.account.iban", + "details.to_transfer_to_account.to.account.number", + "details.to_transfer_to_account.to.bank_code", + "details.to_transfer_to_account.to.branch_number", + "details.to_transfer_to_account.to.name", + "details.to_transfer_to_account.transfer_type", + "details.to_transfer_to_account.value", + "details.to_transfer_to_account.value.amount", + "details.to_transfer_to_account.value.currency", + "details.to_transfer_to_atm", + "details.to_transfer_to_atm.description", + "details.to_transfer_to_atm.from", + "details.to_transfer_to_atm.from.mobile_phone_number", + "details.to_transfer_to_atm.from.nickname", + "details.to_transfer_to_atm.message", + "details.to_transfer_to_atm.to", + "details.to_transfer_to_atm.to.date_of_birth", + "details.to_transfer_to_atm.to.kyc_document", + "details.to_transfer_to_atm.to.kyc_document.number", + "details.to_transfer_to_atm.to.kyc_document.type", + "details.to_transfer_to_atm.to.legal_name", + "details.to_transfer_to_atm.to.mobile_phone_number", + "details.to_transfer_to_atm.value", + "details.to_transfer_to_atm.value.amount", + "details.to_transfer_to_atm.value.currency", + "details.to_transfer_to_phone", + "details.to_transfer_to_phone.description", + "details.to_transfer_to_phone.from", + "details.to_transfer_to_phone.from.mobile_phone_number", + "details.to_transfer_to_phone.from.nickname", + "details.to_transfer_to_phone.message", + "details.to_transfer_to_phone.to", + "details.to_transfer_to_phone.to.mobile_phone_number", + "details.to_transfer_to_phone.value", + "details.to_transfer_to_phone.value.amount", + "details.to_transfer_to_phone.value.currency", + "details.value", + "details.value.amount", + "details.value.currency", + "end_date", + "from", + "from.account_id", + "from.bank_id", + "id", + "start_date", + "status", + "transaction_ids", + "transaction_ids[]", + "type" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/authorise", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-authoriseUKConsent", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/authorise", + "fields": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/authorise/challenge", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-authoriseUKConsentChallenge", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/consents/CONSENT_ID/authorise/challenge", + "fields": [ + "challenge_id", + "sca_method", + "sca_status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/accounts", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-corePrivateAccountsAllBanks", + "documented_path": "/obp/v6.0.0/my/accounts", + "fields": [ + "accounts", + "accounts[]", + "accounts[].account_routings", + "accounts[].account_routings[]", + "accounts[].account_routings[].address", + "accounts[].account_routings[].scheme", + "accounts[].account_type", + "accounts[].bank_id", + "accounts[].id", + "accounts[].label", + "accounts[].views", + "accounts[].views[]", + "accounts[].views[].description", + "accounts[].views[].id", + "accounts[].views[].is_public", + "accounts[].views[].short_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getBanks", + "documented_path": "/obp/v5.1.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].bank_routing", + "banks[].bank_routing.address", + "banks[].bank_routing.scheme", + "banks[].full_name", + "banks[].id", + "banks[].logo", + "banks[].short_name", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/accounts", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-corePrivateAccountsAllBanks", + "documented_path": "/obp/v5.1.0/my/accounts", + "fields": [ + "accounts", + "accounts[]", + "accounts[].account_routings", + "accounts[].account_routings[]", + "accounts[].account_routings[].address", + "accounts[].account_routings[].scheme", + "accounts[].account_type", + "accounts[].bank_id", + "accounts[].id", + "accounts[].label", + "accounts[].views", + "accounts[].views[]", + "accounts[].views[].description", + "accounts[].views[].id", + "accounts[].views[].is_public", + "accounts[].views[].short_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-getViewsForBankAccount", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views", + "fields": [ + "views", + "views[]", + "views[].alias", + "views[].can_add_comment", + "views[].can_add_corporate_location", + "views[].can_add_counterparty", + "views[].can_add_image", + "views[].can_add_image_url", + "views[].can_add_more_info", + "views[].can_add_open_corporates_url", + "views[].can_add_physical_location", + "views[].can_add_private_alias", + "views[].can_add_public_alias", + "views[].can_add_tag", + "views[].can_add_transaction_request_to_any_account", + "views[].can_add_transaction_request_to_own_account", + "views[].can_add_url", + "views[].can_add_where_tag", + "views[].can_create_direct_debit", + "views[].can_create_standing_order", + "views[].can_delete_comment", + "views[].can_delete_corporate_location", + "views[].can_delete_image", + "views[].can_delete_physical_location", + "views[].can_delete_tag", + "views[].can_delete_where_tag", + "views[].can_edit_owner_comment", + "views[].can_grant_access_to_views", + "views[].can_grant_access_to_views[]", + "views[].can_query_available_funds", + "views[].can_revoke_access_to_views", + "views[].can_revoke_access_to_views[]", + "views[].can_see_bank_account_balance", + "views[].can_see_bank_account_bank_name", + "views[].can_see_bank_account_credit_limit", + "views[].can_see_bank_account_currency", + "views[].can_see_bank_account_iban", + "views[].can_see_bank_account_label", + "views[].can_see_bank_account_national_identifier", + "views[].can_see_bank_account_number", + "views[].can_see_bank_account_owners", + "views[].can_see_bank_account_routing_address", + "views[].can_see_bank_account_routing_scheme", + "views[].can_see_bank_account_swift_bic", + "views[].can_see_bank_account_type", + "views[].can_see_bank_routing_address", + "views[].can_see_bank_routing_scheme", + "views[].can_see_comments", + "views[].can_see_corporate_location", + "views[].can_see_image_url", + "views[].can_see_images", + "views[].can_see_more_info", + "views[].can_see_open_corporates_url", + "views[].can_see_other_account_bank_name", + "views[].can_see_other_account_iban", + "views[].can_see_other_account_kind", + "views[].can_see_other_account_metadata", + "views[].can_see_other_account_national_identifier", + "views[].can_see_other_account_number", + "views[].can_see_other_account_routing_address", + "views[].can_see_other_account_routing_scheme", + "views[].can_see_other_account_swift_bic", + "views[].can_see_other_bank_routing_address", + "views[].can_see_other_bank_routing_scheme", + "views[].can_see_owner_comment", + "views[].can_see_physical_location", + "views[].can_see_private_alias", + "views[].can_see_public_alias", + "views[].can_see_tags", + "views[].can_see_transaction_amount", + "views[].can_see_transaction_balance", + "views[].can_see_transaction_currency", + "views[].can_see_transaction_description", + "views[].can_see_transaction_finish_date", + "views[].can_see_transaction_metadata", + "views[].can_see_transaction_other_bank_account", + "views[].can_see_transaction_start_date", + "views[].can_see_transaction_this_bank_account", + "views[].can_see_transaction_type", + "views[].can_see_url", + "views[].can_see_where_tag", + "views[].description", + "views[].hide_metadata_if_alias_used", + "views[].id", + "views[].is_public", + "views[].is_system", + "views[].metadata_view", + "views[].short_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-getViewsForBankAccount", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/views", + "fields": [ + "views", + "views[]", + "views[].alias", + "views[].can_add_comment", + "views[].can_add_corporate_location", + "views[].can_add_counterparty", + "views[].can_add_image", + "views[].can_add_image_url", + "views[].can_add_more_info", + "views[].can_add_open_corporates_url", + "views[].can_add_physical_location", + "views[].can_add_private_alias", + "views[].can_add_public_alias", + "views[].can_add_tag", + "views[].can_add_transaction_request_to_any_account", + "views[].can_add_transaction_request_to_own_account", + "views[].can_add_url", + "views[].can_add_where_tag", + "views[].can_create_direct_debit", + "views[].can_create_standing_order", + "views[].can_delete_comment", + "views[].can_delete_corporate_location", + "views[].can_delete_image", + "views[].can_delete_physical_location", + "views[].can_delete_tag", + "views[].can_delete_where_tag", + "views[].can_edit_owner_comment", + "views[].can_grant_access_to_views", + "views[].can_grant_access_to_views[]", + "views[].can_query_available_funds", + "views[].can_revoke_access_to_views", + "views[].can_revoke_access_to_views[]", + "views[].can_see_bank_account_balance", + "views[].can_see_bank_account_bank_name", + "views[].can_see_bank_account_credit_limit", + "views[].can_see_bank_account_currency", + "views[].can_see_bank_account_iban", + "views[].can_see_bank_account_label", + "views[].can_see_bank_account_national_identifier", + "views[].can_see_bank_account_number", + "views[].can_see_bank_account_owners", + "views[].can_see_bank_account_routing_address", + "views[].can_see_bank_account_routing_scheme", + "views[].can_see_bank_account_swift_bic", + "views[].can_see_bank_account_type", + "views[].can_see_bank_routing_address", + "views[].can_see_bank_routing_scheme", + "views[].can_see_comments", + "views[].can_see_corporate_location", + "views[].can_see_image_url", + "views[].can_see_images", + "views[].can_see_more_info", + "views[].can_see_open_corporates_url", + "views[].can_see_other_account_bank_name", + "views[].can_see_other_account_iban", + "views[].can_see_other_account_kind", + "views[].can_see_other_account_metadata", + "views[].can_see_other_account_national_identifier", + "views[].can_see_other_account_number", + "views[].can_see_other_account_routing_address", + "views[].can_see_other_account_routing_scheme", + "views[].can_see_other_account_swift_bic", + "views[].can_see_other_bank_routing_address", + "views[].can_see_other_bank_routing_scheme", + "views[].can_see_owner_comment", + "views[].can_see_physical_location", + "views[].can_see_private_alias", + "views[].can_see_public_alias", + "views[].can_see_tags", + "views[].can_see_transaction_amount", + "views[].can_see_transaction_balance", + "views[].can_see_transaction_currency", + "views[].can_see_transaction_description", + "views[].can_see_transaction_finish_date", + "views[].can_see_transaction_metadata", + "views[].can_see_transaction_other_bank_account", + "views[].can_see_transaction_start_date", + "views[].can_see_transaction_this_bank_account", + "views[].can_see_transaction_type", + "views[].can_see_url", + "views[].can_see_where_tag", + "views[].description", + "views[].hide_metadata_if_alias_used", + "views[].id", + "views[].is_public", + "views[].is_system", + "views[].metadata_view", + "views[].short_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/accounts", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-corePrivateAccountsAllBanks", + "documented_path": "/obp/v5.1.0/my/accounts", + "fields": [ + "accounts", + "accounts[]", + "accounts[].account_routings", + "accounts[].account_routings[]", + "accounts[].account_routings[].address", + "accounts[].account_routings[].scheme", + "accounts[].account_type", + "accounts[].bank_id", + "accounts[].id", + "accounts[].label", + "accounts[].views", + "accounts[].views[]", + "accounts[].views[].description", + "accounts[].views[].id", + "accounts[].views[].is_public", + "accounts[].views[].short_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getTransactionsForBankAccount", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/transactions", + "fields": [ + "transactions", + "transactions[]", + "transactions[].details", + "transactions[].details.completed", + "transactions[].details.description", + "transactions[].details.new_balance", + "transactions[].details.new_balance.amount", + "transactions[].details.new_balance.currency", + "transactions[].details.posted", + "transactions[].details.type", + "transactions[].details.value", + "transactions[].details.value.amount", + "transactions[].details.value.currency", + "transactions[].metadata", + "transactions[].metadata.comments", + "transactions[].metadata.comments[]", + "transactions[].metadata.comments[].date", + "transactions[].metadata.comments[].id", + "transactions[].metadata.comments[].user", + "transactions[].metadata.comments[].user.display_name", + "transactions[].metadata.comments[].user.id", + "transactions[].metadata.comments[].user.provider", + "transactions[].metadata.comments[].value", + "transactions[].metadata.images", + "transactions[].metadata.images[]", + "transactions[].metadata.images[].URL", + "transactions[].metadata.images[].date", + "transactions[].metadata.images[].id", + "transactions[].metadata.images[].label", + "transactions[].metadata.images[].user", + "transactions[].metadata.images[].user.display_name", + "transactions[].metadata.images[].user.id", + "transactions[].metadata.images[].user.provider", + "transactions[].metadata.narrative", + "transactions[].metadata.tags", + "transactions[].metadata.tags[]", + "transactions[].metadata.tags[].date", + "transactions[].metadata.tags[].id", + "transactions[].metadata.tags[].user", + "transactions[].metadata.tags[].user.display_name", + "transactions[].metadata.tags[].user.id", + "transactions[].metadata.tags[].user.provider", + "transactions[].metadata.tags[].value", + "transactions[].metadata.where", + "transactions[].metadata.where.date", + "transactions[].metadata.where.latitude", + "transactions[].metadata.where.longitude", + "transactions[].metadata.where.user", + "transactions[].metadata.where.user.display_name", + "transactions[].metadata.where.user.id", + "transactions[].metadata.where.user.provider", + "transactions[].other_account", + "transactions[].other_account.account_id", + "transactions[].other_account.account_routings", + "transactions[].other_account.account_routings[]", + "transactions[].other_account.account_routings[].address", + "transactions[].other_account.account_routings[].scheme", + "transactions[].other_account.bank_id", + "transactions[].other_account.bank_routing", + "transactions[].other_account.bank_routing.address", + "transactions[].other_account.bank_routing.scheme", + "transactions[].other_account.holder", + "transactions[].other_account.holder.is_alias", + "transactions[].other_account.holder.name", + "transactions[].other_account.metadata", + "transactions[].other_account.metadata.URL", + "transactions[].other_account.metadata.corporate_location", + "transactions[].other_account.metadata.corporate_location.date", + "transactions[].other_account.metadata.corporate_location.latitude", + "transactions[].other_account.metadata.corporate_location.longitude", + "transactions[].other_account.metadata.corporate_location.user", + "transactions[].other_account.metadata.corporate_location.user.display_name", + "transactions[].other_account.metadata.corporate_location.user.id", + "transactions[].other_account.metadata.corporate_location.user.provider", + "transactions[].other_account.metadata.image_URL", + "transactions[].other_account.metadata.more_info", + "transactions[].other_account.metadata.open_corporates_URL", + "transactions[].other_account.metadata.physical_location", + "transactions[].other_account.metadata.physical_location.date", + "transactions[].other_account.metadata.physical_location.latitude", + "transactions[].other_account.metadata.physical_location.longitude", + "transactions[].other_account.metadata.physical_location.user", + "transactions[].other_account.metadata.physical_location.user.display_name", + "transactions[].other_account.metadata.physical_location.user.id", + "transactions[].other_account.metadata.physical_location.user.provider", + "transactions[].other_account.metadata.private_alias", + "transactions[].other_account.metadata.public_alias", + "transactions[].this_account", + "transactions[].this_account.account_id", + "transactions[].this_account.account_routings", + "transactions[].this_account.account_routings[]", + "transactions[].this_account.account_routings[].address", + "transactions[].this_account.account_routings[].scheme", + "transactions[].this_account.bank_id", + "transactions[].this_account.bank_routing", + "transactions[].this_account.bank_routing.address", + "transactions[].this_account.bank_routing.scheme", + "transactions[].this_account.holders", + "transactions[].this_account.holders[]", + "transactions[].this_account.holders[].is_alias", + "transactions[].this_account.holders[].name", + "transactions[].transaction_attributes", + "transactions[].transaction_attributes[]", + "transactions[].transaction_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getPrivateAccountByIdFull", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/account", + "fields": [ + "account_attributes", + "account_attributes[]", + "account_attributes[].account_attribute_id", + "account_attributes[].name", + "account_attributes[].product_code", + "account_attributes[].product_instance_code", + "account_attributes[].type", + "account_attributes[].value", + "account_routings", + "account_routings[]", + "account_routings[].address", + "account_routings[].scheme", + "balance", + "balance.amount", + "balance.currency", + "bank_id", + "id", + "label", + "number", + "owners", + "owners[]", + "owners[].display_name", + "owners[].id", + "owners[].provider", + "product_code", + "tags", + "tags[]", + "tags[].date", + "tags[].id", + "tags[].user", + "tags[].user.display_name", + "tags[].user.id", + "tags[].user.provider", + "tags[].value", + "views_available", + "views_available[]", + "views_available[].account_id", + "views_available[].alias", + "views_available[].allowed_actions", + "views_available[].allowed_actions[]", + "views_available[].bank_id", + "views_available[].can_grant_access_to_views", + "views_available[].can_grant_access_to_views[]", + "views_available[].can_revoke_access_to_views", + "views_available[].can_revoke_access_to_views[]", + "views_available[].description", + "views_available[].hide_metadata_if_alias_used", + "views_available[].is_firehose", + "views_available[].is_public", + "views_available[].is_system", + "views_available[].metadata_view", + "views_available[].view_id", + "views_available[].view_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getExplicitCounterpartyById", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/accounts/ACCOUNT_ID/VIEW_ID/counterparties/COUNTERPARTY_ID", + "fields": [ + "bespoke", + "bespoke[]", + "bespoke[].key", + "bespoke[].value", + "counterparty_id", + "created_by_user_id", + "currency", + "description", + "is_beneficiary", + "metadata", + "metadata.corporate_location", + "metadata.corporate_location.date", + "metadata.corporate_location.latitude", + "metadata.corporate_location.longitude", + "metadata.corporate_location.user", + "metadata.corporate_location.user.id", + "metadata.corporate_location.user.provider", + "metadata.corporate_location.user.username", + "metadata.image_url", + "metadata.more_info", + "metadata.open_corporates_url", + "metadata.physical_location", + "metadata.physical_location.date", + "metadata.physical_location.latitude", + "metadata.physical_location.longitude", + "metadata.physical_location.user", + "metadata.physical_location.user.id", + "metadata.physical_location.user.provider", + "metadata.physical_location.user.username", + "metadata.private_alias", + "metadata.public_alias", + "metadata.url", + "name", + "other_account_routing_address", + "other_account_routing_scheme", + "other_account_secondary_routing_address", + "other_account_secondary_routing_scheme", + "other_bank_routing_address", + "other_bank_routing_scheme", + "other_branch_routing_address", + "other_branch_routing_scheme", + "this_account_id", + "this_bank_id", + "this_view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getMandates", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/accounts/ACCOUNT_ID/mandates", + "fields": [ + "mandates", + "mandates[]", + "mandates[].account_id", + "mandates[].bank_id", + "mandates[].created_by_user_id", + "mandates[].customer_id", + "mandates[].description", + "mandates[].legal_text", + "mandates[].mandate_id", + "mandates[].mandate_name", + "mandates[].mandate_reference", + "mandates[].status", + "mandates[].updated_by_user_id", + "mandates[].valid_from", + "mandates[].valid_to" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSignatoryPanels", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels", + "fields": [ + "signatory_panels", + "signatory_panels[]", + "signatory_panels[].description", + "signatory_panels[].mandate_id", + "signatory_panels[].panel_id", + "signatory_panels[].panel_name", + "signatory_panels[].user_ids", + "signatory_panels[].user_ids[]" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels/PANEL_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-deleteSignatoryPanel", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels/PANEL_ID", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels/PANEL_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSignatoryPanel", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels/PANEL_ID", + "fields": [ + "description", + "mandate_id", + "panel_id", + "panel_name", + "user_ids", + "user_ids[]" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels/PANEL_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-updateSignatoryPanel", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels/PANEL_ID", + "fields": [ + "description", + "mandate_id", + "panel_id", + "panel_name", + "user_ids", + "user_ids[]" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createSignatoryPanel", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/mandates/MANDATE_ID/signatory-panels", + "fields": [ + "description", + "mandate_id", + "panel_id", + "panel_name", + "user_ids", + "user_ids[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getMyApiCollections", + "documented_path": "/obp/v6.0.0/my/api-collections", + "fields": [ + "api_collections", + "api_collections[]", + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description", + "api_collections[].is_sharable", + "api_collections[].user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/api-collections", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createMyApiCollection", + "documented_path": "/obp/v6.0.0/my/api-collections", + "fields": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable", + "user_id" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteMyApiCollection", + "documented_path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "fields": [ + "value" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoint-ids/API_COLLECTION_ENDPOINT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-deleteMyApiCollectionEndpointById", + "documented_path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoint-ids/API_COLLECTION_ENDPOINT_ID", + "fields": [ + "value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getMyApiCollectionEndpointsById", + "documented_path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints", + "fields": [ + "api_collection_endpoints", + "api_collection_endpoints[]", + "api_collection_endpoints[].api_collection_endpoint_id", + "api_collection_endpoints[].api_collection_id", + "api_collection_endpoints[].operation_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createMyApiCollectionEndpointById", + "documented_path": "/obp/v6.0.0/my/api-collection-ids/API_COLLECTION_ID/api-collection-endpoints", + "fields": [ + "api_collection_endpoint_id", + "api_collection_id", + "operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getMyApiCollections", + "documented_path": "/obp/v6.0.0/my/api-collections", + "fields": [ + "api_collections", + "api_collections[]", + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description", + "api_collections[].is_sharable", + "api_collections[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getMyApiCollectionById", + "documented_path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "fields": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable", + "user_id" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-updateMyApiCollection", + "documented_path": "/obp/v6.0.0/my/api-collections/API_COLLECTION_ID", + "fields": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/consents", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getMyConsents", + "documented_path": "/obp/v5.1.0/my/consents", + "fields": [ + "consents", + "consents[]", + "consents[].api_standard", + "consents[].api_version", + "consents[].consent_id", + "consents[].consent_reference_id", + "consents[].consumer_id", + "consents[].created_by_user_id", + "consents[].jwt", + "consents[].jwt_expires_at", + "consents[].jwt_payload", + "consents[].last_action_date", + "consents[].last_usage_date", + "consents[].status" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v5.1.0/my/consents/CONSENT_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-revokeMyConsent", + "documented_path": "/obp/v5.1.0/my/consents/CONSENT_ID", + "fields": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/users/current/consumers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-getConsumersForCurrentUser", + "documented_path": "/obp/v6.0.0/management/users/current/consumers", + "fields": [ + "consumers", + "consumers[]", + "consumers[].app_name", + "consumers[].app_type", + "consumers[].consumer_id", + "consumers[].created", + "consumers[].created_by_user", + "consumers[].created_by_user.email", + "consumers[].created_by_user.provider", + "consumers[].created_by_user.provider_id", + "consumers[].created_by_user.user_id", + "consumers[].created_by_user.username", + "consumers[].description", + "consumers[].developer_email", + "consumers[].enabled", + "consumers[].redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getBanks", + "documented_path": "/obp/v5.1.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].bank_routing", + "banks[].bank_routing.address", + "banks[].bank_routing.scheme", + "banks[].full_name", + "banks[].id", + "banks[].logo", + "banks[].short_name", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getEntitlementsForCurrentUser", + "documented_path": "/obp/v5.1.0/my/entitlements", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].entitlement_id", + "list[].role_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/roles", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.1.0-getRoles", + "documented_path": "/obp/v5.1.0/roles", + "fields": [ + "roles", + "roles[]", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/users/USER_ID/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.0.0-addEntitlement", + "documented_path": "/obp/v5.1.0/users/USER_ID/entitlements", + "fields": [ + "bank_id", + "entitlement_id", + "role_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/users/current/consumers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-getConsumersForCurrentUser", + "documented_path": "/obp/v6.0.0/management/users/current/consumers", + "fields": [ + "consumers", + "consumers[]", + "consumers[].app_name", + "consumers[].app_type", + "consumers[].consumer_id", + "consumers[].created", + "consumers[].created_by_user", + "consumers[].created_by_user.email", + "consumers[].created_by_user.provider", + "consumers[].created_by_user.provider_id", + "consumers[].created_by_user.user_id", + "consumers[].created_by_user.username", + "consumers[].description", + "consumers[].developer_email", + "consumers[].enabled", + "consumers[].redirect_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/my/metrics", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getMyMetrics", + "documented_path": "/obp/v7.0.0/my/metrics", + "fields": [ + "metrics", + "metrics[]", + "metrics[].api_instance_id", + "metrics[].app_name", + "metrics[].auth_type", + "metrics[].certificate_trust", + "metrics[].certificate_trust_detail", + "metrics[].consent_reference_id", + "metrics[].consumer_id", + "metrics[].correlation_id", + "metrics[].date", + "metrics[].developer_email", + "metrics[].duration", + "metrics[].forwarded_for", + "metrics[].implemented_by_partial_function", + "metrics[].implemented_in_version", + "metrics[].operation_id", + "metrics[].response_body", + "metrics[].response_body.code", + "metrics[].response_body.message", + "metrics[].source_ip", + "metrics[].status_code", + "metrics[].target_ip", + "metrics[].url", + "metrics[].user_id", + "metrics[].username", + "metrics[].verb" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/personal-dynamic-entities/available", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAvailablePersonalDynamicEntities", + "documented_path": "/obp/v6.0.0/personal-dynamic-entities/available", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[]._links", + "dynamic_entities[]._links.related", + "dynamic_entities[]._links.related[]", + "dynamic_entities[]._links.related[].href", + "dynamic_entities[]._links.related[].method", + "dynamic_entities[]._links.related[].rel", + "dynamic_entities[].auth_mode", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/personal-data-fields", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getPersonalDataFields", + "documented_path": "/obp/v6.0.0/my/personal-data-fields", + "fields": [ + "user_attributes", + "user_attributes[]", + "user_attributes[].insert_date", + "user_attributes[].is_personal", + "user_attributes[].name", + "user_attributes[].type", + "user_attributes[].user_attribute_id", + "user_attributes[].value" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/personal-data-fields", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createPersonalDataField", + "documented_path": "/obp/v6.0.0/my/personal-data-fields", + "fields": [ + "insert_date", + "is_personal", + "name", + "type", + "user_attribute_id", + "value" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-deletePersonalDataField", + "documented_path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "fields": [] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-updatePersonalDataField", + "documented_path": "/obp/v6.0.0/my/personal-data-fields/USER_ATTRIBUTE_ID", + "fields": [ + "insert_date", + "is_personal", + "name", + "type", + "user_attribute_id", + "value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/app-directory", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAppDirectory", + "documented_path": "/obp/v6.0.0/app-directory", + "fields": [ + "app_directory", + "app_directory[]", + "app_directory[].name", + "app_directory[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemChatRooms", + "documented_path": "/obp/v6.0.0/chat-rooms", + "fields": [ + "chat_rooms", + "chat_rooms[]", + "chat_rooms[].bank_id", + "chat_rooms[].chat_room_id", + "chat_rooms[].created_at", + "chat_rooms[].created_by_provider", + "chat_rooms[].created_by_user_id", + "chat_rooms[].created_by_username", + "chat_rooms[].description", + "chat_rooms[].is_archived", + "chat_rooms[].is_open_room", + "chat_rooms[].joining_key", + "chat_rooms[].last_message_at", + "chat_rooms[].last_message_preview", + "chat_rooms[].last_message_sender_username", + "chat_rooms[].name", + "chat_rooms[].participant_count", + "chat_rooms[].unread_count", + "chat_rooms[].updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/personal-data-fields", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getPersonalDataFields", + "documented_path": "/obp/v6.0.0/my/personal-data-fields", + "fields": [ + "user_attributes", + "user_attributes[]", + "user_attributes[].insert_date", + "user_attributes[].is_personal", + "user_attributes[].name", + "user_attributes[].type", + "user_attributes[].user_attribute_id", + "user_attributes[].value" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/roles", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.1.0-getRoles", + "documented_path": "/obp/v5.1.0/roles", + "fields": [ + "roles", + "roles[]", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getApiCollectionEndpoints", + "documented_path": "/obp/v6.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints", + "fields": [ + "api_collection_endpoints", + "api_collection_endpoints[]", + "api_collection_endpoints[].api_collection_endpoint_id", + "api_collection_endpoints[].api_collection_id", + "api_collection_endpoints[].operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-collections/sharable/API_COLLECTION_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getSharableApiCollectionById", + "documented_path": "/obp/v6.0.0/api-collections/sharable/API_COLLECTION_ID", + "fields": [ + "api_collection_id", + "api_collection_name", + "description", + "is_sharable", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsObp", + "documented_path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getApiCollectionEndpoints", + "documented_path": "/obp/v6.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints", + "fields": [ + "api_collection_endpoints", + "api_collection_endpoints[]", + "api_collection_endpoints[].api_collection_endpoint_id", + "api_collection_endpoints[].api_collection_id", + "api_collection_endpoints[].operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-collections/featured", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getFeaturedApiCollections", + "documented_path": "/obp/v6.0.0/api-collections/featured", + "fields": [ + "api_collections", + "api_collections[]", + "api_collections[].api_collection_id", + "api_collections[].api_collection_name", + "api_collections[].description", + "api_collections[].is_sharable", + "api_collections[].user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api/popular-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getPopularApis", + "documented_path": "/obp/v6.0.0/api/popular-endpoints", + "fields": [ + "operation_ids", + "operation_ids[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsObp", + "documented_path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/root", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-root", + "documented_path": "/obp/v6.0.0/root", + "fields": [ + "connector", + "energy_source", + "energy_source.organisation", + "energy_source.organisation_website", + "git_commit", + "hosted_at", + "hosted_at.organisation", + "hosted_at.organisation_website", + "hosted_by", + "hosted_by.email", + "hosted_by.organisation", + "hosted_by.organisation_website", + "hosted_by.phone", + "hostname", + "local_identity_provider", + "resource_docs_requires_role", + "version", + "version_status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/products", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAllProductsV600", + "documented_path": "/obp/v6.0.0/products", + "fields": [ + "products", + "products[]", + "products[].bank_id", + "products[].description", + "products[].meta", + "products[].meta.license", + "products[].meta.license.id", + "products[].meta.license.name", + "products[].more_info_url", + "products[].name", + "products[].parent_product_code", + "products[].product_code", + "products[].tags", + "products[].tags[]", + "products[].terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/root", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-root", + "documented_path": "/obp/v6.0.0/root", + "fields": [ + "connector", + "energy_source", + "energy_source.organisation", + "energy_source.organisation_website", + "git_commit", + "hosted_at", + "hosted_at.organisation", + "hosted_at.organisation_website", + "hosted_by", + "hosted_by.email", + "hosted_by.organisation", + "hosted_by.organisation_website", + "hosted_by.phone", + "hostname", + "local_identity_provider", + "resource_docs_requires_role", + "version", + "version_status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/products/PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.0.0-getProduct", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/products/PRODUCT_CODE", + "fields": [ + "attributes", + "attributes[]", + "attributes[].name", + "attributes[].product_attribute_id", + "attributes[].product_code", + "attributes[].type", + "attributes[].value", + "bank_id", + "description", + "fees", + "fees[]", + "fees[].is_active", + "fees[].more_info", + "fees[].name", + "fees[].product_fee_id", + "fees[].value", + "fees[].value.amount", + "fees[].value.currency", + "fees[].value.frequency", + "fees[].value.type", + "meta", + "meta.license", + "meta.license.id", + "meta.license.name", + "more_info_url", + "name", + "parent_product_code", + "product_code", + "terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/products", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getProductsV600", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/products", + "fields": [ + "products", + "products[]", + "products[].bank_id", + "products[].description", + "products[].meta", + "products[].meta.license", + "products[].meta.license.id", + "products[].meta.license.name", + "products[].more_info_url", + "products[].name", + "products[].parent_product_code", + "products[].product_code", + "products[].tags", + "products[].tags[]", + "products[].terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/my/personal-data-fields", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getPersonalDataFields", + "documented_path": "/obp/v6.0.0/my/personal-data-fields", + "fields": [ + "user_attributes", + "user_attributes[]", + "user_attributes[].insert_date", + "user_attributes[].is_personal", + "user_attributes[].name", + "user_attributes[].type", + "user_attributes[].user_attribute_id", + "user_attributes[].value" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/password-reset-url", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-resetPasswordUrlAnonymous", + "documented_path": "/obp/v6.0.0/users/password-reset-url", + "fields": [ + "message" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/current", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getCurrentUser", + "documented_path": "/obp/v5.1.0/users/current", + "fields": [ + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/current", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getCurrentUser", + "documented_path": "/obp/v5.1.0/users/current", + "fields": [ + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-products", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAllApiProductsV600", + "documented_path": "/obp/v6.0.0/api-products", + "fields": [ + "api_products", + "api_products[]", + "api_products[].api_product_code", + "api_products[].api_product_id", + "api_products[].attributes", + "api_products[].attributes[]", + "api_products[].attributes[].api_product_attribute_id", + "api_products[].attributes[].api_product_code", + "api_products[].attributes[].bank_id", + "api_products[].attributes[].is_active", + "api_products[].attributes[].name", + "api_products[].attributes[].type", + "api_products[].attributes[].value", + "api_products[].bank_id", + "api_products[].category", + "api_products[].collection_id", + "api_products[].description", + "api_products[].monthly_subscription_amount", + "api_products[].monthly_subscription_currency", + "api_products[].more_info_url", + "api_products[].name", + "api_products[].parent_api_product_code", + "api_products[].per_day_call_limit", + "api_products[].per_hour_call_limit", + "api_products[].per_minute_call_limit", + "api_products[].per_month_call_limit", + "api_products[].per_second_call_limit", + "api_products[].per_week_call_limit", + "api_products[].tags", + "api_products[].tags[]", + "api_products[].terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/root", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-root", + "documented_path": "/obp/v6.0.0/root", + "fields": [ + "connector", + "energy_source", + "energy_source.organisation", + "energy_source.organisation_website", + "git_commit", + "hosted_at", + "hosted_at.organisation", + "hosted_at.organisation_website", + "hosted_by", + "hosted_by.email", + "hosted_by.organisation", + "hosted_by.organisation_website", + "hosted_by.phone", + "hostname", + "local_identity_provider", + "resource_docs_requires_role", + "version", + "version_status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getApiCollectionEndpoints", + "documented_path": "/obp/v6.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints", + "fields": [ + "api_collection_endpoints", + "api_collection_endpoints[]", + "api_collection_endpoints[].api_collection_endpoint_id", + "api_collection_endpoints[].api_collection_id", + "api_collection_endpoints[].operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getApiProduct", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "fields": [ + "api_product_code", + "api_product_id", + "attributes", + "attributes[]", + "attributes[].api_product_attribute_id", + "attributes[].api_product_code", + "attributes[].bank_id", + "attributes[].is_active", + "attributes[].name", + "attributes[].type", + "attributes[].value", + "bank_id", + "category", + "collection_id", + "description", + "monthly_subscription_amount", + "monthly_subscription_currency", + "more_info_url", + "name", + "parent_api_product_code", + "per_day_call_limit", + "per_hour_call_limit", + "per_minute_call_limit", + "per_month_call_limit", + "per_second_call_limit", + "per_week_call_limit", + "tags", + "tags[]", + "terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsObp", + "documented_path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "fields": [] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/users", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createUser", + "documented_path": "/obp/v7.0.0/users", + "fields": [ + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "mobile_phone_number", + "mobile_phone_number_is_validated", + "provider", + "provider_id", + "user_id", + "username" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/password", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-resetPasswordComplete", + "documented_path": "/obp/v6.0.0/users/password", + "fields": [ + "message" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-products", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAllApiProductsV600", + "documented_path": "/obp/v6.0.0/api-products", + "fields": [ + "api_products", + "api_products[]", + "api_products[].api_product_code", + "api_products[].api_product_id", + "api_products[].attributes", + "api_products[].attributes[]", + "api_products[].attributes[].api_product_attribute_id", + "api_products[].attributes[].api_product_code", + "api_products[].attributes[].bank_id", + "api_products[].attributes[].is_active", + "api_products[].attributes[].name", + "api_products[].attributes[].type", + "api_products[].attributes[].value", + "api_products[].bank_id", + "api_products[].category", + "api_products[].collection_id", + "api_products[].description", + "api_products[].monthly_subscription_amount", + "api_products[].monthly_subscription_currency", + "api_products[].more_info_url", + "api_products[].name", + "api_products[].parent_api_product_code", + "api_products[].per_day_call_limit", + "api_products[].per_hour_call_limit", + "api_products[].per_minute_call_limit", + "api_products[].per_month_call_limit", + "api_products[].per_second_call_limit", + "api_products[].per_week_call_limit", + "api_products[].tags", + "api_products[].tags[]", + "api_products[].terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getApiProduct", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE", + "fields": [ + "api_product_code", + "api_product_id", + "attributes", + "attributes[]", + "attributes[].api_product_attribute_id", + "attributes[].api_product_code", + "attributes[].bank_id", + "attributes[].is_active", + "attributes[].name", + "attributes[].type", + "attributes[].value", + "bank_id", + "category", + "collection_id", + "description", + "monthly_subscription_amount", + "monthly_subscription_currency", + "more_info_url", + "name", + "parent_api_product_code", + "per_day_call_limit", + "per_hour_call_limit", + "per_minute_call_limit", + "per_month_call_limit", + "per_second_call_limit", + "per_week_call_limit", + "tags", + "tags[]", + "terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/management/users/current/consumers", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.1.0-getConsumersForCurrentUser", + "documented_path": "/obp/v6.0.0/management/users/current/consumers", + "fields": [ + "consumers", + "consumers[]", + "consumers[].app_name", + "consumers[].app_type", + "consumers[].consumer_id", + "consumers[].created", + "consumers[].created_by_user", + "consumers[].created_by_user.email", + "consumers[].created_by_user.provider", + "consumers[].created_by_user.provider_id", + "consumers[].created_by_user.user_id", + "consumers[].created_by_user.username", + "consumers[].description", + "consumers[].developer_email", + "consumers[].enabled", + "consumers[].redirect_url" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE/subscriptions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createApiProductSubscription", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/api-products/API_PRODUCT_CODE/subscriptions", + "fields": [ + "api_product_code", + "api_product_subscription_id", + "attributes", + "attributes[]", + "attributes[].api_product_subscription_attribute_id", + "attributes[].api_product_subscription_id", + "attributes[].is_active", + "attributes[].name", + "attributes[].type", + "attributes[].value", + "bank_id", + "consumer_id", + "created_at", + "created_by_user_id", + "rate_limiting_id", + "start_date", + "status", + "updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/my/api-product-subscriptions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getMyApiProductSubscriptions", + "documented_path": "/obp/v7.0.0/my/api-product-subscriptions", + "fields": [ + "api_product_subscriptions", + "api_product_subscriptions[]", + "api_product_subscriptions[].api_product_code", + "api_product_subscriptions[].api_product_subscription_id", + "api_product_subscriptions[].attributes", + "api_product_subscriptions[].attributes[]", + "api_product_subscriptions[].attributes[].api_product_subscription_attribute_id", + "api_product_subscriptions[].attributes[].api_product_subscription_id", + "api_product_subscriptions[].attributes[].is_active", + "api_product_subscriptions[].attributes[].name", + "api_product_subscriptions[].attributes[].type", + "api_product_subscriptions[].attributes[].value", + "api_product_subscriptions[].bank_id", + "api_product_subscriptions[].consumer_id", + "api_product_subscriptions[].created_at", + "api_product_subscriptions[].created_by_user_id", + "api_product_subscriptions[].rate_limiting_id", + "api_product_subscriptions[].start_date", + "api_product_subscriptions[].status", + "api_product_subscriptions[].updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/my/api-product-subscriptions/API_PRODUCT_SUBSCRIPTION_ID/status", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateMyApiProductSubscriptionStatus", + "documented_path": "/obp/v7.0.0/my/api-product-subscriptions/API_PRODUCT_SUBSCRIPTION_ID/status", + "fields": [ + "api_product_code", + "api_product_subscription_id", + "attributes", + "attributes[]", + "attributes[].api_product_subscription_attribute_id", + "attributes[].api_product_subscription_id", + "attributes[].is_active", + "attributes[].name", + "attributes[].type", + "attributes[].value", + "bank_id", + "consumer_id", + "created_at", + "created_by_user_id", + "rate_limiting_id", + "start_date", + "status", + "updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/user-invitation", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-createUserInvitation", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/user-invitation", + "fields": [ + "company", + "country", + "email", + "first_name", + "last_name", + "purpose", + "status" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/banks/BANK_ID/user-invitations", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getUserInvitationAnonymous", + "documented_path": "/obp/v5.1.0/banks/BANK_ID/user-invitations", + "fields": [ + "company", + "country", + "email", + "first_name", + "last_name", + "purpose", + "status" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/users/email-validation", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-validateUserEmail", + "documented_path": "/obp/v6.0.0/users/email-validation", + "fields": [ + "email", + "message", + "provider", + "user_id", + "username", + "validated" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/root", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-root", + "documented_path": "/obp/v5.1.0/root", + "fields": [ + "connector", + "energy_source", + "energy_source.organisation", + "energy_source.organisation_website", + "git_commit", + "hosted_at", + "hosted_at.organisation", + "hosted_at.organisation_website", + "hosted_by", + "hosted_by.email", + "hosted_by.organisation", + "hosted_by.organisation_website", + "hosted_by.phone", + "hostname", + "local_identity_provider", + "resource_docs_requires_role", + "version", + "version_status" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-room-participants", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-joinBankChatRoom", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-room-participants", + "fields": [ + "chat_room_id", + "consumer_id", + "consumer_name", + "is_muted", + "joined_at", + "last_read_at", + "participant_id", + "permissions", + "permissions[]", + "provider", + "user_id", + "username", + "webhook_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBankChatRooms", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms", + "fields": [ + "chat_rooms", + "chat_rooms[]", + "chat_rooms[].bank_id", + "chat_rooms[].chat_room_id", + "chat_rooms[].created_at", + "chat_rooms[].created_by_provider", + "chat_rooms[].created_by_user_id", + "chat_rooms[].created_by_username", + "chat_rooms[].description", + "chat_rooms[].is_archived", + "chat_rooms[].is_open_room", + "chat_rooms[].joining_key", + "chat_rooms[].last_message_at", + "chat_rooms[].last_message_preview", + "chat_rooms[].last_message_sender_username", + "chat_rooms[].name", + "chat_rooms[].participant_count", + "chat_rooms[].unread_count", + "chat_rooms[].updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createBankChatRoom", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBankChatRoom", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-updateBankChatRoom", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/joining-key", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-refreshBankJoiningKey", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/joining-key", + "fields": [ + "joining_key" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBankChatMessages", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages", + "fields": [ + "messages", + "messages[]", + "messages[].chat_message_id", + "messages[].chat_room_id", + "messages[].content", + "messages[].created_at", + "messages[].is_deleted", + "messages[].mentioned_user_ids", + "messages[].mentioned_user_ids[]", + "messages[].message_type", + "messages[].reactions", + "messages[].reactions[]", + "messages[].reactions[].count", + "messages[].reactions[].emoji", + "messages[].reactions[].user_ids", + "messages[].reactions[].user_ids[]", + "messages[].reply_to_message_id", + "messages[].sender_consumer_id", + "messages[].sender_consumer_name", + "messages[].sender_provider", + "messages[].sender_user_id", + "messages[].sender_username", + "messages[].thread_id", + "messages[].updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-sendBankChatMessage", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages", + "fields": [ + "chat_message_id", + "chat_room_id", + "content", + "created_at", + "is_deleted", + "mentioned_user_ids", + "mentioned_user_ids[]", + "message_type", + "reactions", + "reactions[]", + "reply_to_message_id", + "sender_consumer_id", + "sender_consumer_name", + "sender_provider", + "sender_user_id", + "sender_username", + "thread_id", + "updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages", + "docs_from": "https://k8s.openbankproject.com", + "missing": true + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID/reactions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-addBankReaction", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID/reactions", + "fields": [ + "chat_message_id", + "created_at", + "emoji", + "provider", + "reaction_id", + "user_id", + "username" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID/reactions/EMOJI_REACTION", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-removeBankReaction", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID/reactions/EMOJI_REACTION", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/participants", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBankChatRoomParticipants", + "documented_path": "/obp/v6.0.0/banks/BANK_ID/chat-rooms/CHAT_ROOM_ID/participants", + "fields": [ + "participants", + "participants[]", + "participants[].chat_room_id", + "participants[].consumer_id", + "participants[].consumer_name", + "participants[].is_muted", + "participants[].joined_at", + "participants[].last_read_at", + "participants[].participant_id", + "participants[].permissions", + "participants[].permissions[]", + "participants[].provider", + "participants[].user_id", + "participants[].username", + "participants[].webhook_url" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-room-participants", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-joinSystemChatRoom", + "documented_path": "/obp/v6.0.0/chat-room-participants", + "fields": [ + "chat_room_id", + "consumer_id", + "consumer_name", + "is_muted", + "joined_at", + "last_read_at", + "participant_id", + "permissions", + "permissions[]", + "provider", + "user_id", + "username", + "webhook_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemChatRooms", + "documented_path": "/obp/v6.0.0/chat-rooms", + "fields": [ + "chat_rooms", + "chat_rooms[]", + "chat_rooms[].bank_id", + "chat_rooms[].chat_room_id", + "chat_rooms[].created_at", + "chat_rooms[].created_by_provider", + "chat_rooms[].created_by_user_id", + "chat_rooms[].created_by_username", + "chat_rooms[].description", + "chat_rooms[].is_archived", + "chat_rooms[].is_open_room", + "chat_rooms[].joining_key", + "chat_rooms[].last_message_at", + "chat_rooms[].last_message_preview", + "chat_rooms[].last_message_sender_username", + "chat_rooms[].name", + "chat_rooms[].participant_count", + "chat_rooms[].unread_count", + "chat_rooms[].updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createSystemChatRoom", + "documented_path": "/obp/v6.0.0/chat-rooms", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemChatRoom", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-updateSystemChatRoom", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID", + "fields": [ + "bank_id", + "chat_room_id", + "created_at", + "created_by_provider", + "created_by_user_id", + "created_by_username", + "description", + "is_archived", + "is_open_room", + "joining_key", + "last_message_at", + "last_message_preview", + "last_message_sender_username", + "name", + "participant_count", + "unread_count", + "updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/joining-key", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-refreshSystemJoiningKey", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/joining-key", + "fields": [ + "joining_key" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemChatMessages", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages", + "fields": [ + "messages", + "messages[]", + "messages[].chat_message_id", + "messages[].chat_room_id", + "messages[].content", + "messages[].created_at", + "messages[].is_deleted", + "messages[].mentioned_user_ids", + "messages[].mentioned_user_ids[]", + "messages[].message_type", + "messages[].reactions", + "messages[].reactions[]", + "messages[].reactions[].count", + "messages[].reactions[].emoji", + "messages[].reactions[].user_ids", + "messages[].reactions[].user_ids[]", + "messages[].reply_to_message_id", + "messages[].sender_consumer_id", + "messages[].sender_consumer_name", + "messages[].sender_provider", + "messages[].sender_user_id", + "messages[].sender_username", + "messages[].thread_id", + "messages[].updated_at" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-sendSystemChatMessage", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages", + "fields": [ + "chat_message_id", + "chat_room_id", + "content", + "created_at", + "is_deleted", + "mentioned_user_ids", + "mentioned_user_ids[]", + "message_type", + "reactions", + "reactions[]", + "reply_to_message_id", + "sender_consumer_id", + "sender_consumer_name", + "sender_provider", + "sender_user_id", + "sender_username", + "thread_id", + "updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages", + "docs_from": "https://k8s.openbankproject.com", + "missing": true + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID/reactions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-addSystemReaction", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID/reactions", + "fields": [ + "chat_message_id", + "created_at", + "emoji", + "provider", + "reaction_id", + "user_id", + "username" + ] + }, + { + "verb": "DELETE", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID/reactions/EMOJI_REACTION", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-removeSystemReaction", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/messages/CHAT_MESSAGE_ID/reactions/EMOJI_REACTION", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getSystemChatRoomParticipants", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "fields": [ + "participants", + "participants[]", + "participants[].chat_room_id", + "participants[].consumer_id", + "participants[].consumer_name", + "participants[].is_muted", + "participants[].joined_at", + "participants[].last_read_at", + "participants[].participant_id", + "participants[].permissions", + "participants[].permissions[]", + "participants[].provider", + "participants[].user_id", + "participants[].username", + "participants[].webhook_url" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-addSystemChatRoomParticipant", + "documented_path": "/obp/v6.0.0/chat-rooms/CHAT_ROOM_ID/participants", + "fields": [ + "chat_room_id", + "consumer_id", + "consumer_name", + "is_muted", + "joined_at", + "last_read_at", + "participant_id", + "permissions", + "permissions[]", + "provider", + "user_id", + "username", + "webhook_url" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/chat-rooms/search", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-searchChatRooms", + "documented_path": "/obp/v6.0.0/chat-rooms/search", + "fields": [ + "chat_rooms", + "chat_rooms[]", + "chat_rooms[].bank_id", + "chat_rooms[].chat_room_id", + "chat_rooms[].created_at", + "chat_rooms[].created_by_provider", + "chat_rooms[].created_by_user_id", + "chat_rooms[].created_by_username", + "chat_rooms[].description", + "chat_rooms[].is_archived", + "chat_rooms[].is_open_room", + "chat_rooms[].joining_key", + "chat_rooms[].last_message_at", + "chat_rooms[].last_message_preview", + "chat_rooms[].last_message_sender_username", + "chat_rooms[].name", + "chat_rooms[].participant_count", + "chat_rooms[].unread_count", + "chat_rooms[].updated_at" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/users/current/chat-rooms", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getMyChatRooms", + "documented_path": "/obp/v6.0.0/users/current/chat-rooms", + "fields": [ + "chat_rooms", + "chat_rooms[]", + "chat_rooms[].bank_id", + "chat_rooms[].chat_room_id", + "chat_rooms[].created_at", + "chat_rooms[].created_by_provider", + "chat_rooms[].created_by_user_id", + "chat_rooms[].created_by_username", + "chat_rooms[].description", + "chat_rooms[].is_archived", + "chat_rooms[].is_open_room", + "chat_rooms[].joining_key", + "chat_rooms[].last_message_at", + "chat_rooms[].last_message_preview", + "chat_rooms[].last_message_sender_username", + "chat_rooms[].name", + "chat_rooms[].participant_count", + "chat_rooms[].unread_count", + "chat_rooms[].updated_at" + ] + }, + { + "verb": "PUT", + "path": "/obp/v6.0.0/users/current/chat-rooms/CHAT_ROOM_ID/read-marker", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-markChatRoomRead", + "documented_path": "/obp/v6.0.0/users/current/chat-rooms/CHAT_ROOM_ID/read-marker", + "fields": [ + "chat_room_id", + "consumer_id", + "consumer_name", + "is_muted", + "joined_at", + "last_read_at", + "participant_id", + "permissions", + "permissions[]", + "provider", + "user_id", + "username", + "webhook_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/my/accounts", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-corePrivateAccountsAllBanks", + "documented_path": "/obp/v7.0.0/my/accounts", + "fields": [ + "accounts", + "accounts[]", + "accounts[].account_id", + "accounts[].account_routings", + "accounts[].account_routings[]", + "accounts[].account_routings[].address", + "accounts[].account_routings[].scheme", + "accounts[].account_type", + "accounts[].bank_id", + "accounts[].label", + "accounts[].views", + "accounts[].views[]", + "accounts[].views[].description", + "accounts[].views[].is_public", + "accounts[].views[].short_name", + "accounts[].views[].view_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getEntitlementsForCurrentUser", + "documented_path": "/obp/v5.1.0/my/entitlements", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].entitlement_id", + "list[].role_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getEntitlementsForCurrentUser", + "documented_path": "/obp/v5.1.0/my/entitlements", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].entitlement_id", + "list[].role_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/consents", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getMyConsents", + "documented_path": "/obp/v5.1.0/my/consents", + "fields": [ + "consents", + "consents[]", + "consents[].api_standard", + "consents[].api_version", + "consents[].consent_id", + "consents[].consent_reference_id", + "consents[].consumer_id", + "consents[].created_by_user_id", + "consents[].jwt", + "consents[].jwt_expires_at", + "consents[].jwt_payload", + "consents[].last_action_date", + "consents[].last_usage_date", + "consents[].status" + ] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/consumers/current/platform-app", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateCurrentConsumerPlatformApp", + "documented_path": "/obp/v7.0.0/consumers/current/platform-app", + "fields": [ + "consumer_id", + "consumer_name", + "declared_at", + "label", + "marked_at", + "marked_by_user_id", + "required_scopes", + "required_scopes[]", + "required_scopes[].bank_id", + "required_scopes[].held", + "required_scopes[].needed_for", + "required_scopes[].optional", + "required_scopes[].role_name", + "state", + "version" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/consumers/current/scopes", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getCurrentConsumerScopes", + "documented_path": "/obp/v7.0.0/consumers/current/scopes", + "fields": [ + "consumer_id", + "scopes", + "scopes[]", + "scopes[].bank_id", + "scopes[].role_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/consumers/current/identity", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getCurrentConsumerIdentity", + "documented_path": "/obp/v7.0.0/consumers/current/identity", + "fields": [ + "consumer_id", + "consumer_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/consents", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getMyConsents", + "documented_path": "/obp/v5.1.0/my/consents", + "fields": [ + "consents", + "consents[]", + "consents[].api_standard", + "consents[].api_version", + "consents[].consent_id", + "consents[].consent_reference_id", + "consents[].consumer_id", + "consents[].created_by_user_id", + "consents[].jwt", + "consents[].jwt_expires_at", + "consents[].jwt_payload", + "consents[].last_action_date", + "consents[].last_usage_date", + "consents[].status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/root", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-root", + "documented_path": "/obp/v6.0.0/root", + "fields": [ + "connector", + "energy_source", + "energy_source.organisation", + "energy_source.organisation_website", + "git_commit", + "hosted_at", + "hosted_at.organisation", + "hosted_at.organisation_website", + "hosted_by", + "hosted_by.email", + "hosted_by.organisation", + "hosted_by.organisation_website", + "hosted_by.phone", + "hostname", + "local_identity_provider", + "resource_docs_requires_role", + "version", + "version_status" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/public/chat-config", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getChatConfig", + "documented_path": "/obp/v7.0.0/public/chat-config", + "fields": [ + "allowed_link_hosts", + "allowed_link_hosts[]", + "max_message_length" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api/versions", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getScannedApiVersions", + "documented_path": "/obp/v6.0.0/api/versions", + "fields": [ + "scanned_api_versions", + "scanned_api_versions[]", + "scanned_api_versions[].api_short_version", + "scanned_api_versions[].api_standard", + "scanned_api_versions[].fully_qualified_version", + "scanned_api_versions[].is_active", + "scanned_api_versions[].url_prefix" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/api/glossary", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getGlossary", + "documented_path": "/obp/v7.0.0/api/glossary", + "fields": [ + "glossary_items", + "glossary_items[]", + "glossary_items[].description", + "glossary_items[].description.html", + "glossary_items[].description.markdown", + "glossary_items[].is_dynamic", + "glossary_items[].overrides_static_item", + "glossary_items[].shadows_static_glossary_item", + "glossary_items[].title", + "total_count" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/message-docs/CONNECTOR", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.2.0-getMessageDocs", + "documented_path": "/obp/v5.1.0/message-docs/CONNECTOR", + "fields": [ + "message_docs", + "message_docs[]", + "message_docs[].adapter_implementation", + "message_docs[].adapter_implementation.group", + "message_docs[].adapter_implementation.suggested_order", + "message_docs[].dependent_endpoints", + "message_docs[].dependent_endpoints[]", + "message_docs[].dependent_endpoints[].name", + "message_docs[].dependent_endpoints[].version", + "message_docs[].description", + "message_docs[].example_inbound_message", + "message_docs[].example_inbound_message.jsonString", + "message_docs[].example_outbound_message", + "message_docs[].example_outbound_message.jsonString", + "message_docs[].inboundAvroSchema", + "message_docs[].inboundAvroSchema.jsonString", + "message_docs[].inbound_topic", + "message_docs[].message_format", + "message_docs[].outboundAvroSchema", + "message_docs[].outboundAvroSchema.jsonString", + "message_docs[].outbound_topic", + "message_docs[].process", + "message_docs[].requiredFieldInfo", + "message_docs[].requiredFieldInfo.data.bankId", + "message_docs[].requiredFieldInfo.data.bankId[]" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsObp", + "documented_path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv4.0.0-getApiCollectionEndpoints", + "documented_path": "/obp/v6.0.0/api-collections/API_COLLECTION_ID/api-collection-endpoints", + "fields": [ + "api_collection_endpoints", + "api_collection_endpoints[]", + "api_collection_endpoints[].api_collection_endpoint_id", + "api_collection_endpoints[].api_collection_id", + "api_collection_endpoints[].operation_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/api-products", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getAllApiProductsV600", + "documented_path": "/obp/v6.0.0/api-products", + "fields": [ + "api_products", + "api_products[]", + "api_products[].api_product_code", + "api_products[].api_product_id", + "api_products[].attributes", + "api_products[].attributes[]", + "api_products[].attributes[].api_product_attribute_id", + "api_products[].attributes[].api_product_code", + "api_products[].attributes[].bank_id", + "api_products[].attributes[].is_active", + "api_products[].attributes[].name", + "api_products[].attributes[].type", + "api_products[].attributes[].value", + "api_products[].bank_id", + "api_products[].category", + "api_products[].collection_id", + "api_products[].description", + "api_products[].monthly_subscription_amount", + "api_products[].monthly_subscription_currency", + "api_products[].more_info_url", + "api_products[].name", + "api_products[].parent_api_product_code", + "api_products[].per_day_call_limit", + "api_products[].per_hour_call_limit", + "api_products[].per_minute_call_limit", + "api_products[].per_month_call_limit", + "api_products[].per_second_call_limit", + "api_products[].per_week_call_limit", + "api_products[].tags", + "api_products[].tags[]", + "api_products[].terms_and_conditions_url" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsObp", + "documented_path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/banks/BANK_ID/my/roles/ROLE_NAME", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getMyRole", + "documented_path": "/obp/v7.0.0/banks/BANK_ID/my/roles/ROLE_NAME", + "fields": [ + "allowed_for_auth_modes", + "allowed_for_auth_modes[]", + "bank_id", + "caller", + "caller.application_only", + "caller.consumer_id", + "caller.user_id", + "held_by", + "held_by.consumer", + "held_by.user", + "role_name", + "scopes_required" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/well-known", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getOAuth2ServerWellKnown", + "documented_path": "/obp/v5.1.0/well-known", + "fields": [ + "jwks_uris", + "jwks_uris[]", + "jwks_uris[].jwks_uri" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/consents", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getMyConsents", + "documented_path": "/obp/v5.1.0/my/consents", + "fields": [ + "consents", + "consents[]", + "consents[].api_standard", + "consents[].api_version", + "consents[].consent_id", + "consents[].consent_reference_id", + "consents[].consumer_id", + "consents[].created_by_user_id", + "consents[].jwt", + "consents[].jwt_expires_at", + "consents[].jwt_payload", + "consents[].last_action_date", + "consents[].last_usage_date", + "consents[].status" + ] + }, + { + "verb": "POST", + "path": "/obp/v5.1.0/my/consents/IMPLICIT", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-createConsent", + "documented_path": "/obp/v5.1.0/my/consents/IMPLICIT", + "fields": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/consents", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv5.1.0-getMyConsents", + "documented_path": "/obp/v5.1.0/my/consents", + "fields": [ + "consents", + "consents[]", + "consents[].api_standard", + "consents[].api_version", + "consents[].consent_id", + "consents[].consent_reference_id", + "consents[].consumer_id", + "consents[].created_by_user_id", + "consents[].jwt", + "consents[].jwt_expires_at", + "consents[].jwt_payload", + "consents[].last_action_date", + "consents[].last_usage_date", + "consents[].status" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/public/consent-config", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getConsentsConfig", + "documented_path": "/obp/v7.0.0/public/consent-config", + "fields": [ + "consents_allowed", + "max_time_to_live_in_seconds", + "sca_enabled" + ] + }, + { + "verb": "GET", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-getDynamicEntityDefinitions", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "dynamic_entities", + "dynamic_entities[]", + "dynamic_entities[].auth_mode", + "dynamic_entities[].bank_id", + "dynamic_entities[].dynamic_entity_id", + "dynamic_entities[].entity_name", + "dynamic_entities[].has_community_access", + "dynamic_entities[].has_personal_entity", + "dynamic_entities[].has_public_access", + "dynamic_entities[].personal_requires_role", + "dynamic_entities[].record_count", + "dynamic_entities[].schema", + "dynamic_entities[].schema.description", + "dynamic_entities[].schema.properties", + "dynamic_entities[].schema.properties.language", + "dynamic_entities[].schema.properties.language.description", + "dynamic_entities[].schema.properties.language.example", + "dynamic_entities[].schema.properties.language.maxLength", + "dynamic_entities[].schema.properties.language.minLength", + "dynamic_entities[].schema.properties.language.type", + "dynamic_entities[].schema.properties.theme", + "dynamic_entities[].schema.properties.theme.description", + "dynamic_entities[].schema.properties.theme.example", + "dynamic_entities[].schema.properties.theme.indexed", + "dynamic_entities[].schema.properties.theme.maxLength", + "dynamic_entities[].schema.properties.theme.minLength", + "dynamic_entities[].schema.properties.theme.type", + "dynamic_entities[].schema.required", + "dynamic_entities[].schema.required[]", + "dynamic_entities[].schema.required[].s", + "dynamic_entities[].use_row_level_access", + "dynamic_entities[].user_id" + ] + }, + { + "verb": "POST", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-createDynamicEntityDefinition", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities", + "fields": [ + "auth_mode", + "bank_id", + "dynamic_entity_id", + "entity_name", + "has_community_access", + "has_personal_entity", + "has_public_access", + "personal_requires_role", + "schema", + "schema.description", + "schema.properties", + "schema.properties.language", + "schema.properties.language.description", + "schema.properties.language.example", + "schema.properties.language.maxLength", + "schema.properties.language.minLength", + "schema.properties.language.type", + "schema.properties.theme", + "schema.properties.theme.description", + "schema.properties.theme.example", + "schema.properties.theme.indexed", + "schema.properties.theme.maxLength", + "schema.properties.theme.minLength", + "schema.properties.theme.type", + "schema.required", + "schema.required[]", + "schema.required[].s", + "use_row_level_access", + "user_id" + ] + }, + { + "verb": "PUT", + "path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv7.0.0-updateDynamicEntityDefinition", + "documented_path": "/obp/v7.0.0/management/banks/BANK_ID/dynamic-entities/DYNAMIC_ENTITY_ID", + "fields": [ + "auth_mode", + "bank_id", + "dynamic_entity_id", + "entity_name", + "has_community_access", + "has_personal_entity", + "has_public_access", + "personal_requires_role", + "schema", + "schema.description", + "schema.properties", + "schema.properties.language", + "schema.properties.language.description", + "schema.properties.language.example", + "schema.properties.language.maxLength", + "schema.properties.language.minLength", + "schema.properties.language.type", + "schema.properties.theme", + "schema.properties.theme.description", + "schema.properties.theme.example", + "schema.properties.theme.indexed", + "schema.properties.theme.maxLength", + "schema.properties.theme.minLength", + "schema.properties.theme.type", + "schema.required", + "schema.required[]", + "schema.required[].s", + "use_row_level_access", + "user_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv1.4.0-getResourceDocsObp", + "documented_path": "/obp/v6.0.0/resource-docs/API_VERSION/obp", + "fields": [] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/webui-props", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getWebUiProps", + "documented_path": "/obp/v6.0.0/webui-props", + "fields": [ + "webui_props", + "webui_props[]", + "webui_props[].name", + "webui_props[].source", + "webui_props[].value", + "webui_props[].web_ui_props_id" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/my/entitlements", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getEntitlementsForCurrentUser", + "documented_path": "/obp/v5.1.0/my/entitlements", + "fields": [ + "list", + "list[]", + "list[].bank_id", + "list[].entitlement_id", + "list[].role_name" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/roles", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv2.1.0-getRoles", + "documented_path": "/obp/v5.1.0/roles", + "fields": [ + "roles", + "roles[]", + "roles[].requires_bank_id", + "roles[].role" + ] + }, + { + "verb": "POST", + "path": "/obp/v6.0.0/my/consents/IMPLICIT", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-createConsent", + "documented_path": "/obp/v6.0.0/my/consents/IMPLICIT", + "fields": [ + "consent_id", + "jwt", + "status" + ] + }, + { + "verb": "GET", + "path": "/obp/v6.0.0/banks", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv6.0.0-getBanks", + "documented_path": "/obp/v6.0.0/banks", + "fields": [ + "banks", + "banks[]", + "banks[].attributes", + "banks[].attributes[]", + "banks[].attributes[].name", + "banks[].attributes[].value", + "banks[].bank_code", + "banks[].bank_id", + "banks[].bank_routings", + "banks[].bank_routings[]", + "banks[].bank_routings[].address", + "banks[].bank_routings[].scheme", + "banks[].full_name", + "banks[].logo", + "banks[].website" + ] + }, + { + "verb": "GET", + "path": "/obp/v5.1.0/users/current", + "docs_from": "https://k8s.openbankproject.com", + "operation_id": "OBPv3.0.0-getCurrentUser", + "documented_path": "/obp/v5.1.0/users/current", + "fields": [ + "email", + "entitlements", + "entitlements.list", + "entitlements.list[]", + "entitlements.list[].bank_id", + "entitlements.list[].entitlement_id", + "entitlements.list[].role_name", + "provider", + "provider_id", + "user_id", + "username", + "views", + "views.list", + "views.list[]", + "views.list[].account_id", + "views.list[].bank_id", + "views.list[].view_id" + ] + } + ] +} diff --git a/obp-api-contract/snapshot.py b/obp-api-contract/snapshot.py new file mode 100644 index 00000000..2cda6988 --- /dev/null +++ b/obp-api-contract/snapshot.py @@ -0,0 +1,152 @@ +#!/usr/bin/env python3 +# Copyright (C) 2025-2026 TESOBE GmbH +# SPDX-License-Identifier: AGPL-3.0-or-later +# Licensed under the GNU Affero General Public License v3 or later: see the LICENSE and NOTICE files. +"""Write snapshot.json: what an OBP-API documents for each call in contract.json. + + python3 obp-api-contract/snapshot.py --base https://k8s.openbankproject.com \ + [--fallback https://apisandbox.openbankproject.com] + +For every version used in contract.json it reads /obp/{v}/resource-docs/{v}/obp once, +from --base, or from --fallback when --base does not serve that version (a deployment +that switched it off). It finds the endpoint each call reaches and records its operation +id and every response field path, taken from typed_success_response_body. A call with no +endpoint is recorded as missing, so the contract test fails on it. Needs no credentials; +uses only the standard library. + +Matching: OBP writes placeholders in capitals (BANK_ID) and so are some literal segments +(the transaction request type OPEN_CORRIDOR_PROMISE). A segment matches when it is equal, +when the documented one is in capitals (a placeholder for a value the call fills in), or +when both are in capitals. The documented path with the most equal segments wins. +""" +import argparse +import datetime +import json +import os +import re +import sys +import urllib.error +import urllib.request + +HERE = os.path.dirname(os.path.abspath(__file__)) +PLACEHOLDER = re.compile(r"^[A-Z][A-Z0-9_]*$") + + +def get_json(url): + req = urllib.request.Request(url, headers={"Accept": "application/json"}) + with urllib.request.urlopen(req, timeout=300) as resp: + return json.load(resp) + + +def segments(path): + return [s for s in path.split("?")[0].split("/") if s] + + +def match_score(contract_path, documented_path): + """Number of equal segments, or None when the paths cannot be the same endpoint.""" + a, b = segments(contract_path), segments(documented_path) + if len(a) != len(b): + return None + score = 0 + for x, y in zip(a, b): + if x == y: + score += 1 + elif not PLACEHOLDER.match(y): + return None + return score + + +def schema_fields(schema, prefix=""): + """Every field path in a JSON Schema: `a`, `a.b`, `a.list[]`, `a.list[].c`.""" + out = set() + if not isinstance(schema, dict): + return out + if schema.get("type") == "array" or "items" in schema: + out |= schema_fields(schema.get("items", {}), prefix + "[]") + for name, sub in (schema.get("properties") or {}).items(): + path = f"{prefix}.{name}" if prefix else name + out.add(path) + out |= schema_fields(sub, path) + if isinstance(sub, dict) and (sub.get("type") == "array" or "items" in sub): + out.add(path + "[]") + return out + + +def version_of(path): + return segments(path)[1] + + +def main(): + ap = argparse.ArgumentParser() + ap.add_argument("--base", required=True, help="OBP-API base URL") + ap.add_argument("--fallback", help="OBP-API that still serves the versions --base switched off") + ap.add_argument("--out", default=os.path.join(HERE, "snapshot.json")) + args = ap.parse_args() + base = args.base.rstrip("/") + contract = json.load(open(os.path.join(HERE, "contract.json"))) + calls = contract["calls"] + + fallback = args.fallback.rstrip("/") if args.fallback else None + docs, docs_from = {}, {} + for v in sorted({version_of(c["path"]) for c in calls}): + for host in [base] + ([fallback] if fallback else []): + url = f"{host}/obp/{v}/resource-docs/{v}/obp" + print(f"reading {url}", file=sys.stderr) + try: + docs[v] = get_json(url)["resource_docs"] + docs_from[v] = host + break + except urllib.error.HTTPError as e: + print(f" HTTP {e.code}", file=sys.stderr) + if v not in docs: + sys.exit(f"no OBP-API given serves the resource docs of {v}") + + def about(host): + newest = max((v for v in docs if docs_from[v] == host), + key=lambda v: tuple(int(p) for p in v[1:].split("."))) + root = get_json(f"{host}/obp/{newest}/root") + return {"version": root.get("version"), "git_commit": root.get("git_commit")} + hosts = {h: about(h) for h in sorted(set(docs_from.values()))} + + endpoints = [] + for c in calls: + v = version_of(c["path"]) + scored = [] + for d in docs[v]: + if d["request_verb"] != c["verb"]: + continue + score = match_score(c["path"], d.get("specified_url") or d["request_url"]) + if score is not None: + scored.append((score, d)) + scored.sort(key=lambda sd: -sd[0]) + entry = {"verb": c["verb"], "path": c["path"], "docs_from": docs_from[v]} + if scored and len(scored) > 1 and scored[0][0] == scored[1][0]: + entry["ambiguous"] = sorted(d["operation_id"] for s, d in scored if s == scored[0][0]) + if scored: + d = scored[0][1] + entry.update({ + "operation_id": d["operation_id"], + "documented_path": d.get("specified_url") or d["request_url"], + "fields": sorted(schema_fields(d.get("typed_success_response_body") or {})), + }) + else: + entry["missing"] = True + endpoints.append(entry) + + snapshot = { + "about": "Written by obp-api-contract/snapshot.py; do not edit by hand.", + "obp_api": hosts, + "taken_at": datetime.datetime.now(datetime.timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ"), + "endpoints": endpoints, + } + with open(args.out, "w") as f: + json.dump(snapshot, f, indent=1, ensure_ascii=False) + f.write("\n") + missing = [e["verb"] + " " + e["path"] for e in endpoints if e.get("missing")] + print(f"wrote {args.out}: {len(endpoints)} calls, {len(missing)} with no endpoint", file=sys.stderr) + for m in missing: + print(f" no endpoint: {m}", file=sys.stderr) + + +if __name__ == "__main__": + main() From 2bb6578d77fa1caa479f15031dd8f9fbee3e3e11 Mon Sep 17 00:00:00 2001 From: Hongwei Date: Fri, 13 Nov 2026 00:44:50 +0100 Subject: [PATCH 3/6] test: check the OBP-API contract against the source and the snapshot --- .../src/lib/server/obp/obpApiContract.test.ts | 208 ++++++++++++++++++ 1 file changed, 208 insertions(+) create mode 100644 packages/shared/src/lib/server/obp/obpApiContract.test.ts diff --git a/packages/shared/src/lib/server/obp/obpApiContract.test.ts b/packages/shared/src/lib/server/obp/obpApiContract.test.ts new file mode 100644 index 00000000..38cc7733 --- /dev/null +++ b/packages/shared/src/lib/server/obp/obpApiContract.test.ts @@ -0,0 +1,208 @@ +import { describe, expect, it } from 'vitest'; +import { readdirSync, readFileSync, statSync } from 'node:fs'; +import { join, relative, resolve } from 'node:path'; +import { fileURLToPath } from 'node:url'; + +// The contract between the apps and OBP-API. +// +// obp-api-contract/contract.json lists every OBP-API call the apps and the shared package make, with the +// response fields the code reads. obp-api-contract/snapshot.json is what an OBP-API documents for those +// calls, written by obp-api-contract/snapshot.py from its resource docs. These tests need no server. They +// check that the list matches the code, and that every call reaches an endpoint OBP-API documents, with +// every field the code reads. Take the snapshot again from a new OBP-API build to learn whether that +// build breaks an app. + +const REPO_ROOT = resolve(fileURLToPath(new URL('.', import.meta.url)), '../../../../../..'); +const CONTRACT_DIR = join(REPO_ROOT, 'obp-api-contract'); +const SOURCE_ROOTS = ['apps', 'packages']; +const SKIP_DIRS = new Set(['node_modules', '.svelte-kit', 'build', 'dist']); +const EXTENSIONS = ['.ts', '.js', '.svelte']; +/** A line that builds an OBP-API path: `/obp/v6.0.0/...`, `/obp/${API_VERSION}/...` or `${OBP_API_URL}/...`. */ +const OBP_PATH = /obp\/(v\d|\$\{)|\$\{OBP_API_URL\}/; +const COMMENT = /^\s*(\/\/|\*|\/\*)/; + +interface Call { + verb: string; + path: string; + source: string; + needles: string[]; + reads?: string[]; + undocumented_fields?: string[]; + undocumented_endpoint?: string; + note?: string; +} + +interface NotCall { + source: string; + needles: string[]; + reason: string; +} + +interface SnapshotEntry { + verb: string; + path: string; + operation_id?: string; + fields?: string[]; + missing?: boolean; + ambiguous?: string[]; +} + +function load(name: string): T { + return JSON.parse(readFileSync(join(CONTRACT_DIR, name), 'utf8')) as T; +} + +const contract = load<{ calls: Call[]; not_calls: NotCall[] }>('contract.json'); +const snapshot = load<{ endpoints: SnapshotEntry[] }>('snapshot.json'); + +const key = (call: { verb: string; path: string }) => `${call.verb} ${call.path}`; + +/** The reads of `call` that `fields` does not document. A read written `a|b` is satisfied by either field. */ +function undocumentedReads(call: { reads?: string[] }, fields: Set): string[] { + return (call.reads ?? []).filter((read) => !read.split('|').some((f) => fields.has(f))); +} + +function sourceFiles(dir: string): string[] { + const out: string[] = []; + for (const name of readdirSync(dir)) { + if (SKIP_DIRS.has(name) || name.startsWith('.')) continue; + const path = join(dir, name); + if (statSync(path).isDirectory()) out.push(...sourceFiles(path)); + else if (EXTENSIONS.some((ext) => name.endsWith(ext)) && !/\.(test|spec)\.[a-z]+$/.test(name)) + out.push(path); + } + return out; +} + +/** Lines of app source that build an OBP-API path, skipping comments and Svelte markup. */ +function obpPathLines(): { file: string; n: number; line: string }[] { + const out: { file: string; n: number; line: string }[] = []; + for (const root of SOURCE_ROOTS) { + for (const top of readdirSync(join(REPO_ROOT, root))) { + const src = join(REPO_ROOT, root, top, 'src'); + if (!statSync(join(REPO_ROOT, root, top)).isDirectory()) continue; + let files: string[]; + try { + files = sourceFiles(src); + } catch { + continue; + } + for (const file of files) { + const rel = relative(REPO_ROOT, file).split('\\').join('/'); + // In a Svelte file only the ')) inScript = false; + }); + } + } + } + return out; +} + +describe('OBP-API contract', () => { + it('lists every call with a needle that is in its source file', () => { + // Each listed call, and each listed line that is not a call, still exists in its source file. + const gone: string[] = []; + for (const entry of [...contract.calls, ...contract.not_calls]) { + const text = readFileSync(join(REPO_ROOT, entry.source), 'utf8'); + if (entry.needles.length === 0) gone.push(`${entry.source}: no needles`); + for (const needle of entry.needles) + if (!text.includes(needle)) + gone.push( + `${entry.source}: ${'verb' in entry ? key(entry as Call) : 'not a call'} — ${needle}` + ); + } + expect(gone).toEqual([]); + }); + + it('lists every OBP-API path the source builds', () => { + // A line that builds an OBP-API path must contain a needle of a call or of a not_calls entry for the + // same file, so a new call cannot reach OBP-API without its fields being recorded. + const entries = [...contract.calls, ...contract.not_calls]; + const unlisted = obpPathLines() + .filter( + ({ file, line }) => + !entries.some((e) => e.source === file && e.needles.some((n) => line.includes(n.trim()))) + ) + .map(({ file, n, line }) => `${file}:${n} ${line.trim()}`); + expect(unlisted).toEqual([]); + }); + + it('holds a snapshot taken for this contract', () => { + // snapshot.json must hold exactly the calls of contract.json; otherwise run snapshot.py again. + const listed = [...new Set(contract.calls.map(key))].sort(); + const snapped = [...new Set(snapshot.endpoints.map(key))].sort(); + expect(snapped).toEqual(listed); + }); + + it('reaches an endpoint OBP-API documents with every call', () => { + // Each call's version and path must name a documented endpoint, unless the entry says why not in + // undocumented_endpoint. A recorded gap that OBP-API has since documented fails too, so the note goes. + const problems: string[] = []; + for (const call of contract.calls) { + const entry = snapshot.endpoints.find((e) => key(e) === key(call)); + const missing = !entry || entry.missing === true; + if (missing && !call.undocumented_endpoint) + problems.push(`${key(call)}: no documented endpoint`); + if (!missing && call.undocumented_endpoint) + problems.push( + `${key(call)}: now documented as ${entry?.operation_id}; drop undocumented_endpoint` + ); + if (entry?.ambiguous) + problems.push(`${key(call)}: matches several endpoints ${entry.ambiguous.join(', ')}`); + } + expect(problems).toEqual([]); + }); + + it('reads only fields OBP-API documents', () => { + // Each field the code reads must be in the documented response of its endpoint, unless the entry lists + // it in undocumented_fields. A listed field that OBP-API now documents fails, so the list shrinks. + const problems: string[] = []; + for (const call of contract.calls) { + const entry = snapshot.endpoints.find((e) => key(e) === key(call)); + if (!entry || entry.missing) continue; + const fields = new Set(entry.fields ?? []); + const known = new Set(call.undocumented_fields ?? []); + for (const read of undocumentedReads(call, fields)) + if (!known.has(read)) + problems.push( + `${key(call)} (${entry.operation_id}, ${call.source}): reads ${read}, not documented` + ); + for (const field of known) { + if (field.split('|').some((f) => fields.has(f))) + problems.push( + `${key(call)}: ${field} is now documented; drop it from undocumented_fields` + ); + if (!(call.reads ?? []).includes(field)) + problems.push(`${key(call)}: ${field} is in undocumented_fields but not in reads`); + } + } + expect(problems).toEqual([]); + }); + + it('reports a renamed or removed field', () => { + // Tests the check itself: with `bank_id` gone from the documented fields the read is reported, and a + // read with an alternative (`banks[].id|banks[].bank_id`) passes on either field. + const banks = { reads: ['banks[].bank_id'] }; + expect(undocumentedReads(banks, new Set(['banks[]', 'banks[].id']))).toEqual([ + 'banks[].bank_id' + ]); + const either = { reads: ['banks[].id|banks[].bank_id'] }; + expect(undocumentedReads(either, new Set(['banks[].bank_id']))).toEqual([]); + expect(undocumentedReads(either, new Set())).toEqual(['banks[].id|banks[].bank_id']); + }); + + it('finds the lines that build OBP-API paths', () => { + // Tests the coverage scan itself: it sees the app sources and the ways a path is written. + expect(obpPathLines().length).toBeGreaterThan(300); + expect(OBP_PATH.test('`/proxy/obp/v6.0.0/banks/${bankId}`')).toBe(true); + expect(OBP_PATH.test('`/obp/${API_VERSION}/banks`')).toBe(true); + expect(OBP_PATH.test('`${OBP_API_URL}/users/current`')).toBe(true); + expect(OBP_PATH.test("'/obp/dynamic-entity/my/notes'")).toBe(false); + }); +}); From ace94b8e43af89f5a2a9fe5f819ea9407352f0fe Mon Sep 17 00:00:00 2001 From: Hongwei Date: Sat, 14 Nov 2026 14:51:43 +0100 Subject: [PATCH 4/6] test: refuse a snapshot that moves a call to another operation A literal path segment also matches a documented placeholder, so a call whose own endpoint is gone could match a neighbouring endpoint when the snapshot is retaken, and the tests would pass against the wrong fields. snapshot.py now compares each call's operation with the snapshot.json already on disk: if one differs it lists the calls and writes nothing, unless --accept-rebind is given. A path with no /obp/vX.Y.Z prefix is recorded as missing and unversioned instead of stopping the script. The file is the same in every repository that keeps an OBP-API contract. --- obp-api-contract/snapshot.py | 36 ++++++++++++++++++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/obp-api-contract/snapshot.py b/obp-api-contract/snapshot.py index 2cda6988..e3949c1f 100644 --- a/obp-api-contract/snapshot.py +++ b/obp-api-contract/snapshot.py @@ -18,6 +18,16 @@ (the transaction request type OPEN_CORRIDOR_PROMISE). A segment matches when it is equal, when the documented one is in capitals (a placeholder for a value the call fills in), or when both are in capitals. The documented path with the most equal segments wins. + +A literal segment also matches a placeholder, so a call whose own endpoint is gone can match +a neighbouring one (/consumers/current/scopes against /consumers/CONSUMER_ID/scopes). To keep +that from passing unnoticed, a call that matched one operation in the snapshot.json already on +disk and now matches another is listed and nothing is written; check each one, then rerun +with --accept-rebind. + +A path with no /obp/vX.Y.Z prefix (DirectLogin at /my/logins/direct, the unversioned +/obp/dynamic-entity/... routes) belongs to no version's resource docs, so it is not looked +up: it is recorded as missing and unversioned, and the contract must say why. """ import argparse import datetime @@ -30,6 +40,7 @@ HERE = os.path.dirname(os.path.abspath(__file__)) PLACEHOLDER = re.compile(r"^[A-Z][A-Z0-9_]*$") +VERSION = re.compile(r"^v\d+\.\d+\.\d+$") def get_json(url): @@ -73,7 +84,9 @@ def schema_fields(schema, prefix=""): def version_of(path): - return segments(path)[1] + """The version of an /obp/vX.Y.Z/... path, or None for a path without one.""" + s = segments(path) + return s[1] if len(s) > 1 and s[0] == "obp" and VERSION.match(s[1]) else None def main(): @@ -81,6 +94,8 @@ def main(): ap.add_argument("--base", required=True, help="OBP-API base URL") ap.add_argument("--fallback", help="OBP-API that still serves the versions --base switched off") ap.add_argument("--out", default=os.path.join(HERE, "snapshot.json")) + ap.add_argument("--accept-rebind", action="store_true", + help="write the snapshot although calls now match a different operation than before") args = ap.parse_args() base = args.base.rstrip("/") contract = json.load(open(os.path.join(HERE, "contract.json"))) @@ -88,7 +103,7 @@ def main(): fallback = args.fallback.rstrip("/") if args.fallback else None docs, docs_from = {}, {} - for v in sorted({version_of(c["path"]) for c in calls}): + for v in sorted({version_of(c["path"]) for c in calls} - {None}): for host in [base] + ([fallback] if fallback else []): url = f"{host}/obp/{v}/resource-docs/{v}/obp" print(f"reading {url}", file=sys.stderr) @@ -111,6 +126,9 @@ def about(host): endpoints = [] for c in calls: v = version_of(c["path"]) + if v is None: + endpoints.append({"verb": c["verb"], "path": c["path"], "unversioned": True, "missing": True}) + continue scored = [] for d in docs[v]: if d["request_verb"] != c["verb"]: @@ -133,6 +151,20 @@ def about(host): entry["missing"] = True endpoints.append(entry) + try: + with open(args.out) as f: + before = {(e["verb"], e["path"]): e.get("operation_id") for e in json.load(f)["endpoints"]} + except (OSError, ValueError, KeyError): + before = {} + rebound = [f'{e["verb"]} {e["path"]}: was {before[(e["verb"], e["path"])]}, now {e["operation_id"]}' + for e in endpoints + if e.get("operation_id") and before.get((e["verb"], e["path"])) not in (None, e["operation_id"])] + for line in rebound: + print(f" matches another operation: {line}", file=sys.stderr) + if rebound and not args.accept_rebind: + sys.exit(f"{args.out} not written: {len(rebound)} call(s) match a different operation than before, " + "which usually means their own endpoint is gone. Check each one, then rerun with --accept-rebind.") + snapshot = { "about": "Written by obp-api-contract/snapshot.py; do not edit by hand.", "obp_api": hosts, From f2f7eca6e1f1d68cad3c5b1bbb1836ac5e842631 Mon Sep 17 00:00:00 2001 From: Hongwei Date: Tue, 17 Nov 2026 00:12:36 +0100 Subject: [PATCH 5/6] test: flag an OBP path assembled from pieces and state what the scan reads The scan now also sees ${V}/ builders, /obp/v${major}, '/obp/' + version, a '/obp' base constant, any /vN.N.N/ segment, /obp/dynamic-entity paths and .mjs/.cjs/.mts/.cts files. The lines it newly sees are listed under not_calls. contract.json says that scripts outside src are out of scope. --- obp-api-contract/contract.json | 66 ++++++++++++++++++- .../src/lib/server/obp/obpApiContract.test.ts | 32 +++++++-- 2 files changed, 93 insertions(+), 5 deletions(-) diff --git a/obp-api-contract/contract.json b/obp-api-contract/contract.json index 94fe5004..131fc897 100644 --- a/obp-api-contract/contract.json +++ b/obp-api-contract/contract.json @@ -1,5 +1,5 @@ { - "about": "Every OBP-API call that the Portal, API Manager, Cohort and the shared package make from their source code. Each entry gives the verb, the path (OBP placeholders in capitals), the source file, the text in that file that makes the call (needles) and the response fields the code reads. packages/shared/src/lib/server/obp/obpApiContract.test.ts checks this list against the source and against snapshot.json, which obp-api-contract/snapshot.py writes from an OBP-API's resource docs. not_calls lists source lines that name an OBP-API path without calling it, such as help text, example code and path helpers whose calls are listed at their callers. Not listed: calls through the generic proxy (/proxy/obp/...) whose path the browser or the route chooses at run time, records of the Dynamic Entities the apps define themselves (/obp/dynamic-entity/... and their v7.0.0 bank-level form), and dynamic endpoints. Not covered yet: the Berlin Group and UK Open Banking calls of the Portal, because snapshot.py reads only OBP resource docs.", + "about": "Every OBP-API call that the Portal, API Manager, Cohort and the shared package make from their source code. Each entry gives the verb, the path (OBP placeholders in capitals), the source file, the text in that file that makes the call (needles) and the response fields the code reads. packages/shared/src/lib/server/obp/obpApiContract.test.ts checks this list against the source and against snapshot.json, which obp-api-contract/snapshot.py writes from an OBP-API's resource docs. not_calls lists source lines that name an OBP-API path without calling it, such as help text, example code and path helpers whose calls are listed at their callers. Only the source of the apps and of the shared package is read (apps/*/src and packages/*/src); scripts outside src, such as apps/cohort/scripts/seed-demo-data.mjs, apps/portal/debug-oauth.cjs and apps/api-manager/verify-obp-config.cjs, are out of scope. Not listed: calls through the generic proxy (/proxy/obp/...) whose path the browser or the route chooses at run time, records of the Dynamic Entities the apps define themselves (/obp/dynamic-entity/... and their v7.0.0 bank-level form), and dynamic endpoints. Not covered yet: the Berlin Group and UK Open Banking calls of the Portal, because snapshot.py reads only OBP resource docs.", "calls": [ { "verb": "GET", @@ -9753,6 +9753,13 @@ ], "reason": "help text in the form description given to Opey" }, + { + "source": "apps/api-manager/src/lib/components/DynamicEndpointOperationsTable.svelte", + "needles": [ + "if (!url.startsWith(\"/obp/\")) {" + ], + "reason": "check on the URL typed into the try-it box; the call itself goes through the generic /proxy" + }, { "source": "apps/api-manager/src/lib/components/DynamicResourceDocForm.svelte", "needles": [ @@ -9788,6 +9795,13 @@ ], "reason": "base URL constant (OBP_API_URL); the calls built on it are listed at their callers: apps/api-manager/src/routes/+layout.server.ts, apps/api-manager/src/routes/login/[provider]/callback/+server.ts, apps/api-manager/src/routes/login/obp/callback/+server.ts" }, + { + "source": "apps/api-manager/src/lib/server/developerFaq/faqEntity.ts", + "needles": [ + "`/obp/dynamic-entity/${FAQ_ENTITY}`" + ], + "reason": "path of the records of the app-defined Dynamic Entity; the calls on it are in the backend routes that use FAQ_DATA_PATH" + }, { "source": "apps/api-manager/src/lib/server/domainApis.ts", "needles": [ @@ -9872,6 +9886,27 @@ ], "reason": "passes obp_requests to the shared ensureSystemDynamicEntity in packages/shared/src/lib/server/obp, which builds the paths" }, + { + "source": "apps/api-manager/src/lib/server/portalPages/portalPageEntity.ts", + "needles": [ + "`/obp/dynamic-entity/${PORTAL_PAGE_ENTITY}`" + ], + "reason": "path of the records of the app-defined Dynamic Entity; the calls on it are in the backend routes that use PORTAL_PAGE_DATA_PATH" + }, + { + "source": "apps/api-manager/src/lib/server/reports/reportEntity.ts", + "needles": [ + "`/obp/dynamic-entity/${REPORT_ENTITY}`" + ], + "reason": "path of the records of the app-defined Dynamic Entity; the calls on it are in the backend routes that use REPORT_DATA_PATH" + }, + { + "source": "apps/api-manager/src/lib/services/InsightService.ts", + "needles": [ + "fetch('/proxy/obp/dynamic-entity/my/opey_notebook', {" + ], + "reason": "records of the app-defined personal Dynamic Entity opey_notebook, not part of OBP-API's static docs" + }, { "source": "apps/api-manager/src/lib/services/dynamicEntityWebhooks.ts", "needles": [ @@ -9965,6 +10000,14 @@ ], "reason": "paths under /obp/dynamic-entity/... (records of entities the apps define)" }, + { + "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/personal/[entityName]/+page.svelte", + "needles": [ + "`/proxy/obp/dynamic-entity/my/${entityName}`,", + "`/proxy/obp/dynamic-entity/my/${entityName}/${recordId}`," + ], + "reason": "records of an entity the apps define (/obp/dynamic-entity/my/...), reached through the generic /proxy" + }, { "source": "apps/api-manager/src/routes/(protected)/dynamic-entities/system/[id]/+page.svelte", "needles": [ @@ -10253,6 +10296,13 @@ ], "reason": "Berlin Group paths, not covered yet." }, + { + "source": "apps/portal/src/routes/(protected)/training/+page.svelte", + "needles": [ + "const ENTITY_PATH = '/proxy/obp/dynamic-entity/my/training_progress';" + ], + "reason": "records of the app-defined personal Dynamic Entity training_progress, not part of OBP-API's static docs" + }, { "source": "apps/portal/src/routes/(protected)/uk-consent-request/+page.server.ts", "needles": [ @@ -10357,6 +10407,13 @@ ], "reason": "generic proxy pass-through helper: the App chooses the whole OBP path" }, + { + "source": "packages/shared/src/lib/components/appStudioShim.ts", + "needles": [ + "return `${proxyBase}/${trimmed.slice('/obp/'.length)}`;" + ], + "reason": "turns an /obp/... path chosen at run time into a /proxy path; the path is not known here" + }, { "source": "packages/shared/src/lib/health-check/services/OIDCHealthCheckService.ts", "needles": [ @@ -10399,6 +10456,13 @@ "`/obp/dynamic-entity/${SITE_PAGE_ENTITY}`" ], "reason": "app-defined Dynamic Entity records (obp_portal_page), not part of OBP-API's static docs" + }, + { + "source": "packages/shared/src/lib/server/obp/obpProxy.ts", + "needles": [ + "const prefix = options.pathPrefix ?? '/obp';" + ], + "reason": "base path of the generic proxy; the path after it is chosen by the caller at run time" } ] } diff --git a/packages/shared/src/lib/server/obp/obpApiContract.test.ts b/packages/shared/src/lib/server/obp/obpApiContract.test.ts index 38cc7733..797b26a3 100644 --- a/packages/shared/src/lib/server/obp/obpApiContract.test.ts +++ b/packages/shared/src/lib/server/obp/obpApiContract.test.ts @@ -16,9 +16,21 @@ const REPO_ROOT = resolve(fileURLToPath(new URL('.', import.meta.url)), '../../. const CONTRACT_DIR = join(REPO_ROOT, 'obp-api-contract'); const SOURCE_ROOTS = ['apps', 'packages']; const SKIP_DIRS = new Set(['node_modules', '.svelte-kit', 'build', 'dist']); -const EXTENSIONS = ['.ts', '.js', '.svelte']; -/** A line that builds an OBP-API path: `/obp/v6.0.0/...`, `/obp/${API_VERSION}/...` or `${OBP_API_URL}/...`. */ -const OBP_PATH = /obp\/(v\d|\$\{)|\$\{OBP_API_URL\}/; +const EXTENSIONS = ['.ts', '.js', '.svelte', '.mjs', '.cjs', '.mts', '.cts']; +/** + * A line that builds an OBP-API path: `/obp/v6.0.0/...`, `/obp/v${major}.0.0/...`, `/obp/${API_VERSION}/...`, + * `'/obp/' + version`, `/obp/dynamic-entity/...`, `${OBP_API_URL}/...`, `${V}/...` (V holding `/obp/v6.0.0`), + * `${API}/v6.0.0/...` (API holding `/obp`) or any other path with a version segment such as `/v5.1.0/`. + */ +const OBP_PATH = new RegExp( + [ + String.raw`obp\/(v\d|v\$\{|\$\{|dynamic-entity|['"\x60])`, + String.raw`\$\{OBP_API_URL\}`, + String.raw`\$\{V\}\/`, + String.raw`['"\x60]\/obp['"\x60]`, + String.raw`\/v\d+\.\d+\.\d+(?![\d.])` + ].join('|') +); const COMMENT = /^\s*(\/\/|\*|\/\*)/; interface Call { @@ -203,6 +215,18 @@ describe('OBP-API contract', () => { expect(OBP_PATH.test('`/proxy/obp/v6.0.0/banks/${bankId}`')).toBe(true); expect(OBP_PATH.test('`/obp/${API_VERSION}/banks`')).toBe(true); expect(OBP_PATH.test('`${OBP_API_URL}/users/current`')).toBe(true); - expect(OBP_PATH.test("'/obp/dynamic-entity/my/notes'")).toBe(false); + // Paths assembled from pieces, and the base-path constants they are built on. + for (const line of [ + '`${V}/chat-rooms/${id}/messages`', + '`/obp/v${major}.0.0/banks`', + "'/obp/' + version + '/banks'", + "const API = '/obp';", + '`${API}/v6.0.0/banks/${bankId}`', + "fetch('/proxy/obp/dynamic-entity/my/notes')" + ]) + expect(OBP_PATH.test(line), line).toBe(true); + for (const line of ["'/obp-oidc/.well-known/openid-configuration'", "'/api/v2/things'"]) + expect(OBP_PATH.test(line), line).toBe(false); + expect(EXTENSIONS).toEqual(expect.arrayContaining(['.mjs', '.cjs', '.mts', '.cts'])); }); }); From 0b9ebf6b6f4855eb714226c9eeed410ea70b55e9 Mon Sep 17 00:00:00 2001 From: Hongwei Date: Tue, 17 Nov 2026 00:12:37 +0100 Subject: [PATCH 6/6] test: refuse to overwrite the snapshot from an empty or failing OBP-API --- obp-api-contract/snapshot.py | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/obp-api-contract/snapshot.py b/obp-api-contract/snapshot.py index e3949c1f..221f79e6 100644 --- a/obp-api-contract/snapshot.py +++ b/obp-api-contract/snapshot.py @@ -113,8 +113,14 @@ def main(): break except urllib.error.HTTPError as e: print(f" HTTP {e.code}", file=sys.stderr) + # 404 / 400 is how OBP-API says a version is switched off; any other + # status (401, 429, 5xx) is a broken server, not a reason to read another one. + if e.code not in (400, 404): + sys.exit(f"{url} answered HTTP {e.code}; not falling back to another OBP-API for that") if v not in docs: sys.exit(f"no OBP-API given serves the resource docs of {v}") + if not docs[v]: + sys.exit(f"{docs_from[v]} returned no resource docs for {v}; refusing to record every call as missing") def about(host): newest = max((v for v in docs if docs_from[v] == host), @@ -153,12 +159,22 @@ def about(host): try: with open(args.out) as f: - before = {(e["verb"], e["path"]): e.get("operation_id") for e in json.load(f)["endpoints"]} + before = {(e["verb"], e["path"]): e for e in json.load(f)["endpoints"]} except (OSError, ValueError, KeyError): before = {} - rebound = [f'{e["verb"]} {e["path"]}: was {before[(e["verb"], e["path"])]}, now {e["operation_id"]}' - for e in endpoints - if e.get("operation_id") and before.get((e["verb"], e["path"])) not in (None, e["operation_id"])] + rebound = [] + for e in endpoints: + was = before.get((e["verb"], e["path"])) + if was is None: + continue + name = f'{e["verb"]} {e["path"]}' + was_op, now_op = was.get("operation_id"), e.get("operation_id") + if was_op and now_op and was_op != now_op: + rebound.append(f"{name}: was {was_op}, now {now_op}") + elif was_op and not now_op: + rebound.append(f"{name}: was {was_op}, now no endpoint") + elif not was_op and now_op and not was.get("unversioned"): + rebound.append(f"{name}: had no endpoint, now {now_op}") for line in rebound: print(f" matches another operation: {line}", file=sys.stderr) if rebound and not args.accept_rebind: