feat(oas): support info extensions (#251)

stoplightio · Aug 28, 2023 · 26ac072 · 26ac072
1 parent f131406
commit 26ac072
Show file tree

Hide file tree

Showing 16 changed files with 75 additions and 54 deletions.
diff --git a/src/oas/__tests__/__snapshots__/service.test.ts.snap b/src/oas/__tests__/__snapshots__/service.test.ts.snap
@@ -19,6 +19,9 @@ Object {
     "url": "http://swagger.io",
   },
   "id": "abc",
+  "infoExtensions": Object {
+    "x-special-info": 27,
+  },
   "license": Object {
     "name": "Apache 2.0",
     "url": "http://www.apache.org/licenses/LICENSE-2.0.html",
@@ -121,6 +124,9 @@ Object {
     "url": "http://swagger.io",
   },
   "id": "abc",
+  "infoExtensions": Object {
+    "x-special-info": 27,
+  },
   "license": Object {
     "name": "Apache 2.0",
     "url": "http://www.apache.org/licenses/LICENSE-2.0.html",

diff --git a/src/oas/__tests__/fixtures/oas2-kitchen-sink.json b/src/oas/__tests__/fixtures/oas2-kitchen-sink.json
@@ -14,7 +14,8 @@
     "license": {
       "name": "Apache 2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
-    }
+    },
+    "x-special-info": 27
   },
   "host": "petstore.swagger.io",
   "basePath": "/v2",
@@ -46,27 +47,16 @@
       }
     }
   ],
-  "schemes": [
-    "https",
-    "http"
-  ],
+  "schemes": ["https", "http"],
   "paths": {
     "/pets": {
       "post": {
-        "tags": [
-          "pet"
-        ],
+        "tags": ["pet"],
         "summary": "Add a new pet to the store",
         "description": "",
         "operationId": "addPet",
-        "consumes": [
-          "application/json",
-          "application/xml"
-        ],
-        "produces": [
-          "application/xml",
-          "application/json"
-        ],
+        "consumes": ["application/json", "application/xml"],
+        "produces": ["application/xml", "application/json"],
         "parameters": [
           {
             "in": "body",
@@ -85,10 +75,7 @@
         },
         "security": [
           {
-            "petstore_auth": [
-              "write:pets",
-              "read:pets"
-            ]
+            "petstore_auth": ["write:pets", "read:pets"]
           }
         ],
         "x-test": true,
@@ -169,20 +156,12 @@
         }
       ],
       "put": {
-        "tags": [
-          "pet"
-        ],
+        "tags": ["pet"],
         "summary": "Update an existing pet",
         "description": "",
         "operationId": "updatePet",
-        "consumes": [
-          "application/json",
-          "application/xml"
-        ],
-        "produces": [
-          "application/xml",
-          "application/json"
-        ],
+        "consumes": ["application/json", "application/xml"],
+        "produces": ["application/xml", "application/json"],
         "parameters": [
           {
             "in": "body",
@@ -207,10 +186,7 @@
         },
         "security": [
           {
-            "petstore_auth": [
-              "write:pets",
-              "read:pets"
-            ]
+            "petstore_auth": ["write:pets", "read:pets"]
           }
         ]
       }
@@ -266,17 +242,10 @@
         "status": {
           "type": "string",
           "description": "pet status in the store",
-          "enum": [
-            "available",
-            "pending",
-            "sold"
-          ]
+          "enum": ["available", "pending", "sold"]
         }
       },
-      "required": [
-        "name",
-        "photoUrls"
-      ]
+      "required": ["name", "photoUrls"]
     },
     "Error": {
       "type": "object",
@@ -288,9 +257,7 @@
           "type": "string"
         }
       },
-      "required": [
-        "code"
-      ]
+      "required": ["code"]
     },
     "Category": {
       "type": "object",
@@ -299,9 +266,7 @@
           "type": "string"
         }
       },
-      "required": [
-        "name"
-      ],
+      "required": ["name"],
       "title": "Category"
     }
   },

diff --git a/src/oas/__tests__/fixtures/oas3-kitchen-sink.json b/src/oas/__tests__/fixtures/oas3-kitchen-sink.json
@@ -14,7 +14,8 @@
     "license": {
       "name": "Apache 2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
-    }
+    },
+    "x-special-info": 27
   },
   "tags": [
     {

diff --git a/src/oas/service.ts b/src/oas/service.ts
@@ -49,6 +49,7 @@ export const transformOasService: TranslateFunction<DeepPartial<OpenAPIObject> |
 
       ...toExternalDocs(document.externalDocs),
       extensions: getExtensions(document),
+      infoExtensions: getExtensions(document.info),
     };
 
     if (isPlainObject(document.info) && hasXLogo(document.info)) {

diff --git a/src/oas2/__tests__/__fixtures__/id/bundled.ts b/src/oas2/__tests__/__fixtures__/id/bundled.ts
@@ -21,6 +21,7 @@ export default {
       id: 'service_abc',
     },
   },
+  infoExtensions: {},
   components: {
     callbacks: [],
     cookie: [],

diff --git a/src/oas2/__tests__/bundle.test.ts b/src/oas2/__tests__/bundle.test.ts
@@ -76,6 +76,7 @@ describe('bundleOas2Service', () => {
           id: 'abc',
         },
       },
+      infoExtensions: {},
       operations: [
         {
           id: 'http_operation-abc-patch-/users/{}',
@@ -241,6 +242,7 @@ describe('bundleOas2Service', () => {
           hello: 'world',
         },
       },
+      infoExtensions: {},
       operations: [
         {
           id: 'http_operation-abc-patch-/users/{}',

diff --git a/src/oas2/__tests__/service.test.ts b/src/oas2/__tests__/service.test.ts
@@ -27,6 +27,7 @@ describe('oas2 service', () => {
           id: 'def',
         },
       },
+      infoExtensions: {},
     });
   });
 
@@ -55,6 +56,7 @@ describe('oas2 service', () => {
           id: 'abc',
         },
       },
+      infoExtensions: {},
       servers: [
         {
           id: expect.any(String),
@@ -86,6 +88,7 @@ describe('oas2 service', () => {
           id: 'abc',
         },
       },
+      infoExtensions: {},
     });
   });
 
