Standardize the Postman Collections to meaningful variable names/descriptions

Feedback Idea Discussions
, , , ,
1

When working with the postman collection, many of the APIs take in an ID for the object they are referencing (source, entitlement, etc.) These are commonly referred to with the :id tag, which is fairly generic and short. However there are many places where they are referred to by their type as well, such as :sourceid. Would it be possibly to standardize on the more descriptive name?

Alternately, if that is not possible, could the descriptions of the Variables be added/updated to be consistent through the source? Currently there are many locations without descriptions, and many with inconsistent descriptions. For Source ID, I have found the following:

  • BLANK
  • (Required) A source id
  • (Required) Source ID
  • (Required) Source ID.
  • (Required) source ID.
  • (Required) Source Id
  • (Required) The Source id
  • (Required) The Source ID.
  • (Required) The Source id.
  • (Required) The source id

Having consistency would improve the readability of the Collection

2 Likes
2

Hello Geoff, not really sure what you meant? Would you mind dropping a guided screenshot. I’ll try my best to help you.

3

@eberteo This is a suggestion for an improvement to the API Documentation/Postman collection, not an issue that needs to be solved.

I appreciate your willingness to help though