CLOUDP-306573: Dont require gzip to have example

Author: lovisaberggren

tools/spectral/ipa/__tests__/IPA117PlaintextResponseMustHaveExample.test.js

@@ -34,7 +34,7 @@ testRule('xgen-IPA-117-plaintext-response-must-have-example', [
             },
           },
         },
-        // Ignores JSON/YAML
+        // Ignores JSON/YAML/gzip
         '/resourceTwo': {
           get: {
             responses: {
@@ -46,6 +46,9 @@ testRule('xgen-IPA-117-plaintext-response-must-have-example', [
                   'application/vnd.atlas.2024-08-05+yaml': {
                     type: 'string',
                   },
+                  'application/vnd.atlas.2024-08-05+gzip': {
+                    type: 'binary',
+                  },
                 },
               },
             },

tools/spectral/ipa/rulesets/IPA-117.yaml

@@ -166,7 +166,7 @@ rules:
 
       ##### Implementation details
         - The rule only applies to 2xx responses
-        - The rule ignores JSON and YAML responses (passed as `allowedTypes`)
+        - The rule ignores JSON, YAML and GZIP responses (passed as `allowedTypes`)
         - The rule checks for the presence of the example property as a sibling to the `schema` property, or inside the `schema` object
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-117-plaintext-response-must-have-example'
     severity: warn
@@ -176,7 +176,7 @@ rules:
       field: '@key'
       function: 'IPA117PlaintextResponseMustHaveExample'
       functionOptions:
-        allowedTypes: ['json', 'yaml']
+        allowedTypes: ['json', 'yaml', 'gzip']
   xgen-IPA-117-objects-must-be-well-defined:
     description: |
       Components of type "object" must be well-defined, i.e. have of one of the properties:

tools/spectral/ipa/rulesets/README.md

@@ -728,7 +728,7 @@ For APIs that respond with plain text, for example CSV, API producers must provi
 
 ##### Implementation details
   - The rule only applies to 2xx responses
-  - The rule ignores JSON and YAML responses (passed as `allowedTypes`)
+  - The rule ignores JSON, YAML and GZIP responses (passed as `allowedTypes`)
   - The rule checks for the presence of the example property as a sibling to the `schema` property, or inside the `schema` object
 
 #### xgen-IPA-117-objects-must-be-well-defined