@redocly/openapi-core - npm Package Compare versions

Comparing version 1.4.1 to 1.5.0

CHANGELOG.md

 # @redocly/openapi-core
 
+## 1.5.0
+
+### Minor Changes
+
+- Added new rule `array-parameter-serialization` to require that serialization parameters `style` and `explode` are present on array parameters.
+
 ## 1.4.1
@@ -4,0 +10,0 @@

lib/config/all.js

@@ -81,2 +81,3 @@ "use strict";
         'spec-components-invalid-map-name': 'error',
+        'array-parameter-serialization': 'error',
     },
@@ -105,2 +106,3 @@ oas3_1Rules: {
         'spec-components-invalid-map-name': 'error',
+        'array-parameter-serialization': 'error',
     },
@@ -107,0 +109,0 @@ async2Rules: {

lib/config/minimal.js

@@ -69,2 +69,3 @@ "use strict";
         'response-mime-type': 'off',
+        'array-parameter-serialization': 'off',
     },
@@ -87,2 +88,3 @@ oas3_1Rules: {
         'response-mime-type': 'off',
+        'array-parameter-serialization': 'off',
     },
@@ -89,0 +91,0 @@ async2Rules: {

lib/config/recommended-strict.js

@@ -69,2 +69,3 @@ "use strict";
         'response-mime-type': 'off',
+        'array-parameter-serialization': 'off',
     },
@@ -87,2 +88,3 @@ oas3_1Rules: {
         'response-mime-type': 'off',
+        'array-parameter-serialization': 'off',
     },
@@ -89,0 +91,0 @@ async2Rules: {

lib/config/recommended.js

@@ -69,2 +69,3 @@ "use strict";
         'response-mime-type': 'off',
+        'array-parameter-serialization': 'off',
     },
@@ -87,2 +88,3 @@ oas3_1Rules: {
         'response-mime-type': 'off',
+        'array-parameter-serialization': 'off',
     },
@@ -89,0 +91,0 @@ async2Rules: {

lib/rules/oas3/index.js

@@ -57,2 +57,3 @@ "use strict";
 const component_name_unique_1 = require("./component-name-unique");
+const array_parameter_serialization_1 = require("./array-parameter-serialization");
 exports.rules = {
@@ -113,3 +114,4 @@ spec: spec_1.Spec,
     'component-name-unique': component_name_unique_1.ComponentNameUnique,
+    'array-parameter-serialization': array_parameter_serialization_1.ArrayParameterSerialization,
 };
 exports.preprocessors = {};

lib/types/redocly-yaml.d.ts

@@ -8,3 +8,3 @@ import { NodeType } from '.';
 export type BuiltInOAS2RuleId = typeof builtInOAS2Rules[number];
-declare const builtInOAS3Rules: readonly ["boolean-parameter-prefixes", "component-name-unique", "no-empty-servers", "no-example-value-and-externalValue", "no-invalid-media-type-examples", "no-server-example.com", "no-server-trailing-slash", "no-server-variables-empty-enum", "no-undefined-server-variable", "no-unused-components", "operation-4xx-problem-details-rfc7807", "request-mime-type", "response-contains-property", "response-mime-type", "spec-components-invalid-map-name"];
+declare const builtInOAS3Rules: readonly ["boolean-parameter-prefixes", "component-name-unique", "no-empty-servers", "no-example-value-and-externalValue", "no-invalid-media-type-examples", "no-server-example.com", "no-server-trailing-slash", "no-server-variables-empty-enum", "no-undefined-server-variable", "no-unused-components", "operation-4xx-problem-details-rfc7807", "request-mime-type", "response-contains-property", "response-mime-type", "spec-components-invalid-map-name", "array-parameter-serialization"];
 export type BuiltInOAS3RuleId = typeof builtInOAS3Rules[number];
@@ -11,0 +11,0 @@ declare const builtInAsync2Rules: readonly ["channels-kebab-case", "no-channel-trailing-slash"];

lib/types/redocly-yaml.js

@@ -73,2 +73,3 @@ "use strict";
     'spec-components-invalid-map-name',
+    'array-parameter-serialization',
 ];
