{"id":30996913,"url":"https://github.com/yunify/qingcloud-api-specs","last_synced_at":"2025-09-12T22:17:35.779Z","repository":{"id":24743382,"uuid":"101607421","full_name":"yunify/qingcloud-api-specs","owner":"yunify","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-20T06:57:15.000Z","size":220,"stargazers_count":3,"open_issues_count":1,"forks_count":16,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-01-20T07:37:03.975Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/yunify.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":"2017-08-28T05:36:46.000Z","updated_at":"2025-01-20T06:57:17.000Z","dependencies_parsed_at":"2023-02-10T13:02:52.420Z","dependency_job_id":"335b5cee-37b6-4651-b62d-38246c0ebd4d","html_url":"https://github.com/yunify/qingcloud-api-specs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/yunify/qingcloud-api-specs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yunify%2Fqingcloud-api-specs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yunify%2Fqingcloud-api-specs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yunify%2Fqingcloud-api-specs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yunify%2Fqingcloud-api-specs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yunify","download_url":"https://codeload.github.com/yunify/qingcloud-api-specs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yunify%2Fqingcloud-api-specs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274885850,"owners_count":25368223,"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","status":"online","status_checked_at":"2025-09-12T02:00:09.324Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2025-09-12T22:17:34.138Z","updated_at":"2025-09-12T22:17:35.752Z","avatar_url":"https://github.com/yunify.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QingCloud API Specs\n\n\u003cspan style=\"display: inline-block\"\u003e\n[![Build Status]()]()\n[![License](http://img.shields.io/badge/license-apache%20v2-blue.svg)](https://github.com/yunify/qingcloud-api-specs/blob/master/LICENSE)\n\u003c/span\u003e\n\nSpecifications of QingCloud APIs.\n\n## Specification\n\nIn QingCloud, we use [OpenAPI Specification (Swagger) v2.0](http://swagger.io) to describe our APIs, and this API specifications can be used to generate code for SDKs and generate documentations.\n\nA customized data type was added to the original OpenAPI Specification v2.0 standard for better describing our APIs.\n\nView [the OpenAPI Specification (Swagger) v2.0 schema](./api_spec_schema_swagger_v2.0.json).\n\nView [an API specification example](./api_spec_example_swagger_v2.0.json) using this schema.\n\n#### Customized Data Types\n\n| Common Name | [`type`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#dataTypeType) | [`format`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#dataTypeFormat) | Comments |\n|--------------------|----------|--------------------|--------------------------------------------|\n| DateTime (RFC 822) | `string` | `date-time-rfc822` | Example: `Mon, 02 Jan 2006 15:04:05 GMT` |\n\nRefer to [___data types___](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types) in OpenAPI Specification (Swagger) v2.0 for more information.\n\n### Directory Organization\n\nThe structure of the directories has following levels:\n\n1. Name of Service\n2. API Version\n3. Specification Format\n4. the Specification\n\n#### For Example:\n\n``` bash\n└── 2013-08-30\n    └── swagger\n        ├── api_v2.0.json\n        ├── definitions.json\n        ├── instance.json\n        ├── volume.json\n        ...\n```\n\nCurrently, the specifications are expected to be in the OpenAPI Specification (Swagger) v2.0's JSON format.\n\n## Validation\n\nThere is a lot of tools to validate JSON file with its JSON schema, we chose [`z-schema`](https://github.com/zaggino/z-schema) to do this.\n\n___Notice:___ _[NodeJS](https://nodejs.org/en/) is required._\n\nGet in the project directory and install dependencies.\n\n``` bash\n$ npm install\n```\n\nRun the validate script.\n\n``` bash\n$ npm test # or `npm t`\n```\n\n## Reference Documentations\n\n- [OpenAPI Specification (Swagger)](http://swagger.io)\n- [JSON Schema](http://json-schema.org)\n\n## Contributing\n\n1. Fork it ( https://github.com/yunify/qingcloud-api-specs/fork )\n2. Create your feature branch (`git checkout -b new-feature`)\n3. Commit your changes (`git commit -asm 'Add some feature'`)\n4. Push to the branch (`git push origin new-feature`)\n5. Create a new Pull Request\n\n## LICENSE\n\n[The Apache License (Version 2.0, January 2004)](http://www.apache.org/licenses/LICENSE-2.0.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyunify%2Fqingcloud-api-specs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyunify%2Fqingcloud-api-specs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyunify%2Fqingcloud-api-specs/lists"}