feat: add support for OpenAPI 3.0.4

Refs #3753
swagger-api · Dec 30, 2024 · d02d7b6 · d02d7b6
1 parent b6af0cb
commit d02d7b6
Show file tree

Hide file tree

Showing 29 changed files with 321 additions and 168 deletions.
diff --git a/README.md b/README.md
@@ -22,11 +22,12 @@ We'll be consolidating that soon. Just giving you the heads-up. You may see refe
 The OpenAPI Specification has undergone multiple revisions since initial creation in 2010. 
 Compatibility between Swagger Client and the OpenAPI Specification is as follows:
 
-Swagger Client Version | Release Date | OpenAPI Spec compatibility             | Notes
------------------- |--------------|----------------------------------------| -----
-3.19.x | 2023-01-23   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0 | [tag v3.19.0-alpha.3](https://github.com/swagger-api/swagger-js/releases/tag/v3.19.0-alpha.3)
-3.10.x | 2020-01-17   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3        | [tag v3.10.0](https://github.com/swagger-api/swagger-js/tree/v3.10.0)
-2.1.32 | 2017-01-12   | 1.0, 1.1, 1.2                          | [tag v2.1.32](https://github.com/swagger-api/swagger-js/tree/v2.1.32). This [release](https://github.com/swagger-api/swagger-js/releases/tag/v2.1.32) is only available on GitHub.
+Swagger Client Version | Release Date | OpenAPI Spec compatibility                    | Notes
+------------------ |--------------|-----------------------------------------------| -----
+3.33.x | 2024-12-30   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.1.0 | [tag v3.33.0](https://github.com/swagger-api/swagger-js/releases/tag/v3.33.0)
+3.19.x | 2023-01-23   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0        | [tag v3.19.0-alpha.3](https://github.com/swagger-api/swagger-js/releases/tag/v3.19.0-alpha.3)
+3.10.x | 2020-01-17   | 2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3               | [tag v3.10.0](https://github.com/swagger-api/swagger-js/tree/v3.10.0)
+2.1.32 | 2017-01-12   | 1.0, 1.1, 1.2                                 | [tag v2.1.32](https://github.com/swagger-api/swagger-js/tree/v2.1.32). This [release](https://github.com/swagger-api/swagger-js/releases/tag/v2.1.32) is only available on GitHub.
 
 ## Anonymized analytics
 

diff --git a/docs/usage/http-client-for-oas-operations.md b/docs/usage/http-client-for-oas-operations.md
@@ -32,11 +32,11 @@ Property | Description
 `contextUrl` | `String`. URL, e.g. `https://example.com`. Used in following situations: <br /><br />If `server` option is not matched and there is no `Server Object` defined in the definition, this URL will be prepended to every requested path.<br /><br />If matched `Server Object` is defined as relative URI Reference its `url` fixed field is resolved against `contenxtUrl`. Resolved URL will be prepended to every requested path. 
 `baseURL` | `String`. URL (`https://example.com`) . Takes precedence over server and any defined servers in the Spec. It will be prepended to every requested path.
 
-For all later references, we will always use following OpenAPI 3.0.0 definition when referring
+For all later references, we will always use following OpenAPI 3.0.4 definition when referring
 to a `spec`.
 
 ```yaml
-openapi: 3.0.0
+openapi: 3.0.4
 info:
   title: Testing API
   version: 1.0.0

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -74,11 +74,11 @@
   "dependencies": {
     "@babel/runtime-corejs3": "^7.22.15",
     "@scarf/scarf": "=1.4.0",
-    "@swagger-api/apidom-core": ">=1.0.0-beta.3 <1.0.0-rc.0",
-    "@swagger-api/apidom-error": ">=1.0.0-beta.3 <1.0.0-rc.0",
-    "@swagger-api/apidom-json-pointer": ">=1.0.0-beta.3 <1.0.0-rc.0",
-    "@swagger-api/apidom-ns-openapi-3-1": ">=1.0.0-beta.3 <1.0.0-rc.0",
-    "@swagger-api/apidom-reference": ">=1.0.0-beta.3 <1.0.0-rc.0",
+    "@swagger-api/apidom-core": ">=1.0.0-beta.6 <1.0.0-rc.0",
+    "@swagger-api/apidom-error": ">=1.0.0-beta.6 <1.0.0-rc.0",
+    "@swagger-api/apidom-json-pointer": ">=1.0.0-beta.6 <1.0.0-rc.0",
+    "@swagger-api/apidom-ns-openapi-3-1": ">=1.0.0-beta.6 <1.0.0-rc.0",
+    "@swagger-api/apidom-reference": ">=1.0.0-beta.6 <1.0.0-rc.0",
     "cookie": "~0.7.2",
     "deepmerge": "~4.3.0",
     "fast-json-patch": "^3.0.0-1",

diff --git a/src/helpers/openapi-predicates.js b/src/helpers/openapi-predicates.js
@@ -9,7 +9,7 @@ export const isOpenAPI2 = (spec) => {
 export const isOpenAPI30 = (spec) => {
   try {
     const { openapi } = spec;
-    return typeof openapi === 'string' && /^3\.0\.([0123])(?:-rc[012])?$/.test(openapi);
+    return typeof openapi === 'string' && /^3\.0\.(?:[1-9]\d*|0)$/.test(openapi);
   } catch {
     return false;
   }

diff --git a/src/subtree-resolver/index.js b/src/subtree-resolver/index.js
@@ -14,7 +14,7 @@
 //
 // This is useful for cases where resolving your entire object is unnecessary
 // and/or non-performant; we use this interface for lazily resolving operations
-// and models in Swagger-UI, which allows us to handle larger definitions.
+// and models in Swagger-UI, which allows us to handle larger OpenAPI descriptions.
 //
 // It's likely that Swagger-Client will rely entirely on lazy resolving in
 // future versions.

diff --git a/test/bugs/ui-4071.js b/test/bugs/ui-4071.js
@@ -2,7 +2,7 @@
 import { buildRequest } from '../../src/execute/index.js';
 
 const spec = {
-  openapi: '3.0.0',
+  openapi: '3.0.4',
   servers: [
     {
       url: 'https://workbcjobs.api.gov.bc.ca/v1',

diff --git a/test/data/issue-1719-ref-object-reference.yaml b/test/data/issue-1719-ref-object-reference.yaml
@@ -1,4 +1,4 @@
-openapi: 3.0.0
+openapi: 3.0.4
 servers:
   - description: "mock definition for swagger-client issue #1719"
     url: https://test.com/v1
@@ -7,7 +7,7 @@ info:
   title: Test Defect
   description: >-
     A client side JS error occured when the throwError endpoint was expanded in
-    the UI Docs panel. This error was specifically visible when a $ref is seen 
+    the UI Docs panel. This error was specifically visible when a $ref is seen
     by the subtree resolver after an allOf or after an anyOf. E.g. the subtree
     resolver was treating the $ref as a reference instead as an object.
 paths:
@@ -38,7 +38,7 @@ components:
     2_RefWithAllOf:
       allOf:
         - $ref: '#/components/schemas/3_InnerAllOfRef'
-    
+
     3_InnerAllOfRef:
       type: object
       properties:

diff --git a/test/data/parameter-examples-with-refs.yaml b/test/data/parameter-examples-with-refs.yaml
@@ -1,4 +1,4 @@
-openapi: 3.0.0
+openapi: 3.0.4
 info:
   title: These $refs in parameter examples should not be resolved
   version: 1.0.0
@@ -71,4 +71,4 @@ paths:
 components:
   schemas:
     Foo:
-      type: string
+      type: string
diff --git a/test/data/relative-server.openapi.yaml b/test/data/relative-server.openapi.yaml
@@ -1,4 +1,4 @@
-openapi: "3.0.0"
+openapi: "3.0.4"
 servers:
 - url: "/v1/"
 paths:

diff --git a/test/data/sample-multipart-oas3.js b/test/data/sample-multipart-oas3.js
@@ -1,5 +1,5 @@
 export default {
-  openapi: '3.0.0',
+  openapi: '3.0.4',
   servers: [
     {
       url: '/api/v1',

diff --git a/test/data/sample-query-parameter-json.yaml b/test/data/sample-query-parameter-json.yaml
@@ -1,4 +1,4 @@
-openapi: 3.0.1
+openapi: 3.0.4
 info:
   version: "0.0.1"
   title: Test Defect

diff --git a/test/execute/server-variable-encoder.js b/test/execute/server-variable-encoder.js
@@ -3,7 +3,7 @@ import { execute, buildRequest } from '../../src/execute/index.js';
 describe('execute/serverVariableEncoder', () => {
   test('should encode when encoder provided', () => {
     const spec = {
-      openapi: '3.0.3',
+      openapi: '3.0.4',
       servers: [
         {
           url: '{server}/v1',
@@ -44,7 +44,7 @@ describe('execute/serverVariableEncoder', () => {
 
   test('should not encode when encoder not provided', () => {
     const spec = {
-      openapi: '3.0.3',
+      openapi: '3.0.4',
       servers: [
         {
           url: '{server}/v1',
@@ -86,7 +86,7 @@ describe('execute/serverVariableEncoder', () => {
 describe('buildRequest/serverVariableEncoder', () => {
   test('should encode when encoder provided', () => {
     const spec = {
-      openapi: '3.0.3',
+      openapi: '3.0.4',
       servers: [
         {
           url: '{server}/v1',
@@ -124,7 +124,7 @@ describe('buildRequest/serverVariableEncoder', () => {
 
   test('should not encode when encoder not provided', () => {
     const spec = {
-      openapi: '3.0.3',
+      openapi: '3.0.4',
       servers: [
         {
           url: '{server}/v1',

diff --git a/test/helpers/openapi-predicates.js b/test/helpers/openapi-predicates.js
@@ -9,11 +9,13 @@ import {
 describe('helpers', () => {
   describe('OpenAPI predicates', () => {
     describe('isOpenAPI30', () => {
-      test('should detect OpenAPI 3.0.x versions', () => {
+      test('should detect OpenAPI 3.0.x versions in forward compatible way', () => {
         expect(isOpenAPI30({ openapi: '3.0.0' })).toBe(true);
         expect(isOpenAPI30({ openapi: '3.0.1' })).toBe(true);
         expect(isOpenAPI30({ openapi: '3.0.2' })).toBe(true);
         expect(isOpenAPI30({ openapi: '3.0.3' })).toBe(true);
+        expect(isOpenAPI30({ openapi: '3.0.4' })).toBe(true);
+        expect(isOpenAPI30({ openapi: '3.0.25' })).toBe(true);
       });
 
       test('should reject other OpenAPI versions', () => {
@@ -29,9 +31,10 @@ describe('helpers', () => {
     });
 
     describe('isOpenAPI31', () => {
-      test('should detect OpenAPI 3.1.x versions', () => {
+      test('should detect OpenAPI 3.1.x versions in forward compatible way', () => {
         expect(isOpenAPI31({ openapi: '3.1.0' })).toBe(true);
         expect(isOpenAPI31({ openapi: '3.1.1' })).toBe(true);
+        expect(isOpenAPI31({ openapi: '3.1.25' })).toBe(true);
       });
 
       test('should reject other OpenAPI versions', () => {
@@ -52,6 +55,7 @@ describe('helpers', () => {
         expect(isOpenAPI3({ openapi: '3.0.1' })).toBe(true);
         expect(isOpenAPI3({ openapi: '3.0.2' })).toBe(true);
         expect(isOpenAPI3({ openapi: '3.0.3' })).toBe(true);
+        expect(isOpenAPI3({ openapi: '3.0.4' })).toBe(true);
         expect(isOpenAPI3({ openapi: '3.1.0' })).toBe(true);
         expect(isOpenAPI3({ openapi: '3.1.1' })).toBe(true);
       });

diff --git a/test/http/http-multipart.js b/test/http/http-multipart.js
@@ -338,7 +338,7 @@ describe('buildRequest - openapi 3.0', () => {
   describe('respect Encoding Object', () => {
     test('Should be set to object in the style of deepObject', () => {
       const spec = {
-        openapi: '3.0.0',
+        openapi: '3.0.4',
         servers: [
           {
             url: 'http://petstore.swagger.io/v2',

diff --git a/test/index.js b/test/index.js
@@ -748,7 +748,7 @@ describe('constructor', () => {
 
   describe('skipNormalization', () => {
     const spec = {
-      openapi: '3.0.0',
+      openapi: '3.0.4',
       info: {
         title: 'Cloudpotato - Medwork',
         description: 'The Cloudpotato API',

diff --git a/test/oas3/data/petstore-oas3.yaml b/test/oas3/data/petstore-oas3.yaml
@@ -1,5 +1,5 @@
 ---
-openapi: 3.0.0
+openapi: 3.0.4
 servers:
 - url: http://petstore.swagger.io/v2
 info: