Skip to content

Commit

Permalink
[DOCS] Note doc links should be live in REST API JSON specs (#53871)
Browse files Browse the repository at this point in the history
Downstream Elasticsearch clients, such as the Elaticsearch-JS client,
use the documentation links in our REST API JSON specifications to
create their docs.

Using a broken link or linking to yet-to-be-created doc pages can
break the docs build for these clients.

This PR adds a related note to the README for the REST API JSON Specs.
  • Loading branch information
jrodewig committed Mar 23, 2020
1 parent a373662 commit 8ad4e7a
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion rest-api-spec/README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,12 @@ Example for the ["Create Index"](http://www.elastic.co/guide/en/elasticsearch/re
The specification contains:

* The _name_ of the API (`indices.create`), which usually corresponds to the client calls
* Link to the documentation at the <http://elastic.co> website
* Link to the documentation at the <http://elastic.co> website.

**IMPORANT:** This should be a _live_ link. Several downstream ES clients use
this link to generate their documentation. Using a broken link or linking to
yet-to-be-created doc pages can break the [Elastic docs
build](https://github.com/elastic/docs#building-documentation).
* `stability` indicating the state of the API, has to be declared explicitly or YAML tests will fail
* `experimental` highly likely to break in the near future (minor/path), no bwc guarantees.
Possibly removed in the future.
Expand Down

0 comments on commit 8ad4e7a

Please sign in to comment.