Skip to content

Commit 3dfec27

Browse files
authored
docs: add further justification for inline response schema warnings (#226)
Resolves #125
1 parent 9e357b4 commit 3dfec27

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ The supported rules are described below:
284284
##### [responses][4]
285285
| Rule | Description | Spec |
286286
| ------------------------- | ------------------------------------------------------------ | ---- |
287-
| inline_response_schema | Flag any response object with a schema that doesn't reference a named model. | shared |
287+
| inline_response_schema | Flag any response object with a schema that doesn't reference a named model. Even if the model is only used once, naming it offers significant benefits for SDK generation. | shared |
288288
| no_response_codes | Flag any response object that has no valid response codes. | oas3 |
289289
| no_success_response_codes | Flag any response object that has no success response codes. | oas3 |
290290
| no_response_body | Flag any non-204 success responses without a response body. | oas3 |

0 commit comments

Comments
 (0)