Skip to content

Commit bc80291

Browse files
committed
Update modeling-guide.md
1 parent 21bfe67 commit bc80291

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/modeling-guide.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -631,6 +631,24 @@ class Request {
631631
foobar,/guide/en/example
632632
```
633633
634+
#### `@doc_tag`
635+
636+
An OpenAPI tag that is used to group similar endpoints in the API documentation.
637+
If it is absent, by default the tag is derived from the first part of the namespace.
638+
639+
```ts
640+
/**
641+
* @rest_spec_name api
642+
* @doc_tag my tag
643+
*/
644+
class Request {
645+
...
646+
}
647+
```
648+
649+
NOTE: In the OpenAPI specification, operations can have multiple tags. However, we currently support only a single tag.
650+
651+
634652
#### `@codegen_name`
635653
636654
A custom name that can be used to display the property. Useful in Enums and

0 commit comments

Comments
 (0)