{"id":21009783,"url":"https://github.com/chatbootai/chatbootai-openapi","last_synced_at":"2025-03-13T15:28:45.125Z","repository":{"id":207575330,"uuid":"719565205","full_name":"ChatBootAI/chatbootai-openapi","owner":"ChatBootAI","description":"Repository for ChatBootAI OpenAPI Contract as well as many generated languages stubs and models","archived":false,"fork":false,"pushed_at":"2024-01-23T15:40:39.000Z","size":172,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-11T00:16:33.559Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ChatBootAI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-11-16T12:47:13.000Z","updated_at":"2024-06-12T12:47:35.000Z","dependencies_parsed_at":"2024-01-09T15:48:49.321Z","dependency_job_id":"e230e412-a2c0-4800-9581-7e3a1b2ba2bd","html_url":"https://github.com/ChatBootAI/chatbootai-openapi","commit_stats":null,"previous_names":["chatbootai/chatbootai-openapi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChatBootAI%2Fchatbootai-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChatBootAI%2Fchatbootai-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChatBootAI%2Fchatbootai-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChatBootAI%2Fchatbootai-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ChatBootAI","download_url":"https://codeload.github.com/ChatBootAI/chatbootai-openapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243431541,"owners_count":20289910,"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-19T09:17:55.572Z","updated_at":"2025-03-13T15:28:45.104Z","avatar_url":"https://github.com/ChatBootAI.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ChatBootAI - OpenAPI\n\nThis repository contains the ChatBootAI OpenAPI Contract as well as many generated languages stubs and models.\nThe directory structure is as follows:\n\n```\n.\n├── LICENSE\n├── README.md\n├── CODE_OF_CONDUCT.md\n├── CONTRIBUTING.md\n├── java                        # The generated Java SDK\n│   ├── jakarta-api             # The Jakarta EE REST API\n│   ├── jakarta-model           # The Jakarta EE Model\n│   ├── jaxrs-api\n│   └── jaxrs-model\n├── javascript\n│   ├── javascript-api\n│   └── javascript-model\n├── python\n│   ├── python-api\n│   └── python-model\n└── openapi                  \n    ├── openapi-chatbootai.yml  # The ChatBootAI OpenAPI Contract\n    └── generated-sources       # The temporary generated sources\n        ├── java\n        ├── javascript\n        └── python\n```\n\n# The ChatBootAI OpenAPI Contract\n\nThe ChatBootAI OpenAPI Contract in located under the `openapi.yml` file.\n\nYou can also visualize the OpenAPI Contract using the [OpenAPI online editor](https://editor.swagger.io?url=https://raw.githubusercontent.com/ChatBootAI/chatbootai-openapi/main/openapi/openapi-chatbootai.yml)\n\n# Manually Generating the model and APIs from the ChatBootAI OpenAPI Contract\n\n[OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) allows generation of API client libraries (SDK generation), server stubs, and documentation automatically given an OpenAPI Spec.\nSwagger CodeGen supports several programming languages.\nExecute the following command to see the list of supported languages and framworks:\n\n```bash\nopenapi-generator list\n```\n\nYou will something like this:\n\n```bash\nCLIENT generators:\n    - ada\n    - android\n    - apex\n    - bash\n    - c\n    - clojure\n    - cpp-qt-client\n    - cpp-restsdk\n    - cpp-tiny (beta)\n    - cpp-tizen\n    - cpp-ue4 (beta)\n    ...\n```\n\nFor example, to generate a Java client library from the ChatBootAI OpenAPI Contract, run the following command:\n\n```bash\nopenapi-generator generate -i openapi-chatbootai.yml -g jaxrs-spec -o ./java/java-api --api-package ai.chatboot.api --model-package ai.chatboot.model\n```\n\n# References\n\n* [OpenAPI Initiative](https://www.openapis.org/) and the [OpenAPI Specification](https://spec.openapis.org/oas/latest.html)\n* [The OpenAPI API Reference for the OpenAI endpoints](https://platform.openai.com/docs/api-reference/chat)\n* [The OpenAI OpenAPI contract](https://github.com/openai/openai-openapi)\n* [Chat Backend Protocol](https://github.com/Azure/azureml_run_specification/blob/chat-protocol/specs/chat-protocol/chat-app-protocol.md)\n* [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator)\n* [OpenAPI online editor](https://editor.swagger.io)\n* [Kiota](https://learn.microsoft.com/en-us/openapi/kiota)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchatbootai%2Fchatbootai-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchatbootai%2Fchatbootai-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchatbootai%2Fchatbootai-openapi/lists"}