This project is a collection of OpenAPI (also known as OAS) definitions and data schemas that are commonly used regardless of the domain in which a project might reside.
The intention for this project is to be a collaborative 'common' data repository, ensuring that data for these common areas fully encompass the needs of all domains. For example: Does the financial industry utilize an address differently than the logistics industry?
- How is the data used differently - what is the use case?
- What data elements are new/used/unused - is the schema both valid and efficient?
- How do we ensure that those differences, when incorporated, don't negatively affect other domains - standardization?
We are using OpenAPI 3.x definitions, and incorporating OData queries as a commonality. We've actually borrowed a few of the OData parameter definitions from their examples: OData to OpenAPI Mapping Version 1.0
A small laundry list of TODOs include:
- Complete the Address Schema
- Complete the Country Schema
- Complete the Subdivision Schema
- Complete the TimeZone Schema
- Start the Address API specification
- Complete the Country API specification
- Start the Subdivision API specification
- Start the TimeZone API specification
- Conquer the world
Special appreciation to the following teams for their outstanding efforts: