Skip to content

Adds links that point to the API contrib guidelines to repo docs #5131

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.

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 8 commits into from
Aug 19, 2025
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ The repository has the following structure:
This JSON representation is formally defined by [a set of TypeScript definitions (a meta-model)](./compiler/src/model/metamodel.ts)
that also explains the various properties and their values.

> [!TIP]
> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to the [Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/).

## Prepare the environment

Expand Down Expand Up @@ -83,6 +85,10 @@ An interactive viewer for the Elasticsearch specification is available

See [CONTRIBUTING.md](./CONTRIBUTING.md)

Refer to the
[Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/)
for more details about the API documentation guidelines.

## Make Targets

```
Expand Down
3 changes: 3 additions & 0 deletions docs/add-new-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ in this repository, or we do have an endpoint definition in [`/specification/_js
but we don't have a type definition for it.
In this document you will see how to add a new endpoint and how to add a new endpoint definition.

> [!TIP]
> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to the [Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/).

## How to add a new endpoint

Add a new endpoint is straightforward, you only need to copy-paste the json rest-api-spec definition
Expand Down
4 changes: 3 additions & 1 deletion docs/doc-comments-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A specification is not only about formalizing data structures, it's also about e
Documentation of the TypeScript specification is made using [JSDoc](https://jsdoc.app/) comments, i.e. multiline comments starting with `/**` above a type or field declaration.

The first phrase is used as the mandatory operation summary in the OpenAPI document.
Refer to [API documentation guidelines](https://docs.elastic.dev/content-architecture/oas#summaries).
Refer to the [Elastic API docs contribution guidelines](https://www.elastic.co/docs/extend/contribute/api-docs/guidelines) to learn more about how to create great documentation for your API.

> [!NOTE]
> You must add a period at the end of the phrase for it to parse correctly. The period will be properly omitted from the output OpenAPI document.
Expand Down Expand Up @@ -76,6 +76,8 @@ GFM also has implementations in most languages, meaning that code generators wil

## Structuring a doc-comment

For guidelines of how to write great doc-comments, refer to the [Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/guidelines#write-descriptions) page.

### Terseness

**Doc comments are reference material**: they should be as succinct as possible while capturing all the necessary information to use the elements they're documenting. Remember that they will often show up in small IDE autocompletion popups!
Expand Down
3 changes: 3 additions & 0 deletions docs/schema-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ for describing APIs that can't be represented in the specification.
Refer to the [documentation guide](doc-comments-guide.md) to add documentation to types and fields,
and to the [modeling guide](modeling-guide.md) to learn how to model the different types.

> [!TIP]
> To learn more about how to write docs specifically for our [API references](https://www.elastic.co/docs/api/), refer to the [Contribute to Elastic API docs](https://www.elastic.co/docs/extend/contribute/api-docs/).

You can find the schema representing all APIs and types in the [output folder](output/schema/schema.json).
The schema is structured as follows:

Expand Down
Loading