{"id":18842483,"url":"https://github.com/openbase/prototoopenapischema","last_synced_at":"2025-09-09T13:35:53.265Z","repository":{"id":90442171,"uuid":"189288321","full_name":"openbase/protoToOpenAPISchema","owner":"openbase","description":"Python script for the generation of openAPI schemas from protocol buffers.","archived":false,"fork":false,"pushed_at":"2019-05-29T20:24:44.000Z","size":8,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-12-30T11:32:36.051Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openbase.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}},"created_at":"2019-05-29T19:47:33.000Z","updated_at":"2019-05-29T20:24:45.000Z","dependencies_parsed_at":null,"dependency_job_id":"69d421e4-a1ff-4024-8028-9dfb4f6a6cdc","html_url":"https://github.com/openbase/protoToOpenAPISchema","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbase%2FprotoToOpenAPISchema","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbase%2FprotoToOpenAPISchema/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbase%2FprotoToOpenAPISchema/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openbase%2FprotoToOpenAPISchema/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openbase","download_url":"https://codeload.github.com/openbase/protoToOpenAPISchema/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239780117,"owners_count":19695734,"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":[],"created_at":"2024-11-08T02:54:51.087Z","updated_at":"2025-02-20T04:43:55.986Z","avatar_url":"https://github.com/openbase.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# protoToOpenAPISchema\nA python3 script for the generation of openAPI schemas from protocol buffers.\nThe script currently only works with openAPI definitions as yaml and thus requires the installation of:\n\u003cpre\u003e\n  sudo apt-get install python3-yaml\n\u003c/pre\u003e\n\n# Features\n* Take a proto file or a directory which is recursively searched for proto files and creates openAPI schemas\n* Schemas are written to a yaml file or if an existing openAPI definition in yaml is provided the schemas will be added\n* Does not overwrite existing schemas unless specified\n* Allows adding a prefix to the names of schemas (E.g. the proto message Timestamp combined with the prefix Openbase results in the schema OpenbaseTimestamp.)\n* Referenced messages result in references to their generated schemas\n\n# Limits\n* Only the first message in a proto file is processed (it can contain an arbitrary amount of internal messages and enums)\n\n# Usage\n\u003cpre\u003e\nprotoToOpenAPISchema.py [-h] [-p PROTO] [--openAPI OPENAPI]\n                               [--overwrite] [--schemaPrefix SCHEMAPREFIX]\n\nTool for generating openAPI schemas definitions from protocol buffers.\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -p PROTO, --proto PROTO\n                        proto file or directory. If a directory, it is\n                        recursively searched for proto files. (default: .)\n  --openAPI OPENAPI     openAPI definition file in yaml format to which the\n                        generated schemas will be added. If it does not exist\n                        it will be created. (default: openAPI.yaml)\n  --overwrite           flag determining if schemas should be overwritten if\n                        defined multiple times. (default: False)\n  --schemaPrefix SCHEMAPREFIX\n                        prefix used for every schema name. (default: )\n\u003c/pre\u003e\n\nFor a usage example, refer to the https://github.com/openbase/bco.openapi project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbase%2Fprototoopenapischema","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenbase%2Fprototoopenapischema","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbase%2Fprototoopenapischema/lists"}