@ibm-cloud/openapi-ruleset - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0

CHANGELOG.md

@@ -0,1 +1,8 @@
+# @ibm-cloud/openapi-ruleset [0.5.0](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/openapi-ruleset@0.4.0...@ibm-cloud/openapi-ruleset@0.5.0) (2022-02-15)
+
+
+### Features
+
+* **new rule:** property names must be snake case (property-case-convention) ([364ef90](https://github.com/IBM/openapi-validator/commit/364ef90ac588d36cde8a54e44c610d0a3f74ca95))
+
 # @ibm-cloud/openapi-ruleset [0.4.0](https://github.com/IBM/openapi-validator/compare/@ibm-cloud/openapi-ruleset@0.3.0...@ibm-cloud/openapi-ruleset@0.4.0) (2022-02-15)
@@ -2,0 +9,0 @@

package.json

 {
   "name": "@ibm-cloud/openapi-ruleset",
   "description": "Spectral ruleset for validating IBM Cloud services",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "license": "Apache-2.0",
@@ -6,0 +6,0 @@ "private": false,

src/functions/index.js

@@ -6,2 +6,3 @@ const arrayOfArrays = require('./array-of-arrays');
 const errorResponseSchema = require('./error-response-schema');
+const propertyCaseConvention = require('./property-case-convention');
 const requiredProperty = require('./required-property');
@@ -20,2 +21,3 @@ const responseExampleProvided = require('./response-example-provided');
   errorResponseSchema,
+  propertyCaseConvention,
   requiredProperty,
@@ -22,0 +24,0 @@ responseExampleProvided,

src/ibm-oas.js

@@ -105,2 +105,3 @@ const { oas3 } = require('@stoplight/spectral-formats');
     'prohibit-summary-sentence-style': ibmRules.prohibitSummarySentenceStyle,
+    'property-case-convention': ibmRules.propertyCaseConvention,
     'request-body-object': ibmRules.requestBodyObject,
@@ -107,0 +108,0 @@ 'response-error-response-schema': ibmRules.responseErrorResponseSchema,

src/rules/index.js

@@ -14,2 +14,3 @@ const arrayOfArrays = require('./array-of-arrays');
 const prohibitSummarySentenceStyle = require('./prohibit-summary-sentence-style');
+const propertyCaseConvention = require('./property-case-convention');
 const requestBodyObject = require('./request-body-object');
@@ -37,2 +38,3 @@ const responseErrorResponseSchema = require('./response-error-response-schema');
   prohibitSummarySentenceStyle,
+  propertyCaseConvention,
   requestBodyObject,
@@ -39,0 +41,0 @@ responseErrorResponseSchema,

test/utils/root-document.js

@@ -174,2 +174,7 @@ module.exports = {
             $ref: '#/components/schemas/NormalString'
+          },
+          running_time: {
+            type: 'integer',
+            format: 'int32',
+            description: 'The length of the movie, in minutes.'
           }
@@ -179,3 +184,4 @@ },
           name: 'The Two Towers',
-          director: 'Peter Jackson'
+          director: 'Peter Jackson',
+          running_time: 179
         }
@@ -182,0 +188,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

782351

increased by3.6%

Number of package files

136

increased by3.82%

Lines of code

6780

increased by2%

No dependency changes