diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 45 |
1 files changed, 45 insertions, 0 deletions
@@ -0,0 +1,45 @@ +ALIBABA CLOUD API METADATA +========================== + +INTRODUCTION +------------ +This repository provides scripts that generate and maintain Alibaba Cloud +API metadata from the OpenMeta service for API documentation and SDK +generation. + + +BUILD +----- +Metadata is updated regularly to reflect the latest API changes. It is +maintained in two formats: JSON and PHP arrays. + +JSON metadata: `scripts/update-metadata.sh` fetches the latest metadata +from Alibaba Cloud. + +PHP metadata: `php-generator/generate.php` converts JSON metadata into +PHP arrays. + +The Makefile automates the update and build process. Run: + + make + +The following artifacts will be generated in the `build/` directory: + +- release-<YYYYMMDD>-json.tar.gz +- release-<YYYYMMDD>-php.tar.gz + +To build only one format, run one of the following commands: + + make build-json + make build-php + +Because Alibaba Cloud provides many services, metadata updates can take +time. Set `CONCURRENCY` to control how many HTTP requests run at the same +time. Use `make -j2` to fetch English and Chinese metadata in parallel: + + CONCURRENCY=8 make -j2 + + +AUTHOR +------ +Zhineng Li <[email protected]> |