@speclynx/apidom-ns-openapi-3-1 4.0.2 → 4.0.3

package/src/refractor/inspect.mjs

@@ -0,0 +1,171 @@
+import { resolveSpecification } from '@speclynx/apidom-core';
+import { isPlainObject } from 'ramda-adjunct';
+
+/**
+ * OpenAPI 3.1 specification elements.
+ */
+import CallbackElement from "../elements/Callback.mjs";
+import ComponentsElement from "../elements/Components.mjs";
+import ContactElement from "../elements/Contact.mjs";
+import DiscriminatorElement from "../elements/Discriminator.mjs";
+import EncodingElement from "../elements/Encoding.mjs";
+import ExampleElement from "../elements/Example.mjs";
+import ExternalDocumentationElement from "../elements/ExternalDocumentation.mjs";
+import HeaderElement from "../elements/Header.mjs";
+import InfoElement from "../elements/Info.mjs";
+import JsonSchemaDialectElement from "../elements/JsonSchemaDialect.mjs";
+import LicenseElement from "../elements/License.mjs";
+import LinkElement from "../elements/Link.mjs";
+import MediaTypeElement from "../elements/MediaType.mjs";
+import OAuthFlowElement from "../elements/OAuthFlow.mjs";
+import OAuthFlowsElement from "../elements/OAuthFlows.mjs";
+import OpenapiElement from "../elements/Openapi.mjs";
+import OpenApi3_1Element from "../elements/OpenApi3-1.mjs";
+import OperationElement from "../elements/Operation.mjs";
+import ParameterElement from "../elements/Parameter.mjs";
+import PathItemElement from "../elements/PathItem.mjs";
+import PathsElement from "../elements/Paths.mjs";
+import ReferenceElement from "../elements/Reference.mjs";
+import RequestBodyElement from "../elements/RequestBody.mjs";
+import ResponseElement from "../elements/Response.mjs";
+import ResponsesElement from "../elements/Responses.mjs";
+import SchemaElement from "../elements/Schema.mjs";
+import SecurityRequirementElement from "../elements/SecurityRequirement.mjs";
+import SecuritySchemeElement from "../elements/SecurityScheme.mjs";
+import ServerElement from "../elements/Server.mjs";
+import ServerVariableElement from "../elements/ServerVariable.mjs";
+import TagElement from "../elements/Tag.mjs";
+import XmlElement from "../elements/Xml.mjs";
+import specification from "./specification.mjs";
+/**
+ * @public
+ */
+// Resolve specification to dereference $ref pointers
+const resolvedSpec = resolveSpecification(specification);
+
+// Extract fixed fields as list of { name, alias?, $visitor }
+const getFixedFields = fixedFieldsSpec => {
+  return Object.entries(fixedFieldsSpec).map(([name, fieldSpec]) => {
+    if (isPlainObject(fieldSpec)) {
+      return {
+        name,
+        ...fieldSpec
+      };
+    }
+    return {
+      name,
+      $visitor: fieldSpec
+    };
+  });
+};
+
+// OpenAPI 3.1 specification elements
+Object.defineProperty(OpenApi3_1Element, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.OpenApi.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(InfoElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Info.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ContactElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Contact.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(LicenseElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.License.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ServerElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Server.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ServerVariableElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.ServerVariable.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ComponentsElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Components.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(PathItemElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.PathItem.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(OperationElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Operation.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ExternalDocumentationElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.ExternalDocumentation.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ParameterElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Parameter.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(RequestBodyElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.RequestBody.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(MediaTypeElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.MediaType.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(EncodingElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Encoding.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ResponsesElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Responses.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ResponseElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Response.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ExampleElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Example.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(LinkElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Link.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(HeaderElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Header.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(TagElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Tag.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ReferenceElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Reference.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(SchemaElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Schema.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(DiscriminatorElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Discriminator.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(XmlElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.XML.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(SecuritySchemeElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.SecurityScheme.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(OAuthFlowsElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.OAuthFlows.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(OAuthFlowElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.OAuthFlow.fixedFields),
+  enumerable: true
+});
+export { CallbackElement, ComponentsElement, ContactElement, DiscriminatorElement, EncodingElement, ExampleElement, ExternalDocumentationElement, HeaderElement, InfoElement, JsonSchemaDialectElement, LicenseElement, LinkElement, MediaTypeElement, OAuthFlowElement, OAuthFlowsElement, OpenapiElement, OpenApi3_1Element, OperationElement, ParameterElement, PathItemElement, PathsElement, ReferenceElement, RequestBodyElement, ResponseElement, ResponsesElement, SchemaElement, SecurityRequirementElement, SecuritySchemeElement, ServerElement, ServerVariableElement, TagElement, XmlElement };

package/src/refractor/inspect.ts

@@ -0,0 +1,241 @@
+import { resolveSpecification, type ResolvedSpecification } from '@speclynx/apidom-core';
+import { isPlainObject } from 'ramda-adjunct';
+
+/**
+ * OpenAPI 3.1 specification elements.
+ */
+import CallbackElement from '../elements/Callback.ts';
+import ComponentsElement from '../elements/Components.ts';
+import ContactElement from '../elements/Contact.ts';
+import DiscriminatorElement from '../elements/Discriminator.ts';
+import EncodingElement from '../elements/Encoding.ts';
+import ExampleElement from '../elements/Example.ts';
+import ExternalDocumentationElement from '../elements/ExternalDocumentation.ts';
+import HeaderElement from '../elements/Header.ts';
+import InfoElement from '../elements/Info.ts';
+import JsonSchemaDialectElement from '../elements/JsonSchemaDialect.ts';
+import LicenseElement from '../elements/License.ts';
+import LinkElement from '../elements/Link.ts';
+import MediaTypeElement from '../elements/MediaType.ts';
+import OAuthFlowElement from '../elements/OAuthFlow.ts';
+import OAuthFlowsElement from '../elements/OAuthFlows.ts';
+import OpenapiElement from '../elements/Openapi.ts';
+import OpenApi3_1Element from '../elements/OpenApi3-1.ts';
+import OperationElement from '../elements/Operation.ts';
+import ParameterElement from '../elements/Parameter.ts';
+import PathItemElement from '../elements/PathItem.ts';
+import PathsElement from '../elements/Paths.ts';
+import ReferenceElement from '../elements/Reference.ts';
+import RequestBodyElement from '../elements/RequestBody.ts';
+import ResponseElement from '../elements/Response.ts';
+import ResponsesElement from '../elements/Responses.ts';
+import SchemaElement from '../elements/Schema.ts';
+import SecurityRequirementElement from '../elements/SecurityRequirement.ts';
+import SecuritySchemeElement from '../elements/SecurityScheme.ts';
+import ServerElement from '../elements/Server.ts';
+import ServerVariableElement from '../elements/ServerVariable.ts';
+import TagElement from '../elements/Tag.ts';
+import XmlElement from '../elements/Xml.ts';
+import specification from './specification.ts';
+
+/**
+ * @public
+ */
+export interface FixedField {
+  name: string;
+  alias?: string;
+  $visitor: unknown;
+}
+
+interface ResolvedSpec extends ResolvedSpecification {
+  visitors: {
+    document: {
+      objects: Record<string, { fixedFields: Record<string, unknown> }>;
+    };
+  };
+}
+
+// Resolve specification to dereference $ref pointers
+const resolvedSpec = resolveSpecification<ResolvedSpec>(specification);
+
+// Extract fixed fields as list of { name, alias?, $visitor }
+const getFixedFields = (fixedFieldsSpec: Record<string, unknown>): FixedField[] => {
+  return Object.entries(fixedFieldsSpec).map(([name, fieldSpec]) => {
+    if (isPlainObject(fieldSpec)) {
+      return { name, ...fieldSpec } as FixedField;
+    }
+    return { name, $visitor: fieldSpec };
+  });
+};
+
+// OpenAPI 3.1 specification elements
+Object.defineProperty(OpenApi3_1Element, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.OpenApi.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(InfoElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Info.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(ContactElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Contact.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(LicenseElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.License.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(ServerElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Server.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(ServerVariableElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.ServerVariable.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(ComponentsElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Components.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(PathItemElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.PathItem.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(OperationElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Operation.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(ExternalDocumentationElement, 'fixedFields', {
+  get: () =>
+    getFixedFields(resolvedSpec.visitors.document.objects.ExternalDocumentation.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(ParameterElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Parameter.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(RequestBodyElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.RequestBody.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(MediaTypeElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.MediaType.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(EncodingElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Encoding.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(ResponsesElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Responses.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(ResponseElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Response.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(ExampleElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Example.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(LinkElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Link.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(HeaderElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Header.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(TagElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Tag.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(ReferenceElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Reference.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(SchemaElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Schema.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(DiscriminatorElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Discriminator.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(XmlElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.XML.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(SecuritySchemeElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.SecurityScheme.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(OAuthFlowsElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.OAuthFlows.fixedFields),
+  enumerable: true,
+});
+
+Object.defineProperty(OAuthFlowElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.OAuthFlow.fixedFields),
+  enumerable: true,
+});
+
+export {
+  CallbackElement,
+  ComponentsElement,
+  ContactElement,
+  DiscriminatorElement,
+  EncodingElement,
+  ExampleElement,
+  ExternalDocumentationElement,
+  HeaderElement,
+  InfoElement,
+  JsonSchemaDialectElement,
+  LicenseElement,
+  LinkElement,
+  MediaTypeElement,
+  OAuthFlowElement,
+  OAuthFlowsElement,
+  OpenapiElement,
+  OpenApi3_1Element,
+  OperationElement,
+  ParameterElement,
+  PathItemElement,
+  PathsElement,
+  ReferenceElement,
+  RequestBodyElement,
+  ResponseElement,
+  ResponsesElement,
+  SchemaElement,
+  SecurityRequirementElement,
+  SecuritySchemeElement,
+  ServerElement,
+  ServerVariableElement,
+  TagElement,
+  XmlElement,
+};

package/src/refractor/plugins/normalize-header-examples/NormalizeStorage.cjs

@@ -0,0 +1,38 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+class NormalizeStorage {
+  internalStore;
+  constructor(storageElement, storageField, storageSubField) {
+    this.storageElement = storageElement;
+    this.storageField = storageField;
+    this.storageSubField = storageSubField;
+  }
+  get store() {
+    if (!this.internalStore) {
+      let rootStore = this.storageElement.get(this.storageField);
+      if (!(0, _apidomDatamodel.isObjectElement)(rootStore)) {
+        rootStore = new _apidomDatamodel.ObjectElement();
+        this.storageElement.set(this.storageField, rootStore);
+      }
+      let store = rootStore.get(this.storageSubField);
+      if (!(0, _apidomDatamodel.isArrayElement)(store)) {
+        store = new _apidomDatamodel.ArrayElement();
+        rootStore.set(this.storageSubField, store);
+      }
+      this.internalStore = store;
+    }
+    return this.internalStore;
+  }
+  append(pointer) {
+    if (!this.includes(pointer)) {
+      this.store.push(pointer);
+    }
+  }
+  includes(pointer) {
+    return this.store.includes(pointer);
+  }
+}
+var _default = exports.default = NormalizeStorage;

package/src/refractor/plugins/normalize-header-examples/NormalizeStorage.mjs

@@ -0,0 +1,34 @@
+import { ArrayElement, ObjectElement, isObjectElement, isArrayElement } from '@speclynx/apidom-datamodel';
+class NormalizeStorage {
+  internalStore;
+  constructor(storageElement, storageField, storageSubField) {
+    this.storageElement = storageElement;
+    this.storageField = storageField;
+    this.storageSubField = storageSubField;
+  }
+  get store() {
+    if (!this.internalStore) {
+      let rootStore = this.storageElement.get(this.storageField);
+      if (!isObjectElement(rootStore)) {
+        rootStore = new ObjectElement();
+        this.storageElement.set(this.storageField, rootStore);
+      }
+      let store = rootStore.get(this.storageSubField);
+      if (!isArrayElement(store)) {
+        store = new ArrayElement();
+        rootStore.set(this.storageSubField, store);
+      }
+      this.internalStore = store;
+    }
+    return this.internalStore;
+  }
+  append(pointer) {
+    if (!this.includes(pointer)) {
+      this.store.push(pointer);
+    }
+  }
+  includes(pointer) {
+    return this.store.includes(pointer);
+  }
+}
+export default NormalizeStorage;

package/src/refractor/plugins/normalize-header-examples/NormalizeStorage.ts

@@ -0,0 +1,53 @@
+import {
+  ArrayElement,
+  ObjectElement,
+  isObjectElement,
+  isArrayElement,
+} from '@speclynx/apidom-datamodel';
+
+import OpenApi3_1Element from '../../../elements/OpenApi3-1.ts';
+
+type JSONPointer = string;
+
+class NormalizeStorage {
+  private internalStore!: ArrayElement;
+
+  constructor(
+    protected storageElement: OpenApi3_1Element | undefined,
+    protected storageField: string,
+    protected storageSubField: string,
+  ) {}
+
+  protected get store() {
+    if (!this.internalStore) {
+      let rootStore: ObjectElement = this.storageElement!.get(this.storageField) as ObjectElement;
+
+      if (!isObjectElement(rootStore)) {
+        rootStore = new ObjectElement();
+        this.storageElement!.set(this.storageField, rootStore);
+      }
+
+      let store: ArrayElement = rootStore.get(this.storageSubField) as ArrayElement;
+      if (!isArrayElement(store)) {
+        store = new ArrayElement();
+        rootStore.set(this.storageSubField, store);
+      }
+
+      this.internalStore = store;
+    }
+
+    return this.internalStore;
+  }
+
+  public append(pointer: JSONPointer) {
+    if (!this.includes(pointer)) {
+      this.store.push(pointer);
+    }
+  }
+
+  public includes(pointer: JSONPointer) {
+    return this.store.includes(pointer);
+  }
+}
+
+export default NormalizeStorage;

package/src/refractor/plugins/normalize-header-examples/index.cjs

@@ -0,0 +1,109 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _NormalizeStorage = _interopRequireDefault(require("./NormalizeStorage.cjs"));
+/**
+ * Override of Schema.example and Schema.examples field inside the Header Objects.
+ *
+ * Header Object has two fixed fields:
+ *  - `example` of type `Any`
+ *  - `examples` of type `Map[string, Example Object | Reference Object]`
+ *
+ * OpenAPI 3.1 specification excerpt that defines the override behavior:
+ *
+ * The example value SHALL override the example provided by the schema.
+ * Furthermore, if referencing a schema that contains an example, the examples value SHALL override the example provided by the schema.
+ *
+ * NOTE: this plugin is idempotent
+ * @public
+ */
+
+/**
+ * @public
+ */
+const plugin = ({
+  storageField = 'x-normalized'
+} = {}) => toolbox => {
+  const {
+    predicates,
+    ancestorLineageToJSONPointer
+  } = toolbox;
+  let storage;
+  return {
+    visitor: {
+      OpenApi3_1Element: {
+        enter(path) {
+          const element = path.node;
+          storage = new _NormalizeStorage.default(element, storageField, 'header-examples');
+        },
+        leave() {
+          storage = undefined;
+        }
+      },
+      HeaderElement: {
+        leave(path) {
+          const headerElement = path.node;
+          const ancestors = path.getAncestorNodes().reverse(); // root to parent order
+
+          // skip visiting this Header Object
+          if (ancestors.some(predicates.isComponentsElement)) {
+            return;
+          }
+
+          // no Header.schema field present
+          if (typeof headerElement.schema === 'undefined' || !predicates.isSchemaElement(headerElement.schema)) {
+            return;
+          }
+          // Schema contains no example
+          if (typeof headerElement.schema?.example === 'undefined' && typeof headerElement.schema?.examples === 'undefined') {
+            return;
+          }
+          const headerJSONPointer = ancestorLineageToJSONPointer([...ancestors, headerElement]);
+
+          // skip visiting this Header Object if it's already normalized
+          if (storage.includes(headerJSONPointer)) {
+            return;
+          }
+
+          /**
+           * Header.examples and Schema.examples have preferences over the older
+           * and deprected `example` field.
+           */
+          if (typeof headerElement.examples !== 'undefined' && predicates.isObjectElement(headerElement.examples)) {
+            // @ts-ignore
+            const examples = headerElement.examples.map(example => {
+              return _apidomDatamodel.cloneDeep.safe(example.value);
+            });
+            if (typeof headerElement.schema.examples !== 'undefined') {
+              headerElement.schema.set('examples', examples);
+              storage.append(headerJSONPointer);
+            }
+            if (typeof headerElement.schema.example !== 'undefined') {
+              headerElement.schema.set('example', examples[0]);
+              storage.append(headerJSONPointer);
+            }
+            return;
+          }
+
+          /**
+           * Handle deprecated `example` field.
+           */
+          if (typeof headerElement.example !== 'undefined') {
+            if (typeof headerElement.schema.examples !== 'undefined') {
+              headerElement.schema.set('examples', [(0, _apidomDatamodel.cloneDeep)(headerElement.example)]);
+              storage.append(headerJSONPointer);
+            }
+            if (typeof headerElement.schema.example !== 'undefined') {
+              headerElement.schema.set('example', (0, _apidomDatamodel.cloneDeep)(headerElement.example));
+              storage.append(headerJSONPointer);
+            }
+          }
+        }
+      }
+    }
+  };
+};
+var _default = exports.default = plugin;