OpenAPI Paths No Verbs (Edit)

RESTful API path segments should not contain action verbs. HTTP methods already convey the action, so verbs in paths indicate a non-RESTful design. Paths should describe resources, not actions.

OpenAPIPathsRESTDesign

Rule Definition

openapi-paths-no-verbs-warn.yaml 
{"openapi-paths-no-verbs-warn":{"description":"RESTful API path segments should not contain action verbs. HTTP methods already convey the action, so verbs in paths indicate a non-RESTful design. Paths should describe resources, not actions.","message":"Paths SHOULD NOT contain action verbs.","given":"$.paths.*~","severity":"warn","then":{"function":"pattern","functionOptions":{"notMatch":"(?i)(get|put|post|delete|patch|create|update|remove|fetch|retrieve|list|add|edit|modify|search|find|save|execute|run|start|stop)"}}}}

Back to All of the Rules