Skip to content

Commit 6b1e923

Browse files
committed
Add operation summary explanation
1 parent a0494e4 commit 6b1e923

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/doc-comments-guide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,17 @@ A specification is not only about formalizing data structures, it's also about e
44

55
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.
66

7+
The first phrase is used as the mandatory operation summary in the OpenAPI document.
8+
Refer to [API documentation guidelines](https://docs.elastic.dev/content-architecture/oas#summaries)
9+
NOTE: You must add a period at the end of the phrase for it to parse correctly, but the period will be properly omitted from the output OpenAPI document.
10+
711
Additional lines start with a `*` followed by a space. Long lines are allowed but it's better if text is formatted to a maximum of 120 characters per line.
812

913
## Example
1014

1115
```ts
1216
/**
17+
* Get ranking evaluation.
1318
* Enables you to evaluate the quality of ranked search results over a set of typical search queries.
1419
* @rest_spec_name rank_eval
1520
* @availability stack since=6.2.0 stability=stable

0 commit comments

Comments
 (0)