{"id":18302322,"url":"https://github.com/outscale/osc-openapi-framework","last_synced_at":"2025-06-18T20:33:19.474Z","repository":{"id":43258564,"uuid":"433458232","full_name":"outscale/osc-openapi-framework","owner":"outscale","description":"Build and parse OpenAPI data using its own structured python object.","archived":false,"fork":false,"pushed_at":"2023-06-11T22:45:13.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-09T10:12:09.583Z","etag":null,"topics":["maturity-graduated"],"latest_commit_sha":null,"homepage":"","language":"Python","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":"CONTRIBUTING.md","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}},"created_at":"2021-11-30T14:17:45.000Z","updated_at":"2025-03-21T05:03:18.000Z","dependencies_parsed_at":"2024-12-23T02:41:09.533Z","dependency_job_id":"248a0f27-0aca-433b-835a-ea0563f6d567","html_url":"https://github.com/outscale/osc-openapi-framework","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/outscale/osc-openapi-framework","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-openapi-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-openapi-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-openapi-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-openapi-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outscale","download_url":"https://codeload.github.com/outscale/osc-openapi-framework/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outscale%2Fosc-openapi-framework/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260629360,"owners_count":23038911,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["maturity-graduated"],"created_at":"2024-11-05T15:19:14.949Z","updated_at":"2025-06-18T20:33:14.451Z","avatar_url":"https://github.com/outscale.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OSC OpenAPI Framework\n[![Project Graduated](https://docs.outscale.com/fr/userguide/_images/Project-Graduated-green.svg)](https://docs.outscale.com/en/userguide/Open-Source-Projects.html)\n\nBuild and parse OpenAPI data using its own structured python object.\n\n## Features\n  - Build OpenAPI data from structured object\n  - Parse OpenAPI data to structured object\n\n\n\n## Installation\n\nYou can install the pre-built python package through this command:\n\n```bash\n$ pip install osc-openapi-framework\n```\n\n## Building\n\nTo build the package yourself:\n\n```bash\n$ make package\n```\n\nYou can then install it with:\n```bash\n$ pip install dist/osc_openapi_framework-*.whl\n```\n\n## Usage\n### Parsing OpenAPI Data\n```python\nfrom osc_openapi_framework.openapi.parser import parse as openapi_parse\n\nopenapi_data = '''\n    openapi: 3.0.0\n    info:\n      title: Sample API\n      description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.\n      version: 0.1.9\n    security:\n      - ApiKeyAuth: []\n    servers:\n      - url: http://api.example.com/v1\n        description: Optional server description, e.g. Main (production) server\n      - url: http://staging-api.example.com\n        description: Optional server description, e.g. Internal staging server for testing\n    paths:\n      /users:\n        get:\n          summary: Returns a list of users.\n          description: Optional extended description in CommonMark or HTML.\n          responses:\n            '200':    # status code\n              description: A JSON array of user names\n              content:\n                application/json:\n                  schema: \n                    type: array\n                    items: \n                      type: string\n'''\nwith open('/tmp/openapi_test', 'w') as fd:\n  fd.write(openapi_data)\noapi = openapi_parse('/tmp/openapi_test')\n```\n\n## License\n\n\u003e Copyright Outscale SAS\n\u003e\n\u003e BSD-3-Clause\n\nThis project is compliant with [REUSE](https://reuse.software/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fosc-openapi-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutscale%2Fosc-openapi-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutscale%2Fosc-openapi-framework/lists"}