@speclynx/apidom-ns-openapi-2 4.1.0 → 4.2.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.2.0](https://github.com/speclynx/apidom/compare/v4.1.0...v4.2.0) (2026-03-17)
+
+### Features
+
+- **ns-openapi-2-0:** add normalization refractor plugins ([#170](https://github.com/speclynx/apidom/issues/170)) ([315b5c6](https://github.com/speclynx/apidom/commit/315b5c620f752941749df13c0a5ab4bd14d41597))
+
 # [4.1.0](https://github.com/speclynx/apidom/compare/v4.0.5...v4.1.0) (2026-03-16)
 
 **Note:** Version bump only for package @speclynx/apidom-ns-openapi-2

package/README.md

@@ -185,6 +185,128 @@ const swaggerElement = SwaggerElement.refract(apiDOM.result, {
 //     (StringElement)))
 ```
 
+#### Normalize Parameter Objects plugin
+
+Duplicates Parameters from Path Items to Operation Objects using following rules:
+
+- An Operation-level parameter with the same name and location overrides the inherited Path Item parameter, but Path Item parameters can never be removed at the Operation level
+- The list MUST NOT include duplicated parameters
+- A unique parameter is defined by a combination of a name and location.
+
+```js
+import { toValue } from '@speclynx/apidom-core';
+import { parse } from '@speclynx/apidom-parser-adapter-yaml-1-2';
+import { refractorPluginNormalizeParameters, SwaggerElement } from '@speclynx/apidom-ns-openapi-2';
+
+const yamlDefinition = `
+swagger: "2.0"
+paths:
+  /:
+    parameters:
+      - name: param1
+        in: query
+        type: string
+      - name: param2
+        in: query
+        type: string
+    get: {}
+`;
+const apiDOM = await parse(yamlDefinition);
+const swaggerElement = SwaggerElement.refract(apiDOM.result, {
+  plugins: [refractorPluginNormalizeParameters()],
+});
+
+toValue(swaggerElement);
+// =>
+// {
+//   "swagger": "2.0",
+//   "paths": {
+//     "/": {
+//       "parameters": [
+//         {
+//           "name": "param1",
+//           "in": "query",
+//           "type": "string"
+//         },
+//         {
+//           "name": "param2",
+//           "in": "query",
+//           "type": "string"
+//         }
+//       ],
+//       "get": {
+//         "parameters": [
+//           {
+//             "name": "param1",
+//             "in": "query",
+//             "type": "string"
+//           },
+//           {
+//             "name": "param2",
+//             "in": "query",
+//             "type": "string"
+//           }
+//         ]
+//       }
+//     }
+//   }
+// }
+```
+
+#### Normalize Security Requirements Objects plugin
+
+`Operation.security` definition overrides any declared top-level security from Swagger.security field.
+If Operation.security field is not defined, this field will inherit security from Swagger.security field.
+
+```js
+import { toValue } from '@speclynx/apidom-core';
+import { parse } from '@speclynx/apidom-parser-adapter-yaml-1-2';
+import { refractorPluginNormalizeSecurityRequirements, SwaggerElement } from '@speclynx/apidom-ns-openapi-2';
+
+const yamlDefinition = `
+swagger: "2.0"
+security:
+  - petstore_auth:
+      - write:pets
+      - read:pets
+paths:
+  /:
+    get: {}
+`;
+const apiDOM = await parse(yamlDefinition);
+const swaggerElement = SwaggerElement.refract(apiDOM.result, {
+  plugins: [refractorPluginNormalizeSecurityRequirements()],
+});
+
+toValue(swaggerElement);
+// =>
+// {
+//   "swagger": "2.0",
+//   "security": [
+//     {
+//       "petstore_auth": [
+//         "write:pets",
+//         "read:pets"
+//       ]
+//     }
+//   ],
+//   "paths": {
+//     "/": {
+//       "get": {
+//         "security": [
+//           {
+//             "petstore_auth": [
+//               "write:pets",
+//               "read:pets"
+//             ]
+//           }
+//         ]
+//       }
+//     }
+//   }
+// }
+```
+
 ## Implementation progress
 
 Only fully implemented specification objects should be checked here.