{"id":18302295,"url":"https://github.com/outscale/osc-api-deploy","last_synced_at":"2026-04-01T17:16:50.019Z","repository":{"id":176583886,"uuid":"655750768","full_name":"outscale/osc-api-deploy","owner":"outscale","description":"This repo helps deploying openapi description of osc-api repo","archived":false,"fork":false,"pushed_at":"2026-03-18T08:52:31.000Z","size":728,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-03-19T00:24:01.798Z","etag":null,"topics":["api","maturity-sandbox"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/outscale.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-06-19T14:18:41.000Z","updated_at":"2026-03-18T08:52:01.000Z","dependencies_parsed_at":"2024-04-23T13:55:44.092Z","dependency_job_id":"01a34321-9a3e-45ce-9f2e-32f0ea0cbbae","html_url":"https://github.com/outscale/osc-api-deploy","commit_stats":null,"previous_names":["outscale/osc-api-deploy"],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/outscale/osc-api-deploy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-api-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-api-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-api-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-api-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outscale","download_url":"https://codeload.github.com/outscale/osc-api-deploy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-api-deploy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31290537,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T13:12:26.723Z","status":"ssl_error","status_checked_at":"2026-04-01T13:12:25.102Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","maturity-sandbox"],"created_at":"2024-11-05T15:19:00.487Z","updated_at":"2026-04-01T17:16:49.989Z","avatar_url":"https://github.com/outscale.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Project Sandbox](https://docs.outscale.com/fr/userguide/_images/Project-Sandbox-yellow.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html)\n\n# Project Goal\n\nThis reprository helps deploying [osc-api](https://github.com/outscale/osc-api) yaml for various tooling (SDK, ...)\nThis may include some yaml hacks to avoid issues with some code generators.\nHack descriptions [here](hacks/README.md)\n\nIf you are looking for original Outscale API description in OpenAPI format, please head to [osc-api](https://github.com/outscale/osc-api).\n\n# CI description\n\n## description\n\n[osc-api](https://github.com/outscale/oapi-cli) CI is run when a release happen \u003c/br\u003e\nIt call [release-osc-api](https://github.com/outscale/osc-api/blob/master/.github/workflows/release-osc-api.yml),\nwhich triger [build workflow in osc-api-deploy](https://github.com/outscale/osc-api-deploy/blob/main/.github/workflows/build.yml),\nit pass as argument, the current api version.\nosc-api-deploy, will rebuild itself calling scrips in [hacks](https://github.com/outscale/osc-api-deploy/tree/main/hacks), and create a new PR for the new release.\n\nOnce 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.\n\nThen one PR will be open for each SDKs.\n\n## schema\n\n```\n [osc-api repo]        [osc-api-deploy repo]      [SDKs repos]                   [ oapi-cli ]\n       |                        |                      |                              |\n   (release)                    |                      |                              |\n       V                        |                      |                              |\n(release-osc-api.yml)           |                      |                              |\n                      \\--\u003e(call build.yml)             |                              |\n                                V                      |                              |\n                       (hack outscale.yaml)            |                              |\n                                V                      |                              |\n                           (open PR)                   |                              |\n                                V                      |                              |\n                        (PR manual merge)              V                              |\n                                      \\----\u003e(start release CI with hacked yaml)       |\n                                                       V                              |\n                                               (PR for releases)                      |\n                                                       V                              |\n                                               (PR manual merges)                     |\n                                                       \\---------------\u003e(osc-sdk-C start oapi-cli CI)\n                                                                                      V\n                                                                               (PR for release)\n                                                                                      V\n                                                                               (PR manual merges)\n```\n\n\n## FAQ\n\n\nQ: Why rely on a hack instead of addressing the issue with the SDK generator?\n\nA: There are two problems with upgrading the generator:\n- The first issue is that it's not an easy task; it requires porting the patch used by the SDKs and extensive testing to prevent regressions.\n- The second problem is that some features, like `oneOf`, would require breaking changes, necessitating a new major version of the SDKs and forcing all clients to upgrade their code.\n\n\nQ: Then why not just fix the osc-api.yaml file?:\n\nA: Because the API file isn’t technically bugged; it simply uses features that weren’t available when we created the first SDK versions.\n\nQ: Does that mean those strange patches will stay forever?\n\nA: No, at some point, we may upgrade every generator and release new major versions of all relevant SDKs. However, when this happens, we’ll still need to maintain the older SDK versions for a while.\n\nQ: What are recurring bugs that occur during SDK releases?\n\nA: So far, we have encountered two types of bugs that typically break SDK releases\n- usage of new features in openapi, that are not supported by generators.\n- CI breaks due to an outdated dependency\n\nQ: Why are the hack in ruby ?\n\nA: There is no particular reason. The hacks are very small and could have been written in any language that supports YAML\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fosc-api-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutscale%2Fosc-api-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fosc-api-deploy/lists"}