You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/doc-comments-guide.md
+5Lines changed: 5 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -4,12 +4,17 @@ A specification is not only about formalizing data structures, it's also about e
4
4
5
5
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.
6
6
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
+
7
11
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.
8
12
9
13
## Example
10
14
11
15
```ts
12
16
/**
17
+
* Get ranking evaluation.
13
18
* Enables you to evaluate the quality of ranked search results over a set of typical search queries.
0 commit comments