Update development documentation about REST API best practices (#80009)
* Update development-documentation.asciidoc * Change to raw links, not rendered links
This commit is contained in:
parent
1f56371add
commit
3ac07921a7
|
@ -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
|
||||||
|
|
Loading…
Reference in a new issue