test: add test for server variable description

readmeio · May 13, 2024 · c473bb9 · c473bb9
1 parent 9ad9bff
commit c473bb9
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/test/specs/validate-spec/valid/3.1/server-variable-description.yaml b/test/specs/validate-spec/valid/3.1/server-variable-description.yaml
@@ -0,0 +1,16 @@
+openapi: 3.1.0
+info:
+  version: "1.0"
+  title: Invalid API
+servers:
+  - url: https://{subdomain}.io
+    variables:
+      subdomain:
+        default: petstore
+        description: lorem ipsum
+paths:
+  /anything:
+    get:
+      responses:
+        '200':
+          description: OK
diff --git a/test/specs/validate-spec/validate-spec.spec.js b/test/specs/validate-spec/validate-spec.spec.js
@@ -318,6 +318,10 @@ describe('Invalid APIs (specification validation)', () => {
       it('OpenAPI 3.1', () => assertValid('3.1/component-schema-with-hyphens.yaml'));
     });
 
+    describe('should allow description property in server variables', () => {
+      it('OpenAPI 3.1', () => assertValid('3.1/server-variable-description.yaml'));
+    });
+
     describe('should catch a component schema name that contains a space', () => {
       it('OpenAPI 3.0', () => {
         return assertInvalid(