fix: add compatibility suite tests for description and summary override via Reference Object for OAS 3.1

package.json

@@ -27,12 +27,12 @@
     "update-lock-file": "update-lock-file @netcracker"
   },
   "dependencies": {
-    "@netcracker/qubership-apihub-api-unifier": "2.2.0",
+    "@netcracker/qubership-apihub-api-unifier": "feature-ref-obj",
     "@netcracker/qubership-apihub-json-crawl": "1.0.4",
     "fast-equals": "4.0.3"
   },
   "devDependencies": {
-    "@netcracker/qubership-apihub-compatibility-suites": "2.1.3",
+    "@netcracker/qubership-apihub-compatibility-suites": "feature-reference-object",
     "@netcracker/qubership-apihub-graphapi": "1.0.8",
     "@netcracker/qubership-apihub-npm-gitflow": "3.1.0",
     "@types/jest": "29.5.11",

test/compatibility-suites/openapi/headers.test.ts

@@ -0,0 +1,9 @@
+import { runRefObjectDescriptionTests } from './templates/reference-object-31.template'
+
+const SUITE_ID = 'headers'
+const PATH_TO_HEADER_DESCRIPTION = ['paths', '/path1', 'get', 'responses', '200', 'headers', 'X-Rate-Limit', 'description']
+const PATH_TO_COMPONENT_DESCRIPTION = ['components', 'headers', 'X-Rate-Limit', 'description']
+
+describe('Reference object. Headers. Description fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, PATH_TO_HEADER_DESCRIPTION, PATH_TO_COMPONENT_DESCRIPTION)
+})

test/compatibility-suites/openapi/operation-parameters.test.ts

@@ -1,6 +1,7 @@
 import { compareFiles, TEST_DEFAULTS_DECLARATION_PATHS } from '../utils'
 import { diffsMatcher } from '../../helper/matchers'
 import { annotation, breaking, deprecated, DiffAction, nonBreaking, unclassified } from '../../../src'
+import { runRefObjectDescriptionTests } from './templates/reference-object-31.template'
 
 const SUITE_ID = 'operation-parameters'
 
@@ -338,7 +339,6 @@ describe('Openapi3 Operation Parameters', () => {
       }),
     ]))
   })
-
 
   // TODO: fixme
   test.skip('Mark primitive parameter as exploded', async () => {
@@ -724,3 +724,8 @@ describe('Openapi3 Operation Parameters', () => {
     })
   })
 })
+
+const PATH_TO_COMPONENT_DESCRIPTION = ['components', 'parameters', 'status', 'description']
+describe('Reference object. Operation parameters. Description fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, [...OPERATION_PARAMETERS_PATH, 0, 'description'], PATH_TO_COMPONENT_DESCRIPTION)
+})

test/compatibility-suites/openapi/parameters-examples.test.ts

@@ -1,17 +1,11 @@
 import { compareFiles } from '../utils'
 import { diffsMatcher } from '../../helper/matchers'
 import { annotation, DiffAction } from '../../../src'
+import { runRefObjectDescriptionTests, runRefObjectSummaryTests } from './templates/reference-object-31.template'
 
 const SUITE_ID = 'parameters-examples'
 
-const PARAMETERS_EXAMPLES_PATH = [
-  'paths',
-  '/path1',
-  'post',
-  'parameters',
-  0,
-  'examples',
-]
+const PARAMETERS_EXAMPLES_PATH = ['paths', '/path1', 'post', 'parameters', 0, 'examples']
 
 describe('Openapi3 Parameters Examples', () => {
 
@@ -168,3 +162,10 @@ describe('Openapi3 Parameters Examples', () => {
     ]))
   })
 })
+
+const PATH_TO_COMPONENTS = ['components', 'examples', 'ex1']
+describe('Reference object. Parameters examples. Description and Summary fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, [...PARAMETERS_EXAMPLES_PATH, 'ex1', 'description'], [...PATH_TO_COMPONENTS, 'description'])
+  runRefObjectSummaryTests(SUITE_ID, [...PARAMETERS_EXAMPLES_PATH, 'ex1', 'summary'], [...PATH_TO_COMPONENTS, 'summary'])
+})
+

test/compatibility-suites/openapi/request-body-examples.test.ts

@@ -1,15 +1,11 @@
 import { compareFiles } from '../utils'
 import { diffsMatcher } from '../../helper/matchers'
 import { annotation, DiffAction } from '../../../src'
+import { runRefObjectDescriptionTests } from './templates/reference-object-31.template'
 
 const SUITE_ID = 'request-body-examples'
 
