fix: oas example types and tests

Author: vadyvas

__tests__/bundle/bundle-example-value-with-ref/openapi.yaml

@@ -163,7 +163,7 @@ const Parameter: NodeType = {
     uniqueItems: { type: 'boolean' },
     enum: { type: 'array' },
     multipleOf: { type: 'number' },
-    'x-example': {}, // any
+    'x-example': 'XExample',
     'x-examples': 'ExamplesMap',
   },
   required(value) {
@@ -427,7 +427,9 @@ const SecurityRequirement: NodeType = {
   additionalProperties: { type: 'array', items: { type: 'string' } },
 };
 
-const Example: NodeType = {
+const Example = { isExample: true, properties: {} };
+
+const XExample: NodeType = {
   properties: {
     value: { isExample: true, resolvable: false },
     summary: { type: 'string' },
@@ -475,4 +477,5 @@ export const Oas2Types = {
   XCodeSampleList: listOf('XCodeSample'),
   XServerList: listOf('XServer'),
   XServer,
+  XExample,
 } as const;

__tests__/bundle/bundle-example-value-with-ref/redocly.yaml

@@ -271,6 +271,16 @@ const DependentRequired: NodeType = {
   additionalProperties: { type: 'array', items: { type: 'string' } },
 };
 
+const Example: NodeType = {
+  properties: {
+    value: { isExample: true, resolvable: false },
+    summary: { type: 'string' },
+    description: { type: 'string' },
+    externalValue: { type: 'string' },
+  },
+  extensionsPrefix: 'x-',
+};
+
 export const Oas3_1Types = {
   ...Oas3Types,
   Info,
@@ -284,4 +294,5 @@ export const Oas3_1Types = {
   SecurityScheme,
   Operation,
   DependentRequired,
+  Example,
 } as const;

__tests__/bundle/bundle-example-value-with-ref/snapshot.txt

@@ -191,12 +191,15 @@ const Discriminator: NodeType = {
 };
 
 const Example: NodeType = {
-  ...Oas3_1Types.Example,
   properties: {
-    ...Oas3_1Types.Example.properties,
+    value: { isExample: true, resolvable: false },
+    summary: { type: 'string' },
+    description: { type: 'string' },
+    externalValue: { type: 'string' },
     dataValue: { isExample: true, resolvable: false },
     serializedValue: { type: 'string' },
   },
+  extensionsPrefix: 'x-',
 };
 
 export const Oas3_2Types = {
@@ -213,4 +216,5 @@ export const Oas3_2Types = {
   MediaType,
   Discriminator,
   Example,
+  ExamplesMap: mapOf('Example'),
 } as const;

packages/core/src/types/oas2.ts

@@ -0,0 +1,32 @@
+openapi: 3.2.0
+info:
+  title: Test API
+  version: 1.0.0
+paths:
+  /test:
+    get:
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    type: integer
+                  name:
+                    type: string
+                  active:
+                    type: boolean
+                example:
+                  $ref: example.json
+              examples:
+                Test:
+                  summary: Example with $ref in value (should NOT resolve)
+                  value:
+                    $ref: example.json
+
+                TestDataValue:
+                  summary: Example with $ref in dataValue (should NOT resolve)
+                  dataValue:
+                    $ref: example.json

packages/core/src/types/oas3_1.ts

@@ -0,0 +1,6 @@
+apis:
+  main:
+    root: openapi.yaml
+
+resolve:
+  doNotResolveExamples: true

packages/core/src/types/oas3_2.ts

@@ -0,0 +1,35 @@
+openapi: 3.2.0
+info:
+  title: Test API
+  version: 1.0.0
+paths:
+  /test:
+    get:
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  id:
+                    type: integer
+                  name:
+                    type: string
+                  active:
+                    type: boolean
+                example:
+                  $ref: example.json
+              examples:
+                Test:
+                  summary: Example with $ref in value (should NOT resolve)
+                  value:
+                    $ref: example.json
+                TestDataValue:
+                  summary: Example with $ref in dataValue (should NOT resolve)
+                  dataValue:
+                    $ref: example.json
+components: {}
+
+bundling openapi.yaml using configuration for api 'main'...
+📦 Created a bundle for openapi.yaml at stdout <test>ms.