@azure/avocado - npm Package Compare versions

Comparing version 0.8.14 to 0.9.0

package.json

 {
   "name": "@azure/avocado",
-  "version": "0.8.14",
+  "version": "0.9.0",
   "description": "A validator of OpenAPI configurations",
@@ -92,3 +92,3 @@ "main": "dist/index.js",
     "js-yaml": "^3.13.1",
-    "jsonpath-plus": "^6.0.1",
+    "jsonpath-plus": "^10.0.0",
     "node-fetch": ">=2.6.1",
@@ -114,3 +114,6 @@ "node-notifier": ">=8.0.1",
     "typescript": "3.5.2"
+  },
+  "engines": {
+    "node": ">=18.0.0"
   }
 }

README.md

@@ -132,6 +132,27 @@ # Avocado
 
-The default tag should contain all APIs. The API path \`${0}\` is not in the default tag. Please make sure the missing API swaggers are in the default tag.
+The [default][AutoRest tags] API version tag (as seen in the `Basic information` section in the [AutoRest configuration file][AutoRest config] (the README file)) should contain all API paths.
+The API path \`${0}\` is not present in any OpenAPI `.json` files enumerated in the list of paths included in the default tag, as seen in the [relevant `Tag:` section][AutoRest tags] in the AutoRest configuration file (the README file).
 
-To fix this error. You should add the missing API swaggers to the default tag. If the missing API swaggers are deprecated, in this case this error could be ignored.
+To fix this error include an OpenAPI `.json` file path in the list of the default API version tag paths (in the [relevant `Tag:` section][AutoRest tags]) that includes the missing API path.
 
+**IMPORTANT**: The error may point to a previous API version. **This does not mean this is a false positive**! It means that the previous API version has an API path that is missing from the default API version.
+
+**Common scenarios where Avocado fails your PR correctly**: 
+
+- Often the API path is missing from the default API version due to casing mismatch; e.g. the path in the new API version has `resourceGroups` in it while the previous one has `resourcegroups`. See examples below.
+- If Avocado reports missing a path that you have **intentionally deprecated** or **intentionally removed** but the API version is publicly released (GA, generaly available, not in preview) first you need to get
+Breaking Change Board approval. Follow the breaking change process from step 1 in [this diagram](https://aka.ms/pr-diagram). If you already got such approval in a previous PR, follow the [suppression guide]. Mention the scenario you identified.
+
+**Known scenarios where Avocado reports false positive**: Avocado may incorrectly report failures in following two scenarios:
+- Your API is deprecated/obsolete [#6627](https://github.com/Azure/azure-sdk-tools/issues/6627) (example case in [PR 24771](https://github.com/Azure/azure-rest-api-specs/pull/24771#issuecomment-1660776189))
+- Your API is using the service group folder [#6201](https://github.com/Azure/azure-sdk-tools/issues/6201)
+
+If you are dealing with one of these scenarios, follow the [suppression guide]. Mention the scenario you identified.
+
+**When this error can be suppressed**: If the missing API path is deprecated then you can suppress this error. Follow this [suppresion guide].
+ 
+For example detailed analyses of occurrences of such errors, see these GitHub comments:  
+- [PR 23941 comment](https://github.com/Azure/azure-rest-api-specs/pull/23941#issuecomment-1585095669)  
+- [PR 24939 comment](https://github.com/Azure/azure-rest-api-specs/pull/24939#issuecomment-1656434544)
+
 ### NOT_LATEST_API_VERSION_IN_DEFAULT_TAG
@@ -141,6 +162,9 @@
 
-The default tag does not contains the latest API version. Please make sure the latest api version swaggers are in the default tag.
+The [default][AutoRest tags] API version tag (as seen in the `Basic information` section in the [AutoRest configuration file][AutoRest config] (the README file)) does not contain the latest API version of given OpenAPI `.json` file. 
 
-To fix this error. You should add the latest API version swaggers to the default tag or change default tag to reference latest api version tag.
+To fix this error, please make sure the `.json` file at the latest API version path is included in the list of paths for the default tag, in the [relevant `Tag:` section][AutoRest tags] in the AutoRest configuration file (the README file).
+Alternatively, change the default API version tag to a valid one by editing the `Basic information` section.
 
+For an example detailed analysis of an occurrence of such error, see [this GitHub comment](https://github.com/Azure/azure-rest-api-specs/pull/23941#issuecomment-1585085436).
+
 ### MULTIPLE_DEFAULT_TAGS
@@ -175,1 +199,5 @@
 contact [[e-mail]](mailto:[e-mail]) with any additional questions or comments.
+
+[AutoRest config]: http://azure.github.io/autorest/user/configuration.html
+[AutoRest tags]: https://azure.github.io/autorest/generate/#adding-tags-when-generating
+[suppression guide]: https://aka.ms/azsdk/pr-suppressions

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

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

174442

increased by1.76%

Number of lines in readme file

201

increased by16.18%

Worsened metrics

Number of medium supply chain risk alerts

2

increased by100%

Dependency changes

• + Added@jsep-plugin/assignment@1.3.0(transitive)

• + Added@jsep-plugin/regex@1.0.4(transitive)

• + Addedjsep@1.4.0(transitive)

• + Addedjsonpath-plus@10.2.0(transitive)

• - Removedjsonpath-plus@6.0.1(transitive)

• Updatedjsonpath-plus@^10.0.0