@@ -75,0 +76,0 @@ const builtInAsync2Rules = ['channels-kebab-case', 'no-channel-trailing-slash'];

lib/typings/openapi.d.ts

@@ -153,2 +153,3 @@ export interface Oas3Definition {
     examples?: any[];
+    prefixItems?: Oas3_1Schema[];
 };
@@ -155,0 +156,0 @@ export interface Oas3_1Definition extends Oas3Definition {

package.json

 {
   "name": "@redocly/openapi-core",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -6,6 +6,6 @@ # openapi-core
 > [!IMPORTANT]
-The `openapi-core package` is designed for our internal use; the interfaces that are considered safe to use are documented below.
-Some of the function arguments are not documented below because they are not intended for public use.
-Avoid using any functions or features that are not documented below.
-If your use case is not documented below, please open an issue.
+> The `openapi-core package` is designed for our internal use; the interfaces that are considered safe to use are documented below.
+> Some of the function arguments are not documented below because they are not intended for public use.
+> Avoid using any functions or features that are not documented below.
+> If your use case is not documented below, please open an issue.
 
@@ -269,2 +269,2 @@ ## Basic usage
 function stringifyYaml(obj: object): string;
-```
+```

src/config/all.ts

@@ -81,2 +81,3 @@ import type { PluginStyleguideConfig } from './types';
     'spec-components-invalid-map-name': 'error',
+    'array-parameter-serialization': 'error',
   },
@@ -105,2 +106,3 @@ oas3_1Rules: {
     'spec-components-invalid-map-name': 'error',
+    'array-parameter-serialization': 'error',
   },
@@ -107,0 +109,0 @@ async2Rules: {

src/config/minimal.ts

@@ -69,2 +69,3 @@ import type { PluginStyleguideConfig } from './types';
     'response-mime-type': 'off',
+    'array-parameter-serialization': 'off',
   },
@@ -87,2 +88,3 @@ oas3_1Rules: {
     'response-mime-type': 'off',
+    'array-parameter-serialization': 'off',
   },
@@ -89,0 +91,0 @@ async2Rules: {

src/config/recommended-strict.ts

@@ -69,2 +69,3 @@ import type { PluginStyleguideConfig } from './types';
     'response-mime-type': 'off',
+    'array-parameter-serialization': 'off',
   },
@@ -87,2 +88,3 @@ oas3_1Rules: {
     'response-mime-type': 'off',
+    'array-parameter-serialization': 'off',
   },
@@ -89,0 +91,0 @@ async2Rules: {

src/config/recommended.ts

@@ -69,2 +69,3 @@ import type { PluginStyleguideConfig } from './types';
     'response-mime-type': 'off',
+    'array-parameter-serialization': 'off',
   },
@@ -87,2 +88,3 @@ oas3_1Rules: {
     'response-mime-type': 'off',
+    'array-parameter-serialization': 'off',
   },
@@ -89,0 +91,0 @@ async2Rules: {

src/rules/oas3/index.ts

@@ -55,2 +55,3 @@ import { Oas3RuleSet } from '../../oas-types';
 import { ComponentNameUnique } from './component-name-unique';
+import { ArrayParameterSerialization } from './array-parameter-serialization';
 
@@ -112,4 +113,5 @@ export const rules: Oas3RuleSet<'built-in'> = {
   'component-name-unique': ComponentNameUnique,
+  'array-parameter-serialization': ArrayParameterSerialization,
 };
 
 export const preprocessors = {};

src/types/redocly-yaml.ts

@@ -80,2 +80,3 @@ import { rootRedoclyConfigSchema, apiConfigSchema } from './portal-config-schema';
   'spec-components-invalid-map-name',
+  'array-parameter-serialization',
 ] as const;
@@ -82,0 +83,0 @@

src/typings/openapi.ts

@@ -159,2 +159,3 @@ export interface Oas3Definition {
   examples?: any[];
+  prefixItems?: Oas3_1Schema[];
 };
@@ -161,0 +162,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2930243

increased by0.42%

Number of package files

554

increased by0.73%

Lines of code

50340

increased by0.71%

Number of lines in readme file

269

increased by0.37%

Worsened metrics

Number of versions

177

decreased by-0.56%

No dependency changes