Use consistent name format

elastic · Sep 11, 2024 · ad70d21 · ad70d21
1 parent a596161
commit ad70d21
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 17 deletions.
diff --git a/packages/core/http/core-http-router-server-internal/src/router.test.ts b/packages/core/http/core-http-router-server-internal/src/router.test.ts
@@ -49,7 +49,7 @@ describe('Router', () => {
           validate: { body: validation, query: validation, params: validation },
           options: {
             deprecated: true,
-            x_discontinued: 'post test x_discontinued',
+            'x-discontinued': 'post test x-discontinued',
             summary: 'post test summary',
             description: 'post test description',
           },
@@ -67,7 +67,7 @@ describe('Router', () => {
         isVersioned: false,
         options: {
           deprecated: true,
-          x_discontinued: 'post test x_discontinued',
+          'x-discontinued': 'post test x-discontinued',
           summary: 'post test summary',
           description: 'post test description',
         },

diff --git a/.../http/core-http-router-server-internal/src/versioned_router/core_versioned_router.test.ts b/.../http/core-http-router-server-internal/src/versioned_router/core_versioned_router.test.ts
@@ -37,7 +37,7 @@ describe('Versioned router', () => {
       path: '/test/{id}',
       access: 'internal',
       deprecated: true,
-      x_discontinued: 'x.y.z',
+      'x-discontinued': 'x.y.z',
     });
     versionedRouter.post({
       path: '/test',
@@ -54,7 +54,7 @@ describe('Versioned router', () => {
           "options": Object {
             "access": "internal",
             "deprecated": true,
-            "x_discontinued": "x.y.z",
+            "'x-discontinued'": "x.y.z",
           },
           "path": "/test/{id}",
         },

diff --git a/packages/core/http/core-http-server/src/router/route.ts b/packages/core/http/core-http-server/src/router/route.ts
@@ -214,7 +214,7 @@ export interface RouteConfigOptions<Method extends RouteMethod> {
    *
    * @remarks This will be surfaced in OAS documentation.
    */
-  x_discontinued?: string;
+  'x-discontinued'?: string;
 }
 
 /**

diff --git a/packages/core/http/core-http-server/src/versioning/types.ts b/packages/core/http/core-http-server/src/versioning/types.ts
@@ -98,7 +98,7 @@ export type VersionedRouteConfig<Method extends RouteMethod> = Omit<
    *
    * @default undefined
    */
-  x_discontinued?: string;
+  'x-discontinued'?: string;
 };
 
 /**

diff --git a/packages/kbn-router-to-openapispec/src/__snapshots__/generate_oas.test.ts.snap b/packages/kbn-router-to-openapispec/src/__snapshots__/generate_oas.test.ts.snap
diff --git a/packages/kbn-router-to-openapispec/src/generate_oas.test.fixture.ts b/packages/kbn-router-to-openapispec/src/generate_oas.test.fixture.ts
@@ -34,7 +34,7 @@ export const sharedOas = {
     '/bar': {
       get: {
         deprecated: true,
-        'x-discontinued': 'route discontinued version or date',
+        // 'x-discontinued': 'route x-discontinued version or date',
         operationId: '%2Fbar#0',
         parameters: [
           {

diff --git a/packages/kbn-router-to-openapispec/src/process_router.ts b/packages/kbn-router-to-openapispec/src/process_router.ts
@@ -66,7 +66,9 @@ export const processRouter = (
         tags: route.options.tags ? extractTags(route.options.tags) : [],
         ...(route.options.description ? { description: route.options.description } : {}),
         ...(route.options.deprecated ? { deprecated: route.options.deprecated } : {}),
-        ...(route.options.x_discontinued ? { 'x-discontinued': route.options.x_discontinued } : {}),
+        ...(route.options['x-discontinued']
+          ? { 'x-discontinued': route.options['x-discontinued'] }
+          : {}),
         requestBody: !!validationSchemas?.body
           ? {
               content: {