outscale / osc-api-deploy

This repo helps deploying openapi description of osc-api repo

Project Goal

This reprository helps deploying osc-api yaml for various tooling (SDK, ...) This may include some yaml hacks to avoid issues with some code generators.

If you are looking for original Outscale API description in OpenAPI format, please head to osc-api.

CI description

description

osc-api CI is run when a release happen
It call release-osc-api, which triger build workflow in osc-api-deploy, it pass as argument, the current api version. osc-api-deploy, will rebuild itself calling scrips in hacks, and create a new PR for the new release.

Once this PR is merge, osc-api-deploy, will call build.yml for each SDK, thoses SDKs will use either outscale-java.yaml, hacked outscale.yaml(in osc-api-deploy) or original outscale.yaml in osc-api.

Then one PR will be open for each SDKs.

schema

 [osc-api repo]        [osc-api-deploy repo]      [SDKs repos]
       |                        |                      |
   (release)                    |                      |
       V                        |                      |
(release-osc-api.yml)           |                      |
                      \-->(call build.yml)             |
                                V                      |
                       (hack outscale.yaml)            |
                                V                      |
                           (open PR)                   |
                                V                      |
                            (PR merge)                 V
                                      \---->(start release CI with hacked yaml)
                                                       V
                                               (PR for releases)