no-http-verbs-in-path

When HTTP verbs (get/post/put etc.) are used in path segments, it muddies the semantics of REST and creates a confusing and inconsistent experience.

It’s highly recommended that verbs are not used in path segments. Replace those HTTP verbs with more meaningful nouns.

Why did this violation appear?

An HTTP verb appeared as part of a segment of a path.

What is this rule checking for?

Every path segment does not contain a known HTTP verb.

Bad example

paths: 
  '/go/get/something':
    get:
      description: GET is a part of the path, which is bad
  '/post/new/thing':
    post:
      description: Do not include verbs in paths.

Good Example

paths: 
  '/something':
    get:
      description: A certain thing.
  '/something/else':
    post:
      description: Another thing of some kind.

How do I fix this violation?

Ensure that no path segment uses an HTTP verb. Replace them with meaningful nouns or other verbs that make sense.