Skip to content

Commit 773c18c

Browse files
committed
updated references to operationId
Signed-off-by: bidi47 <bidi@apidemia.com>
1 parent 7e8620b commit 773c18c

1 file changed

Lines changed: 1 addition & 3 deletions

File tree

‎docs/book/v7/openapi/write-documentation.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,6 @@ The following parameter is available on every request object but is not required
107107

108108
- `operationId`: a name for the operation, unique across the whole document (example: `getUserCollection`).
109109
Client generators typically use it as the method name, and `Link` objects use it to refer to an operation.
110-
The endpoints shipped with Dotkernel API do not set it.
111110

112111
## Conclusion
113112

@@ -141,8 +140,7 @@ A: Omit the `security` parameter.
141140

142141
**Q: Do I need `operationId`?**
143142

144-
A: No.
145-
It is optional and the shipped endpoints omit it.
143+
A: No, it is optional.
146144
Set it if you generate a client from the specification and want stable method names; it must be unique across the document.
147145

148146
**Q: What is the difference between `description` and `summary`?**

0 commit comments

Comments
 (0)