required-collection-info
Overview
This rule belongs to the postman-validation ruleset and states that:
The root object of a Postman Collection (v2.0 and above) must contain basic information or metadata related to the collection using the info property.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Required property info in root object is missing. |
| Code | POSTMAN_V100 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Collection Metadata |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | postman api semantic validation info collection |
Suggested Fixes
- Add missing
infoproperty in the root object. - Make sure that the
infoproperty value is not null.
For More Information
- https://learning.postman.com/collection-format/getting-started/structure-of-a-collection/#info
- https://schema.postman.com/collection/json/v2.1.0/draft-07/docs/index.html
- https://schema.postman.com/collection/json/v2.1.0/draft-07/collection.json
- https://schema.postman.com/collection/json/v2.0.0/draft-07/docs/index.html
- https://schema.postman.com/collection/json/v2.0.0/draft-07/collection.json
- https://learning.postman.com/docs/introduction/overview/
- https://docs.apimatic.io/rulesets/overview/