@@ -135,6 +138,7 @@ describe('oas2 service', () => {
           id: 'abc',
         },
       },
+      infoExtensions: {},
     });
   });
   describe('x-logo support', () => {
@@ -168,6 +172,14 @@ describe('oas2 service', () => {
             id: 'abc',
           },
         },
+        infoExtensions: {
+          'x-logo': {
+            altText: 'altText',
+            href: 'https://stoplight.io',
+            url: 'http://petstore.swagger.io/v2',
+            backgroundColor: '#FFF000',
+          },
+        },
       });
     });
     it('should provide default values for href and altText', () => {
@@ -199,6 +211,9 @@ describe('oas2 service', () => {
             id: 'abc',
           },
         },
+        infoExtensions: {
+          'x-logo': {},
+        },
       });
     });
   });

diff --git a/src/oas3/__tests__/__fixtures__/examples/bundled.ts b/src/oas3/__tests__/__fixtures__/examples/bundled.ts
@@ -98,4 +98,5 @@ export default {
       id: 'service_abc',
     },
   },
+  infoExtensions: {},
 };
diff --git a/src/oas3/__tests__/__fixtures__/examples/legacy.ts b/src/oas3/__tests__/__fixtures__/examples/legacy.ts
@@ -15,6 +15,7 @@ export default [
         id: 'service_abc',
       },
     },
+    infoExtensions: {},
   },
   {
     id: 'http_operation-service_abc-post-/users/{}',

diff --git a/src/oas3/__tests__/__fixtures__/id/bundled.ts b/src/oas3/__tests__/__fixtures__/id/bundled.ts
@@ -396,4 +396,5 @@ export default {
       id: 'service_abc',
     },
   },
+  infoExtensions: {},
 };
diff --git a/src/oas3/__tests__/__fixtures__/id/legacy.ts b/src/oas3/__tests__/__fixtures__/id/legacy.ts
@@ -48,6 +48,7 @@ export default [
         id: 'service_abc',
       },
     },
+    infoExtensions: {},
   },
 
   /**

diff --git a/src/oas3/__tests__/__fixtures__/shared-components/bundled.ts b/src/oas3/__tests__/__fixtures__/shared-components/bundled.ts
@@ -227,4 +227,5 @@ export default {
       id: 'service_abc',
     },
   },
+  infoExtensions: {},
 };
diff --git a/src/oas3/__tests__/__fixtures__/shared-components/legacy.ts b/src/oas3/__tests__/__fixtures__/shared-components/legacy.ts
@@ -18,6 +18,7 @@ export default [
         id: 'service_abc',
       },
     },
+    infoExtensions: {},
   },
 
   /**

diff --git a/src/oas3/__tests__/bundle.test.ts b/src/oas3/__tests__/bundle.test.ts
@@ -166,6 +166,7 @@ describe('bundleOas3Service', () => {
           id: 'service_id',
         },
       },
+      infoExtensions: {},
     });
   });
 
@@ -402,6 +403,7 @@ describe('bundleOas3Service', () => {
       operations: [],
       version: '',
       extensions: {},
+      infoExtensions: {},
     });
   });
 
@@ -462,6 +464,7 @@ describe('bundleOas3Service', () => {
       operations: [],
       version: '',
       extensions: {},
+      infoExtensions: {},
       components: {
         callbacks: [],
         cookie: [],
@@ -599,6 +602,7 @@ describe('bundleOas3Service', () => {
       name: 'no-title',
       version: '',
       extensions: {},
+      infoExtensions: {},
       components: {
         callbacks: [],
         cookie: [],
@@ -728,6 +732,7 @@ describe('bundleOas3Service', () => {
       name: 'no-title',
       version: '',
       extensions: {},
+      infoExtensions: {},
       components: {
         callbacks: [],
         cookie: [],
@@ -834,6 +839,7 @@ describe('bundleOas3Service', () => {
           hello: 'world',
         },
       },
+      infoExtensions: {},
       operations: [
         {
           id: 'http_operation-abc-patch-/users/{}',