Skip to main content

valid-postman-collection-syntax

Overview​

This rule belongs to the postman-validation ruleset and states that:

The provided Postman Collection file must not contain any syntax/semantic issues and use only valid JSON. Each property in the file must have a type as defined in the standard.

PropertyValue
EnabledYes
Maximum SeverityBlocking
MessageProvided Postman Collection file is not valid.
CodePOSTMAN_V001
TypeValidation
Rule SystemSemantic
Broad CategoryBasic Structure
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagspostman api semantic validation collection syntax

Suggested Fixes​

  • Try importing the file in the Postman app, export it and try again using that.
  • Ensure that the file contents are complete.
  • Ensure that the file uses valid JSON.
  • Ensure that each element in the Postman Colletion file has the expected type.
  • Ensure that an array is not defined as an object or vice versa.
  • Ensure that where a number is expected, a string value is not provided, etc.
  • For objects, ensure that each property has a correct type assigned to it.

For More Information​