Regel voor gebruik RFC 9457

linter/spectral.yml

@@ -183,8 +183,9 @@ rules:
       functionOptions:
         match: ^https://.*
 
+  #/core/error-handling/problem-details
   nlgov:use-problem-schema:
-    severity: warn
+    severity: error
     message: "The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457."
     given: $..[responses][?(@property && @property.match(/(4|5)\d\d/))].content
     then:
@@ -195,6 +196,77 @@ rules:
             - required: ["application/problem+json"]
             - required: ["application/problem+xml"]
 
+  nlgov:problem-schema-members:
+    severity: error
+    message: "{{error}}. These fields are required: status, title and detail."
+    given: $..[responses][?(@property && @property.match(/(4|5)\d\d/))].content[?(@property=="application/problem+json" || @property=="application/problem+xml")]..schema
+    then:
+      function: schema
+      functionOptions:
+        schema:
+          type: object
+          properties:
+            properties:
+              type: object
+              required:
+              - status
+              - title
+              - detail
+
+  #/core/error-handling/invalid-input
+  nlgov:problem-invalid-input:
+    severity: error
+    message: "GET endpoints that have parameters and all other endpoints must be able to return a 400 response"
+    given:
+      - $.paths..[?( @property.match(/get/) && @.parameters && @.parameters.length > 0 )]
+      - $.paths..[?( @property.match(/(put)|(post)|(delete)|(patch)/))]
+    then:
+      function: schema
+      functionOptions:
+        schema:
+          type: object
+          properties:
+            responses:
+              type: object
+              required:
+              - "400"
+
+  #/core/error-handling/bad-request
+  nlgov:problem-schema-members-bad-request:
+    severity: error
+    given: $..[responses][?(@property && @property.match(400))].content[?(@property=="application/problem+json" || @property=="application/problem+xml")]..schema.properties
+    then:
+      function: schema
+      functionOptions:
+        schema:
+          type: object
+          properties:
+            errors:
+              type: object
+              properties:
+                properties:
+                  type: object
+                  properties:
+                    in: {}
+                    detail: {}
+                    location:
+                      type: object
+                      properties:
+                        properties:
+                          type: object
+                          properties:
+                            pointer: {}
+                            name: {}
+                            index: {}
+                          additionalProperties: false
+                    code: {}
+                  required:
+                    - in
+                    - detail
+                  additionalProperties: false
+          required:
+          - errors
+
   nlgov:property-casing:
     severity: warn
     given:

linter/testcases/cor-api/expected-output.txt

@@ -1,28 +1,28 @@
 
 /testcases/cor-api/openapi.json
-  70:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./heartbeat.get.responses[429].content
-  80:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./heartbeat.get.responses[503].content
- 181:29    error  nlgov:paths-kebab-case    /laatsteWijziging is not kebab-case.                                                                                    paths./laatsteWijziging
- 211:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[400].content
- 221:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[404].content
- 231:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[405].content
- 241:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[406].content
- 251:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[429].content
- 261:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[500].content
- 271:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[503].content
- 506:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[400].content
- 516:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[404].content
- 526:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[405].content
- 536:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[406].content
- 546:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[429].content
- 556:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[500].content
- 566:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[503].content
- 684:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[400].content
- 694:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[404].content
- 704:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[405].content
- 714:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[406].content
- 724:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[429].content
- 734:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[500].content
- 744:35  warning  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[503].content
+  70:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./heartbeat.get.responses[429].content
+  80:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./heartbeat.get.responses[503].content
+ 181:29  error  nlgov:paths-kebab-case    /laatsteWijziging is not kebab-case.                                                                                    paths./laatsteWijziging
+ 211:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[400].content
+ 221:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[404].content
+ 231:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[405].content
+ 241:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[406].content
+ 251:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[429].content
+ 261:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[500].content
+ 271:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./laatsteWijziging.get.responses[503].content
+ 506:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[400].content
+ 516:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[404].content
+ 526:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[405].content
+ 536:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[406].content
+ 546:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[429].content
+ 556:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[500].content
+ 566:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties.get.responses[503].content
+ 684:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[400].content
+ 694:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[404].content
+ 704:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[405].content
+ 714:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[406].content
+ 724:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[429].content
+ 734:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[500].content
+ 744:35  error  nlgov:use-problem-schema  The content type of an error response should be application/problem+json or application/problem+xml to match RFC 9457.  paths./organisaties/{oin}.get.responses[503].content
 
-✖ 24 problems (1 error, 23 warnings, 0 infos, 0 hints)
+✖ 24 problems (24 errors, 0 warnings, 0 infos, 0 hints)

linter/testcases/error-type-bad-invalid-input/expected-output.txt

@@ -0,0 +1,7 @@
+
+/testcases/error-type-bad-invalid-input/openapi.json
+ 119:29  error  nlgov:problem-invalid-input  GET endpoints that have parameters and all other endpoints must be able to return a 400 response  paths./invalid-response-vereist.get.responses
+ 157:29  error  nlgov:problem-invalid-input  GET endpoints that have parameters and all other endpoints must be able to return a 400 response  paths./invalid-response-vereist.put.responses
+ 195:29  error  nlgov:problem-invalid-input  GET endpoints that have parameters and all other endpoints must be able to return a 400 response  paths./invalid-response-vereist.post.responses
+
+✖ 3 problems (3 errors, 0 warnings, 0 infos, 0 hints)