at-least-one-folder
Overview
This rule belongs to the postman-validation
ruleset and states that:
In a collection, related requests should be grouped into a folder for easy navigation and discovery. For Postman v1.0, one or more folder definitions could be added in the root folders
property whereas for Postman v2.0 or above, the root item
property could define folders by adding one or more item groups.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Warning |
Message | Collection contains no folders/item groups. |
Code | POSTMAN_V251 |
Type | Validation |
Rule System | Semantic |
Broad Category | Folders |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | postman api semantic validation folder item group item request collection |
Suggested Fixes
- If you are using Postman v1.0, ensure that root level
folders
property value is not empty/null and contains at least one folder definition. - If you are using Postman v2.0 or above, ensure that the root level
item
property value is not empty/null and contains at least one item group/folder definition. - Create a folder within your collection in the Postman application by selecting
Add Folder
option from the menu, save and export your collection and then try again.
For More Information
- https://learning.postman.com/collection-format/getting-started/structure-of-a-collection/#item-groups
- 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://schema.postman.com/collection/json/v1.0.0/draft-07/docs/index.html
- https://schema.postman.com/collection/json/v1.0.0/draft-07/collection.json
- https://learning.postman.com/docs/sending-requests/requests/
- https://learning.postman.com/docs/introduction/overview/
- https://docs.apimatic.io/rulesets/overview/