{"id":19278288,"url":"https://github.com/icewhaletech/icewhale-openapi","last_synced_at":"2025-06-13T13:02:00.378Z","repository":{"id":172094024,"uuid":"648821910","full_name":"IceWhaleTech/IceWhale-OpenAPI","owner":"IceWhaleTech","description":"OpenAPI and API Document of ZimaOS and CasaOS","archived":false,"fork":false,"pushed_at":"2025-06-10T10:32:39.000Z","size":313,"stargazers_count":6,"open_issues_count":0,"forks_count":4,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-06-10T11:36:05.007Z","etag":null,"topics":["casaos","openapi","sdk","zimaos"],"latest_commit_sha":null,"homepage":"https://casaos.zimaspace.com","language":"HTML","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IceWhaleTech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2023-06-02T22:53:51.000Z","updated_at":"2025-06-10T10:32:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"ad0bbe7a-c0ab-421c-8df3-4651df620b92","html_url":"https://github.com/IceWhaleTech/IceWhale-OpenAPI","commit_stats":null,"previous_names":["icewhaletech/icewhale-openapi"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/IceWhaleTech/IceWhale-OpenAPI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWhaleTech%2FIceWhale-OpenAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWhaleTech%2FIceWhale-OpenAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWhaleTech%2FIceWhale-OpenAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWhaleTech%2FIceWhale-OpenAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IceWhaleTech","download_url":"https://codeload.github.com/IceWhaleTech/IceWhale-OpenAPI/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IceWhaleTech%2FIceWhale-OpenAPI/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259650856,"owners_count":22890379,"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":["casaos","openapi","sdk","zimaos"],"created_at":"2024-11-09T21:09:01.793Z","updated_at":"2025-06-13T13:02:00.259Z","avatar_url":"https://github.com/IceWhaleTech.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://avatars.githubusercontent.com/u/91336243\" height=\"128\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# IceWhale-OpenAPI\n\nThis Git repository is all IceWhale's OpenAPI Documentation. including:\n- [CasaOS](https://github.com/IceWhaleTech/CasaOS)\n- [ZimaOS](https://github.com/IceWhaleTech/ZimaOS)\n\nAPI V2 is our latest API, but it not contain all API. some operation is in V1 yet.\n\n# ZimaOS OpenAPI Live Preview\n- [ZimaOS API V2](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos/zimaos/openapi.yaml): Miscellaneous APIs, GPU, Remote Access, etc.\n- [ZimaOS API V1](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos/zimaos/openapi_v1.yaml): Miscellaneous APIs, System APIs\n- [ZimaOS Local Storage API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-local-storage/local_storage/openapi.yaml): Disk and RAID, etc. APIs\n- [ZimaOS Local Storage API V1](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-local-storage/local_storage/openapi_v1.yaml): USB Mount about APIs.\n- [APP Management API V2](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-app-management/app_management/openapi.yaml): App and AppStore APIs: Docker Compose and App Store\n- [APP Management API V1](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-app-management/app_management/openapi_v1.yaml): App and AppStore APIs: Docker Container(Deprecated)\n- [User API V2](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-user-service/users/openapi.yaml): User APIs: Samba, etc.\n- [User API V1](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-user-service/users/openapi_v1.yaml): User APIs: Login, Register, etc.\n- [ZimaOS File API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/icewhale-files/openapi.yaml): File APIs\n- [Installer API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos-installer/installer/openapi.yaml): OTA APIs\n- [Mod Management API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-mod-management/mod_management/openapi.yaml): Mod APIs\n- [ZVM(Virtual Machine) API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-virt-management/virt_management/openapi.yaml): Virtual Machine APIs\n- [Message Bus API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos-message-bus/message_bus/openapi.yaml): Message Bus APIs\n\n# CasaOS OpenAPI Live Preview\n- [CasaOS API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos/casaos/openapi.yaml): Miscellaneous APIs and File APIs\n- [APP Management API V2](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos-app-management/app_management/openapi.yaml): App and AppStore APIs\n- [APP Management API V1](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos-app-management/app_management/openapi_v1.yaml): App and AppStore APIs\n- [User API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos-user-service/users/openapi.yaml): User APIs\n- [Message Bus API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/casaos-message-bus/message_bus/openapi.yaml): Message Bus APIs\n\n# How to use\n## Use in Javascript/Typescript\nyou can find npm package in [npmjs.com](https://www.npmjs.com/settings/icewhale/packages)\nsuch as:\n```\nnpm install @icewhale/zimaos-localstorage-openapi\n```\n\n```typescript\nimport { StorageMethodsApi } from '@icewhale/zimaos-localstorage-openapi'\n...\nexport const storageApi = new StorageMethodsApi(configuration, '/v2/local_storage', axios)\n...\nstorageApi.getDisk()\n```\n\n## Golang\nyou can use the openapi.yaml file to generate the API code.\n\nsuch as, add the following code to the header of your `main.go` file\n```go\n//go:generate bash -c \"mkdir -p codegen/local_storage \u0026\u0026 go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen@v1.12.4 -generate types,client -package local_stroage https://raw.githubusercontent.com/IceWhaleTech/IceWhale-OpenAPI/main/zimaos-local-storage/local_storage/openapi.yaml \u003e codegen/local_storage/api.go\"\n```\n\nthen run the following command to generate the API code.\n```go\ngo generate\n```\n\n## Other Language\nyou can use the openapi.yaml file to generate the API code.\n\n# Contributing\nthe repo is mirror of OpenAPI of IceWhale's project. if you want to modify the API, please go to the project's repo to modify.\n\n# License\nMIT\n\n# Contact\nFeel free to contact us by Issue.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficewhaletech%2Ficewhale-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficewhaletech%2Ficewhale-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficewhaletech%2Ficewhale-openapi/lists"}