github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 11:05:39 -04:00
Code Issues Projects Releases Packages Wiki Activity

Update development documentation about REST API best practices (#80009)

Browse source 
* Update development-documentation.asciidoc

* Change to raw links, not rendered links
This commit is contained in:
Stacey Gammon 2020-10-08 15:11:49 -04:00 • committed by GitHub
parent 1f56371add
commit 3ac07921a7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/developer/contributing/development-documentation.asciidoc
View file

@ -26,6 +26,13 @@ README for getting the docs tooling set up.
```bash ```bash
node scripts/docs.js --open node scripts/docs.js --open
``` ```
[discrete]
==== REST APIs
REST APIs should be documented using the following recommended formats:
* https://raw.githubusercontent.com/elastic/docs/master/shared/api-ref-ex.asciidoc[API doc templaate]
* https://raw.githubusercontent.com/elastic/docs/master/shared/api-definitions-ex.asciidoc[API object definition template]
[discrete] [discrete]
=== General developer documentation and guidelines === General developer documentation and guidelines