Skip to content

Update development documentation about REST API best practices #80009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 8, 2020
Merged

Update development documentation about REST API best practices #80009

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ac45d44
Update development-documentation.asciidoc
Oct 8, 2020
23630ed
Change to raw links, not rendered links
Oct 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/developer/contributing/development-documentation.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@ README for getting the docs tooling set up.
```bash
node scripts/docs.js --open
```
[discrete]
==== REST APIs

REST APIs should be documented using the following recommended formats:

* https://github.com/elastic/docs/blob/master/shared/api-ref-ex.asciidoc[API doc templaate]
* https://github.com/elastic/docs/blob/master/shared/api-definitions-ex.asciidoc[API object definition template]

[discrete]
=== General developer documentation and guidelines
Expand Down