feat(openapi-parser): add application and accessCode to Swagger 2.0 upgrade (scalar#6272)

* feat: add application and accessCode to upgrader

* docs(changeset): feat: add application and accessCode to swagger 2 upgrader

* fix: types

Author: amritk

.changeset/stupid-years-sparkle.md

@@ -0,0 +1,5 @@
+---
+'@scalar/openapi-parser': patch
+---
+
+feat: add application and accessCode to swagger 2 upgrader

packages/openapi-parser/src/utils/upgrade-from-two-to-three.test.ts

@@ -418,6 +418,25 @@ describe('upgradeFromTwoToThree', () => {
             'write:pets': 'modify pets in your account',
           },
         },
+        petstore_application: {
+          type: 'oauth2',
+          flow: 'application',
+          tokenUrl: 'https://petstore.swagger.io/oauth/token',
+          scopes: {
+            'read:pets': 'read your pets',
+            'write:pets': 'modify pets in your account',
+          },
+        },
+        petstore_access_code: {
+          type: 'oauth2',
+          flow: 'accessCode',
+          authorizationUrl: 'https://petstore.swagger.io/oauth/authorize',
+          tokenUrl: 'https://petstore.swagger.io/oauth/token',
+          scopes: {
+            'read:pets': 'read your pets',
+            'write:pets': 'modify pets in your account',
+          },
+        },
       },
       paths: {
         '/pets': {
@@ -454,6 +473,31 @@ describe('upgradeFromTwoToThree', () => {
           },
         },
       },
+      petstore_application: {
+        type: 'oauth2',
+        flows: {
+          clientCredentials: {
+            tokenUrl: 'https://petstore.swagger.io/oauth/token',
+            scopes: {
+              'read:pets': 'read your pets',
+              'write:pets': 'modify pets in your account',
+            },
+          },
+        },
+      },
+      petstore_access_code: {
+        type: 'oauth2',
+        flows: {
+          authorizationCode: {
+            authorizationUrl: 'https://petstore.swagger.io/oauth/authorize',
+            tokenUrl: 'https://petstore.swagger.io/oauth/token',
+            scopes: {
+              'read:pets': 'read your pets',
+              'write:pets': 'modify pets in your account',
+            },
+          },
+        },
+      },
     })
 
     expect(result.securityDefinitions).toBeUndefined()

packages/openapi-parser/src/utils/upgrade-from-two-to-three.ts

@@ -3,6 +3,22 @@ import type { UnknownObject } from '@scalar/types/utils'
 
 import { traverse } from './traverse'
 
+/** Update the flow names to OpenAPI 3.1.0 format */
+const upgradeFlow = (flow: string): 'implicit' | 'password' | 'clientCredentials' | 'authorizationCode' => {
+  switch (flow) {
+    case 'application':
+      return 'clientCredentials'
+    case 'accessCode':
+      return 'authorizationCode'
+    case 'implicit':
+      return 'implicit'
+    case 'password':
+      return 'password'
+    default:
+      return flow as never
+  }
+}
+
 /**
  * Upgrade Swagger 2.0 to OpenAPI 3.0
  *
@@ -237,12 +253,14 @@ export function upgradeFromTwoToThree(originalSpecification: UnknownObject) {
             scopes?: Record<string, string>
           }
 
+          // Convert flow values to OpenAPI 3.1.0 format
+
           // Assert that securitySchemes is of type OpenAPIV3.SecuritySchemeObject
           Object.assign((specification.components as OpenAPIV3.ComponentsObject).securitySchemes, {
             [key]: {
               type: 'oauth2',
               flows: {
-                [flow as string]: Object.assign(
+                [upgradeFlow(flow)]: Object.assign(
                   {},
                   authorizationUrl && { authorizationUrl },
                   tokenUrl && { tokenUrl },