https://github.com/sahamati/account-aggregator-standards

Account Aggregator Ecosystem API Specifications and FI Schemas.
https://github.com/sahamati/account-aggregator-standards

account-aggregator api-specs nbfc-aa openapi schemas

Last synced: about 6 hours ago
JSON representation

Account Aggregator Ecosystem API Specifications and FI Schemas.

• Host: GitHub
• URL: https://github.com/sahamati/account-aggregator-standards
• Owner: Sahamati
• Created: 2021-04-23T17:16:47.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-01T17:01:05.000Z (almost 2 years ago)
• Last Synced: 2024-08-04T03:03:59.779Z (3 months ago)
• Topics: account-aggregator, api-specs, nbfc-aa, openapi, schemas
• Language: Shell
• Homepage:
• Size: 150 KB
• Stars: 25
• Watchers: 5
• Forks: 14
• Open Issues: 5
• Metadata Files:
  • Readme: readme.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Account Aggregator Ecosystem: API Specs & FI Schemas

## Overview

This repository contains:

- OpenAPI specifications for Account Aggregator (`specs/aa.yaml`), **F**inancial **I**nformation **P**rovider (`specs/fip.yaml`) and **F**inancial **I**nformation **U**ser (`specs/fiu.yaml`).

- Supported Financial Instrument type schemas (`schemas/**/*.xsd`).

## Maintaining the API Specifications

### [Specifications Folder](specs/)

The [specs/](specs/) folder contains the OpenAPI specification files:

- **aa.yaml** - to define the Account Aggregator APIs

- **fip.yaml** - defines the API specification for a FIP

- **fiu.yaml** - defines the API specification for a FIU

### Submitting a Specification Change

Update the specification in `specs/*.yaml` file(s) that contains your changes and additions.  

When changes are done, create a Pull Request that contains all the files you modified. An automatic validation script will verify if the changes results in a valid OpenAPI specification.   

Besides automated validation, a manual review will also be done and if found correct and valid by reviewers, the changes will be merged.

## Maintaining the FI Schemas

### [Schema Folder](schemas/)

FI schemas are contained in [schemas/](schemas/) folder. Sample directory organization as follows:

- [schemas/deposit/](schemas/deposit/) - contains schema definition file for **Deposit** FI Type

- [schemas/credit_card/](schemas/credit_card/) - contains schema definition for **Credit Card** FI type

- and so on

### Submitting a FI Schema Change

Update the schema definition file for one or more FI types which require changes.  

Once changes are done, create a Pull Request that contains the required changes. 

Depending on FI schemas modified, set of common and specific validation scripts will verify the changes.  

A manual review of PR will be done by reviewers, and changes will be merged if found correct and valid.