Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.88 KB

readme.md

File metadata and controls

41 lines (26 loc) · 1.88 KB

Account Aggregator Ecosystem: API Specs & FI Schemas

Overview

This repository contains:

  • OpenAPI specifications for Account Aggregator (specs/aa.yaml), Financial Information Provider (specs/fip.yaml) and Financial Information User (specs/fiu.yaml).
  • Supported Financial Instrument type schemas (schemas/**/*.xsd).

Maintaining the API Specifications

The 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

FI schemas are contained in schemas/ folder. Sample directory organization as follows:

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.