contracts.errors
11 / 100Rain
- Purpose
- 6 / 20
- When to use
- 0 / 20
- Arguments
- 5 / 25
- Return value
- 0 / 15
- Constraints and side effects
- 0 / 10
- Examples
- 0 / 10
- MajorThe description only restates the name (5 words).
restates_name - MajorThe description is too short (5 words).
too_short - MajorSays nothing about when to use it, or when not to.
no_usage_context - MajorArguments without a description: pathParams, query, body.
param_no_description - MinorIts description is nearly the same as contracts.dual_plane's (similarity 0.75); only the names and schemas tell them apart. Say in this description when to use contracts.dual_plane instead.
confusable_pair - MinorNo `required` list, so every argument is optional.
no_required - MinorThe description mentions none of its 3 or more arguments.
params_not_in_description - MinorSays nothing about what it returns.
no_return_info - MinorNo constraints, side effects, auth or rate limits described, and no annotations.
no_constraints