Skip to content

Commit 1df7382

Browse files
authored
[DOCS] Note doc links should be live in REST API JSON specs (elastic#53871)
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.
1 parent 23cccf0 commit 1df7382

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

rest-api-spec/README.markdown

+6-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,12 @@ Example for the ["Create Index"](https://www.elastic.co/guide/en/elasticsearch/r
4343
The specification contains:
4444

4545
* The _name_ of the API (`indices.create`), which usually corresponds to the client calls
46-
* Link to the documentation at the <http://elastic.co> website
46+
* Link to the documentation at the <http://elastic.co> website.
47+
48+
**IMPORANT:** This should be a _live_ link. Several downstream ES clients use
49+
this link to generate their documentation. Using a broken link or linking to
50+
yet-to-be-created doc pages can break the [Elastic docs
51+
build](https://github.com/elastic/docs#building-documentation).
4752
* `stability` indicating the state of the API, has to be declared explicitly or YAML tests will fail
4853
* `experimental` highly likely to break in the near future (minor/patch), no bwc guarantees.
4954
Possibly removed in the future.

0 commit comments

Comments
 (0)