feat: Delete rules considered overengineering or too strict (#33)

Deleted the following linting rules: path-dto-reference, http-verbs-should-be-used, must-have-response-body

README.md

@@ -18,7 +18,6 @@ rules:
   path-must-match-api-standards: warn
   servers-must-match-api-standards: warn
   common-responses-unauthorized: warn
-  http-verbs-should-be-used: warn
   no-http-verbs-in-resources: warn
   description-is-mandatory: warn
 ```

spectral-api.yml

@@ -5,15 +5,11 @@ rules:
   path-must-match-api-standards: off # Rule is still under discussion and therefore disabled
   servers-must-match-api-standards: off # Rule is still under discussion and therefore disabled
   common-responses-unauthorized: hint
-  http-verbs-should-be-used: info
   no-http-verbs-in-resources: warn
   path-description-is-mandatory: warn
   info-description: warn
   contact-information: warn
-  path-dto-reference: warn
   must-have-path: warn
-  must-have-response-body: warn
-  oas2-must-have-response-body: warn
   must-have-content-type: warn
   must-define-example-schema: warn
   path-must-specify-tags: warn

spectral-bff.yml

@@ -5,15 +5,11 @@ rules:
   path-must-match-api-standards: off # Rule is still under discussion and therefore disabled
   servers-must-match-api-standards: off # Rule is still under discussion and therefore disabled
   common-responses-unauthorized: hint
-  http-verbs-should-be-used: off
   no-http-verbs-in-resources: info
   path-description-is-mandatory: info
   info-description: info
   contact-information: info
-  path-dto-reference: info
   must-have-path: info
-  must-have-response-body: info
-  oas2-must-have-response-body: info
   must-have-content-type: info
   must-define-example-schema: info
   path-must-specify-tags: info

spectral-legacy.yml

@@ -5,15 +5,11 @@ rules:
   path-must-match-api-standards: off # Rule is still under discussion and therefore disabled
   servers-must-match-api-standards: off # Rule is still under discussion and therefore disabled
   common-responses-unauthorized: hint
-  http-verbs-should-be-used: off
   no-http-verbs-in-resources: info
   path-description-is-mandatory: info
   info-description: info
   contact-information: info
-  path-dto-reference: info
   must-have-path: info
-  must-have-response-body: info
-  oas2-must-have-response-body: info
   must-have-content-type: info
   must-define-example-schema: info
   path-must-specify-tags: info

spectral.yml

@@ -46,15 +46,6 @@ rules:
         function: truthy
       - field: url
         function: truthy
-  path-dto-reference:
-    description: DTOs should be used to specify the schema(data types) of a request / response
-    message: "{{description}}; property {{property}} is missing"
-    severity: error
-    given: $.components.schemas
-    then:
-      - function: length
-        functionOptions:
-          min: 1
   must-have-path:
     description: Every API must have at least one path
     message: "{{description}}; property `paths` is empty"
@@ -73,22 +64,6 @@ rules:
     then:
       - field: '401'
         function: truthy
-  http-verbs-should-be-used:
-    description: HTTP verbs should be used to express different actions or functions on a resource
-    message: "{{description}}; The HTTP verb {{property}} is missing."
-    severity: error
-    given: $.paths[?(!@property.match(/well-known/ig))]
-    then:
-      - field: get
-        function: truthy
-      - field: post
-        function: truthy
-      - field: put
-        function: truthy
-      - field: patch
-        function: truthy
-      - field: delete
-        function: truthy
   no-http-verbs-in-resources:
     description: The HTTP Verbs should not be used in the route path to define different actions on a resource
     message: "{{description}}; {{property}} Instead use HTTP verbs to define actions on a resource. Example: PUT - /digital-twin/api/v1/products/42"
@@ -108,18 +83,6 @@ rules:
         function: truthy
     formats:
       - oas3
-  must-have-response-body:
-    description: Every route returning a http status code of 200 or 201 must have a response body defined
-    message: "{{description}}; property {{property}} is missing at path: {{path}}"
-    severity: error
-    given: $.paths[?(!@property.match(/well-known/ig))].[?(@property === 'get')].responses[200,201,"200","201"]
-    then:
-      - field: content
-        function: truthy
-      - field: description
-        function: truthy
-    formats:
-      - oas3
   must-have-content-type:
     description: Every response must specify its content type
     message: "{{description}}; property {{property}} is missing or not a valid content-type"
@@ -157,15 +120,3 @@ rules:
           min: 1
     formats:
       - oas3
-  oas2-must-have-response-body:
-    description: Every route returning a http status code of 200 or 201 must have a response body defined
-    message: "{{description}}; property {{property}} is missing at path: {{path}}"
-    severity: error
-    formats:
-      - oas2
-    given: $.paths[?(!@property.match(/well-known/ig))].[?(@property === 'get')].responses[200,201,"200","201"]
-    then:
-      - field: schema
-        function: truthy
-      - field: description
-        function: truthy