OAI / tools.openapis.org

A collection of open-source and commercial tools for creating your APIs with OpenAPI - Sourced from and published for the community
https://tools.openapis.org/
105 stars 30 forks source link

Implement merge process between published `tools.yaml` and source data #1

Closed SensibleWood closed 2 years ago

SensibleWood commented 2 years ago

User Story

As a consumer of tooling data I want to see updates to metadata merged into the master list when they are updated in source data.

Detailed Requirement

The current implementation of the build process is only an initial build that grabs all data from the in-scope repositories, merges and normalises based on some simple analytics and then stores in the docs directory. Whilst this is fine as a repeatable process, it doesn't make for long term state management of the Tooling repository i.e.:

We therefore need to implement a merge process that mines the source data as now and does any updates, but then only selectively hits the GitHub (or other repository when implemented) to update the statistics on the tools.

A suggested design approach to investigate is using the cache control directives available on GitHub and seeing whether we can only selectively hit the API when new metadata is available.

SensibleWood commented 2 years ago

Following changes have been implement to meet the requirements of this issue:

Closing issue. Build scheduling will be mopped up in #9 .