-const REQUEST_BODY_PATH = [
-  'paths',
-  '/path1',
-  'post',
-  'requestBody',
-]
+const REQUEST_BODY_PATH = ['paths', '/path1', 'post', 'requestBody', 'content', 'application/json', 'examples']
 
 describe('Openapi3 Request Body Examples', () => {
 
@@ -19,7 +15,7 @@ describe('Openapi3 Request Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.add,
-        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1']],
+        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1']],
         type: annotation,
       }),
     ]))
@@ -31,7 +27,7 @@ describe('Openapi3 Request Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.add,
-        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example2']],
+        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'example2']],
         type: annotation,
       }),
     ]))
@@ -43,8 +39,8 @@ describe('Openapi3 Request Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.replace,
-        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'value']],
-        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'value']],
+        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'value']],
+        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'value']],
         type: annotation,
       }),
     ]))
@@ -56,12 +52,12 @@ describe('Openapi3 Request Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.remove,
-        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1']],
+        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1']],
         type: annotation,
       }),
       expect.objectContaining({
         action: DiffAction.add,
-        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example0']],
+        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'example0']],
         type: annotation,
       }),
     ]))
@@ -73,8 +69,8 @@ describe('Openapi3 Request Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.replace,
-        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'externalValue']],
-        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'externalValue']],
+        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'externalValue']],
+        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'externalValue']],
         type: annotation,
       }),
     ]))
@@ -86,7 +82,7 @@ describe('Openapi3 Request Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.remove,
-        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'externalValue']],
+        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'externalValue']],
         type: annotation,
       }),
     ]))
@@ -98,7 +94,7 @@ describe('Openapi3 Request Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.add,
-        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'summary']],
+        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'summary']],
         type: annotation,
       }),
     ]))
@@ -110,8 +106,8 @@ describe('Openapi3 Request Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.replace,
-        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'summary']],
-        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'summary']],
+        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'summary']],
+        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'summary']],
         type: annotation,
       }),
     ]))
@@ -123,7 +119,7 @@ describe('Openapi3 Request Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.remove,
-        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'summary']],
+        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'summary']],
         type: annotation,
       }),
     ]))
@@ -135,7 +131,7 @@ describe('Openapi3 Request Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.add,
-        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'description']],
+        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'description']],
         type: annotation,
       }),
     ]))
@@ -147,8 +143,8 @@ describe('Openapi3 Request Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.replace,
-        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'description']],
-        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'description']],
+        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'description']],
+        afterDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'description']],
         type: annotation,
       }),
     ]))
@@ -160,9 +156,15 @@ describe('Openapi3 Request Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.remove,
-        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'content', 'application/json', 'examples', 'example1', 'description']],
+        beforeDeclarationPaths: [[...REQUEST_BODY_PATH, 'example1', 'description']],
         type: annotation,
       }),
     ]))
   })
 })
+
+const PATH_TO_COMPONENTS_DESCRIPTION = ['components', 'examples', 'ex1', 'description']
+
+describe('Reference object. Request body examples. Description fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, [...REQUEST_BODY_PATH, 'ex1', 'description'], PATH_TO_COMPONENTS_DESCRIPTION)
+})

test/compatibility-suites/openapi/request-body.test.ts

@@ -0,0 +1,9 @@
+import { runRefObjectDescriptionTests } from './templates/reference-object-31.template'
+
+const SUITE_ID = 'request-body'
+const PATH_TO_HEADER_DESCRIPTION = ['paths', '/path1', 'post', 'requestBody', 'description']
+const PATH_TO_COMPONENTS_DESCRIPTION = ['components', 'requestBodies', 'rb1', 'description']
+
+describe('Reference object. Request body. Description fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, PATH_TO_HEADER_DESCRIPTION, PATH_TO_COMPONENTS_DESCRIPTION)
+})

test/compatibility-suites/openapi/response-body-examples.test.ts

@@ -1,10 +1,11 @@
 import { compareFiles } from '../utils'
 import { diffsMatcher } from '../../helper/matchers'
 import { annotation, DiffAction } from '../../../src'
+import { runRefObjectDescriptionTests } from './templates/reference-object-31.template'
 
 const SUITE_ID = 'response-body-examples'
 
-const COMMON_PATH = ['paths', '/path1', 'post', 'responses', '200', 'content', 'application/json']
+const COMMON_PATH = ['paths', '/path1', 'post', 'responses', '200', 'content', 'application/json', 'examples']
 
 describe('Openapi3 Response Body Examples', () => {
 
@@ -14,7 +15,7 @@ describe('Openapi3 Response Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.add,
-        afterDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1']],
+        afterDeclarationPaths: [[...COMMON_PATH, 'example1']],
         type: annotation,
       }),
     ]))
@@ -26,7 +27,7 @@ describe('Openapi3 Response Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.add,
-        afterDeclarationPaths: [[...COMMON_PATH, 'examples', 'example2']],
+        afterDeclarationPaths: [[...COMMON_PATH, 'example2']],
         type: annotation,
       }),
     ]))
