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

Merge pull request #17403 from elastic/docs/remove-rest-api-utils-reference 

Remove reference to utils for generating REST docs
This commit is contained in:
Isabel Drost-Fromm 2016-03-30 21:18:41 +02:00
parent 1402d28af7 72d1ed65a4
commit 132f96b6ba
1 changed files with 0 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -46,20 +46,6 @@ The specification contains:
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.
# Utilities
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.
The full command to generate the api spec is:
thor api:spec:generate --output=myfolder --elasticsearch=/path/to/es
## License
This software is licensed under the Apache License, version 2 ("ALv2").