Data from a Postman Collection
This section provides the mapping of data between a Postman collection and an adapter definition document, which is generated using the collection.
Note:
If a property is marked Not Applicable (NA), it means the corresponding property is absent from the Postman collection that is used to generate the adapter definition document. In these instances, a default or fixed value is set in the adapter definition document.Info Component
This topic provides the mapping of data for the Info component of the adapter definition document, generated using a Postman collection.
Property in Postman Collection | Property in Adapter Definition Document | Filled In During Conversion? | Notes |
---|---|---|---|
"develop:" + info.name .
|
id |
Yes | During conversion, any non-alphanumeric character (including spaces) is replaced with a hyphen (-), and then truncated to the maximum character length (100) for an ID of the adapter definition document. |
info.name |
displayName |
Yes | Title mapping. |
info.description |
description |
Yes | Description mapping. |
NA | version |
Yes | Default value filled in is 1.0.0. |
NA | specVersion |
Yes | Default value filled in is 1.0. |
NA | categories |
No | User-defined value. |
NA | appInfo.name |
Yes | Hard-coded null. |
NA | appInfo.contactUs |
Yes | |
NA | appInfo.description |
Yes | |
NA | appInfo.supportURL |
Yes | |
NA | appInfo.documentationUrl |
Yes | |
NA | publisherInfo.name |
Yes | Hard-coded null. |
NA | publisherInfo.description |
Yes | |
NA | publisherInfo.contactUS |
Yes | |
NA | publisherInfo.supportURL |
Yes | |
NA | publisherInfo.documentationURL |
Yes | |
NA | publisherInfo.releaseNotes |
Yes |