@@ -38,8 +39,8 @@ describe('Openapi3 Response Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.replace,
-        beforeDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'value']],
-        afterDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'value']],
+        beforeDeclarationPaths: [[...COMMON_PATH, 'example1', 'value']],
+        afterDeclarationPaths: [[...COMMON_PATH, 'example1', 'value']],
         type: annotation,
       }),
     ]))
@@ -51,12 +52,12 @@ describe('Openapi3 Response Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.remove,
-        beforeDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1']],
+        beforeDeclarationPaths: [[...COMMON_PATH, 'example1']],
         type: annotation,
       }),
       expect.objectContaining({
         action: DiffAction.add,
-        afterDeclarationPaths: [[...COMMON_PATH, 'examples', 'example0']],
+        afterDeclarationPaths: [[...COMMON_PATH, 'example0']],
         type: annotation,
       }),
     ]))
@@ -68,8 +69,8 @@ describe('Openapi3 Response Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.replace,
-        beforeDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'externalValue']],
-        afterDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'externalValue']],
+        beforeDeclarationPaths: [[...COMMON_PATH, 'example1', 'externalValue']],
+        afterDeclarationPaths: [[...COMMON_PATH, 'example1', 'externalValue']],
         type: annotation,
       }),
     ]))
@@ -81,7 +82,7 @@ describe('Openapi3 Response Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.remove,
-        beforeDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'externalValue']],
+        beforeDeclarationPaths: [[...COMMON_PATH, 'example1', 'externalValue']],
         type: annotation,
       }),
     ]))
@@ -93,7 +94,7 @@ describe('Openapi3 Response Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.add,
-        afterDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'summary']],
+        afterDeclarationPaths: [[...COMMON_PATH, 'example1', 'summary']],
         type: annotation,
       }),
     ]))
@@ -105,8 +106,8 @@ describe('Openapi3 Response Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.replace,
-        beforeDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'summary']],
-        afterDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'summary']],
+        beforeDeclarationPaths: [[...COMMON_PATH, 'example1', 'summary']],
+        afterDeclarationPaths: [[...COMMON_PATH, 'example1', 'summary']],
         type: annotation,
       }),
     ]))
@@ -118,7 +119,7 @@ describe('Openapi3 Response Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.remove,
-        beforeDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'summary']],
+        beforeDeclarationPaths: [[...COMMON_PATH, 'example1', 'summary']],
         type: annotation,
       }),
     ]))
@@ -130,7 +131,7 @@ describe('Openapi3 Response Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.add,
-        afterDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'description']],
+        afterDeclarationPaths: [[...COMMON_PATH, 'example1', 'description']],
         type: annotation,
       }),
     ]))
@@ -142,8 +143,8 @@ describe('Openapi3 Response Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.replace,
-        beforeDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'description']],
-        afterDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'description']],
+        beforeDeclarationPaths: [[...COMMON_PATH, 'example1', 'description']],
+        afterDeclarationPaths: [[...COMMON_PATH, 'example1', 'description']],
         type: annotation,
       }),
     ]))
@@ -155,9 +156,14 @@ describe('Openapi3 Response Body Examples', () => {
     expect(result).toEqual(diffsMatcher([
       expect.objectContaining({
         action: DiffAction.remove,
-        beforeDeclarationPaths: [[...COMMON_PATH, 'examples', 'example1', 'description']],
+        beforeDeclarationPaths: [[...COMMON_PATH, 'example1', 'description']],
         type: annotation,
       }),
     ]))
   })
 })
+
+const PATH_TO_COMPONENTS_DESCRIPTION = ['components', 'examples', 'ex1', 'description']
+describe('Reference object. Response body examples. Description fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, [...COMMON_PATH, 'ex1', 'description'], PATH_TO_COMPONENTS_DESCRIPTION)
+})

test/compatibility-suites/openapi/response.test.ts

@@ -1,6 +1,7 @@
 import { compareFiles } from '../utils'
 import { diffsMatcher } from '../../helper/matchers'
 import { annotation, breaking, DiffAction, nonBreaking } from '../../../src'
+import { runRefObjectDescriptionTests } from './templates/reference-object-31.template'
 
 const SUITE_ID = 'response'
 
@@ -252,3 +253,9 @@ describe('Openapi3 Response', () => {
     })
   })
 })
+
+const RESPONSES_POST_PATH = ['paths', '/path1', 'post', 'responses']
+const PATH_TO_COMPONENTS_DESCRIPTION = ['components', 'responses', 'response200', 'description']
+describe('Reference object. Response. Description fields in ref object', () => {
+  runRefObjectDescriptionTests(SUITE_ID, [...RESPONSES_POST_PATH, '200', 'description'], PATH_TO_COMPONENTS_DESCRIPTION)
+})