feat(ns-openapi-2): add support for Parameter Object (#3257)

Refs #3097

packages/apidom-ns-openapi-2/README.md

@@ -192,7 +192,7 @@ Only fully implemented specification objects should be checked here.
 - [ ] [Path Item Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#user-content-path-item-object)
 - [ ] [Operation Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#user-content-operation-object)
 - [x] [External Documentation Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#user-content-external-documentation-object)
-- [ ] [Parameter Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#user-content-parameter-object)
+- [x] [Parameter Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#user-content-parameter-object)
 - [x] [Items Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#user-content-items-object)
 - [ ] [Responses Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#user-content-responses-object)
 - [ ] [Response Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#user-content-response-object)

packages/apidom-ns-openapi-2/src/elements/Parameter.ts

@@ -0,0 +1,320 @@
+import {
+  StringElement,
+  BooleanElement,
+  Attributes,
+  Meta,
+  NumberElement,
+  ArrayElement,
+  ObjectElement,
+} from '@swagger-api/apidom-core';
+import { UnsupportedOperationError } from '@swagger-api/apidom-error';
+import {
+  JSONReferenceElement,
+  JSONSchemaElement,
+  MediaElement,
+} from '@swagger-api/apidom-ns-json-schema-draft-4';
+
+import SchemaElement from './Schema';
+
+/* eslint-disable class-methods-use-this */
+class Parameter extends JSONSchemaElement {
+  constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
+    super(content, meta, attributes);
+    this.element = 'parameter';
+    this.classes.push('json-schema-draft-4');
+  }
+
+  /**
+   * Core vocabulary
+   *
+   * URI: https://tools.ietf.org/html/draft-wright-json-schema-00
+   */
+
+  get idProp(): StringElement | undefined {
+    throw new UnsupportedOperationError('idProp getter in Parameter class is not not supported.');
+  }
+
+  set idProp(idProps: StringElement | undefined) {
+    throw new UnsupportedOperationError('idProp setter in Parameter class is not not supported.');
+  }
+
+  get $schema(): StringElement | undefined {
+    throw new UnsupportedOperationError('$schema getter in Parameter class is not not supported.');
+  }
+
+  set $schema($schema: StringElement | undefined) {
+    throw new UnsupportedOperationError('$schema setter in Parameter class is not not supported.');
+  }
+
+  /**
+   * Validation keywords for arrays
+   */
+
+  get additionalItems(): this | JSONReferenceElement | BooleanElement | undefined {
+    throw new UnsupportedOperationError(
+      'additionalItems getter in Parameter class is not not supported.',
+    );
+  }
+
+  set additionalItems(additionalItems: this | JSONReferenceElement | BooleanElement | undefined) {
+    throw new UnsupportedOperationError(
+      'additionalItems setter in Parameter class is not not supported.',
+    );
+  }
+
+  get items(): this | undefined {
+    return this.get('items');
+  }
+
+  set items(items: this | undefined) {
+    this.set('items', items);
+  }
+
+  /**
+   * Validation keywords for objects
+   */
+
+  get maxProperties(): NumberElement | undefined {
+    throw new UnsupportedOperationError(
+      'maxProperties getter in Parameter class is not not supported.',
+    );
+  }
+
+  set maxProperties(maxProperties: NumberElement | undefined) {
+    throw new UnsupportedOperationError(
+      'maxProperties setter in Parameter class is not not supported.',
+    );
+  }
+
+  get minProperties(): NumberElement | undefined {
+    throw new UnsupportedOperationError(
+      'minProperties getter in Parameter class is not not supported.',
+    );
+  }
+
+  set minProperties(minProperties: NumberElement | undefined) {
+    throw new UnsupportedOperationError(
+      'minProperties setter in Parameter class is not not supported.',
+    );
+  }
+
+  // eslint-disable-next-line  @typescript-eslint/no-explicit-any
+  get required(): BooleanElement | undefined | any {
+    return this.get('required');
+  }
+
+  // eslint-disable-next-line  @typescript-eslint/no-explicit-any
+  set required(required: BooleanElement | undefined | any) {
+    this.set('required', required);
+  }
+
+  get properties(): ObjectElement | undefined {
+    throw new UnsupportedOperationError(
+      'properties getter in Parameter class is not not supported.',
+    );
+  }
+
+  set properties(properties: ObjectElement | undefined) {
+    throw new UnsupportedOperationError(
+      'properties setter in Parameter class is not not supported.',
+    );
+  }
+
+  get additionalProperties(): this | JSONReferenceElement | BooleanElement | undefined {
+    throw new UnsupportedOperationError(
+      'additionalProperties getter in Parameter class is not not supported.',
+    );
+  }
+
+  set additionalProperties(
+    additionalProperties: this | JSONReferenceElement | BooleanElement | undefined,
+  ) {
+    throw new UnsupportedOperationError(
+      'additionalProperties setter in Parameter class is not not supported.',
+    );
+  }
+
+  get patternProperties(): ObjectElement | undefined {
+    throw new UnsupportedOperationError(
+      'patternProperties getter in Parameter class is not not supported.',
+    );
+  }
+
+  set patternProperties(patternProperties: ObjectElement | undefined) {
+    throw new UnsupportedOperationError(
+      'patternProperties setter in Parameter class is not not supported.',
+    );
+  }
+
+  get dependencies(): ObjectElement | undefined {
+    throw new UnsupportedOperationError(
+      'dependencies getter in Parameter class is not not supported.',
+    );
+  }
+
+  set dependencies(dependencies: ObjectElement | undefined) {
+    throw new UnsupportedOperationError(
+      'dependencies setter in Parameter class is not not supported.',
+    );
+  }
+
+  /**
+   *  Validation keywords for any instance type
+   */
+
+  get type(): StringElement | undefined {
+    return this.get('type');
+  }
+
+  set type(type: StringElement | undefined) {
+    this.set('type', type);
+  }
+
+  get allOf(): ArrayElement | undefined {
+    throw new UnsupportedOperationError('allOf getter in Parameter class is not not supported.');
+  }
+
+  set allOf(allOf: ArrayElement | undefined) {
+    throw new UnsupportedOperationError('allOf setter in Parameter class is not not supported.');
+  }
+
+  get anyOf(): ArrayElement | undefined {
+    throw new UnsupportedOperationError('anyOf getter in Parameter class is not not supported.');
+  }
+
+  set anyOf(anyOf: ArrayElement | undefined) {
+    throw new UnsupportedOperationError('anyOf setter in Parameter class is not not supported.');
+  }
+
+  get oneOf(): ArrayElement | undefined {
+    throw new UnsupportedOperationError('oneOf getter in Parameter class is not not supported.');
+  }
+
+  set oneOf(oneOf: ArrayElement | undefined) {
+    throw new UnsupportedOperationError('oneOf setter in Parameter class is not not supported.');
+  }
+
+  get not(): this | JSONReferenceElement | undefined {
+    throw new UnsupportedOperationError('not getter in Parameter class is not not supported.');
+  }
+
+  set not(not: this | JSONReferenceElement | undefined) {
+    throw new UnsupportedOperationError('not setter in Parameter class is not not supported.');
+  }
+
+  get definitions(): ObjectElement | undefined {
+    throw new UnsupportedOperationError(
+      'definitions getter in Parameter class is not not supported.',
+    );
+  }
+
+  set definitions(definitions: ObjectElement | undefined) {
+    throw new UnsupportedOperationError(
+      'definitions setter in Parameter class is not not supported.',
+    );
+  }
+
+  /**
+   * Metadata keywords
+   *
+   * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-validation-00#section-6
+   */
+
+  get title(): StringElement | undefined {
+    throw new UnsupportedOperationError('title getter in Parameter class is not not supported.');
+  }
+
+  set title(title: StringElement | undefined) {
+    throw new UnsupportedOperationError('title setter in Parameter class is not not supported.');
+  }
+
+  get description(): StringElement | undefined {
+    return this.get('description');
+  }
+
+  set description(description: StringElement | undefined) {
+    this.set('description,', description);
+  }
+
+  /**
+   * Semantic validation with "format"
+   *
+   * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-validation-00#section-7
+   */
+
+  get format(): StringElement | undefined {
+    return this.get('format');
+  }
+
+  set format(format: StringElement | undefined) {
+    this.set('format', format);
+  }
+
+  /**
+   * JSON Hyper-Schema
+   *
+   * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-hyperschema-00
+   */
+
+  get base(): StringElement | undefined {
+    throw new UnsupportedOperationError('base getter in Parameter class is not not supported.');
+  }
+
+  set base(base: StringElement | undefined) {
+    throw new UnsupportedOperationError('base setter in Parameter class is not not supported.');
+  }
+
+  get links(): ArrayElement | undefined {
+    throw new UnsupportedOperationError('links getter in Parameter class is not not supported.');
+  }
+
+  set links(links: ArrayElement | undefined) {
+    throw new UnsupportedOperationError('links setter in Parameter class is not not supported.');
+  }
+
+  get media(): MediaElement | undefined {
+    throw new UnsupportedOperationError('media getter in Parameter class is not not supported.');
+  }
+
+  set media(media: MediaElement | undefined) {
+    throw new UnsupportedOperationError('media setter in Parameter class is not not supported.');
+  }
+
+  get readOnly(): BooleanElement | undefined {
+    throw new UnsupportedOperationError('readOnly getter in Parameter class is not not supported.');
+  }
+
+  set readOnly(readOnly: BooleanElement | undefined) {
+    throw new UnsupportedOperationError('readOnly setter in Parameter class is not not supported.');
+  }
+
+  /**
+   * OpenAPI vocabulary
+   */
+  get name(): StringElement | undefined {
+    return this.get('name');
+  }
+
+  set name(name: StringElement | undefined) {
+    this.set('name', name);
+  }
+
+  get in(): StringElement | undefined {
+    return this.get('in');
+  }
+
+  set in(val: StringElement | undefined) {
+    this.set('in', val);
+  }
+
+  get schema(): SchemaElement | undefined {
+    return this.get('schema');
+  }
+
+  set schema(schema: SchemaElement | undefined) {
+    this.set('schema', schema);
+  }
+}
+/* eslint-enable class-methods-use-this */
+
+export default Parameter;

packages/apidom-ns-openapi-2/src/elements/Schema.ts

@@ -0,0 +1,12 @@
+import { Attributes, Meta } from '@swagger-api/apidom-core';
+import { JSONSchemaElement } from '@swagger-api/apidom-ns-json-schema-draft-4';
+
+class Schema extends JSONSchemaElement {
+  constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
+    super(content, meta, attributes);
+    this.element = 'schema';
+    this.classes.push('json-schema-draft-4');
+  }
+}
+
+export default Schema;

packages/apidom-ns-openapi-2/src/index.ts

@@ -24,6 +24,7 @@ export {
   isLicenseElement,
   isContactElement,
   isExternalDocumentationElement,
+  isParameterElement,
   isItemsElement,
   isHeadersElement,
   isExampleElement,
@@ -44,6 +45,7 @@ export {
   LicenseElement,
   ContactElement,
   ExternalDocumentationElement,
+  ParameterElement,
   ItemsElement,
   HeadersElement,
   ExampleElement,

packages/apidom-ns-openapi-2/src/namespace.ts

@@ -4,6 +4,7 @@ import InfoElement from './elements/Info';
 import LicenseElement from './elements/License';
 import ContactElement from './elements/Contact';
 import ExternalDocumentation from './elements/ExternalDocumentation';
+import ParameterElement from './elements/Parameter';
 import ItemsElement from './elements/Items';
 import ExampleElement from './elements/Example';
 import HeadersElement from './elements/Headers';
@@ -23,6 +24,7 @@ const openApi2 = {
     base.register('license', LicenseElement);
     base.register('contact', ContactElement);
     base.register('externalDocumentation', ExternalDocumentation);
+    base.register('parameter', ParameterElement);
     base.register('items', ItemsElement);
     base.register('headers', HeadersElement);
     base.register('example', ExampleElement);

packages/apidom-ns-openapi-2/src/predicates.ts

@@ -4,6 +4,7 @@ import InfoElement from './elements/Info';
 import LicenseElement from './elements/License';
 import ContactElement from './elements/Contact';
 import ExternalDocumentation from './elements/ExternalDocumentation';
+import ParameterElement from './elements/Parameter';
 import ItemsElement from './elements/Items';
 import ExampleElement from './elements/Example';
 import HeadersElement from './elements/Headers';
@@ -54,6 +55,16 @@ export const isExternalDocumentationElement = createPredicate(
   },
 );
 
+export const isParameterElement = createPredicate(
+  ({ hasBasicElementProps, isElementType, primitiveEq }) => {
+    return (element: unknown) =>
+      element instanceof ParameterElement ||
+      (hasBasicElementProps(element) &&
+        isElementType('parameter', element) &&
+        primitiveEq('object', element));
+  },
+);
+
 export const isItemsElement = createPredicate(
   ({ hasBasicElementProps, isElementType, primitiveEq }) => {
     return (element: unknown) =>