Skip to main content

Path Nouns

ItemDescription
Full Fuzzer NamePathNounsLinterFuzzer
Log KeyPNL
DescriptionThis linter will check if path naming favours using nouns, rather than verbs. For example, favor /users instead of /postNewUser
Enabled by default?No. You need to use the cats lint ... sub-command.
Target contract elementsOpenAPI contract metadata and structures relevant to this rule.
Expected resultsuccess when no violation is found; error when the rule is violated.
Fuzzing logicInspects the OpenAPI contract without sending HTTP requests and reports violations of this rule.
Conditions when this fuzzer will be skippedNone; the linter runs once for the supplied contract.
HTTP methods that will be skippedN/A — no HTTP requests are sent.
ReportingReports success if the path naming favours using nouns, or error otherwise.