honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarified the information about utils in the README

This commit is contained in:
Karel Minarik 2013-06-19 15:12:20 +02:00
parent b2323afe06
commit 1f33e79345
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
rest-api-spec/README.markdown
View File

@ -46,9 +46,15 @@ The specification contains:
The `methods` and `url.paths` elements list all possible HTTP methods and URLs for the endpoint; The `methods` and `url.paths` elements list all possible HTTP methods and URLs for the endpoint;
it is the responsibility of the developer to use this information for a sensible API on the target platform. it is the responsibility of the developer to use this information for a sensible API on the target platform.
The repository contains a utility script in Ruby which will scan and parse the Elasticsearch source code # Utilities
to extract the information from the Java source files. Run `bundle install` and then `thor help api:generate:spec`
in the _utils_ folder. The repository contains some utilities in the `utils` directory:
* The `thor api:generate:spec` will generate the basic JSON specification from Java source code
* The `thor api:generate:code` generates Ruby source code and tests from the specs, and can be extended
to generate assets in another programming language
Run `bundle install` and then `thor list` in the _utils_ folder.
## License ## License