Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
Add postman collection and README for general workflow #782
tuxxy left a comment •
Everything looks good here, but my only concern is that endpoints get updated and the postman examples get left behind.
Currently, no one on the team actively uses postman. With that said, that's my only concern with this PR. If a member of the team decided to maintain this, then I think I could be +1 to this contribution. Due to the early stages of this API as well, I'm hesitant to agree to merge this in such a state. If the API was more frozen, then I can see merging this even if no one on the team was going to use postman.
I had also suggested a tool like newman to run the tests. I like making the calls because it allows the http context to be generated without any mocking. Because of that his will also be a good place to test things like CORS access or TLS if that is intended to be added to the product.
I also think having a postman collection may be easy for a first time user to pick up without having to read and understand the python tests.
I do want to make sure the documentation stays up to date. I think this would be done if it is truly used by the community where if it's not used it will be neglected.
I actually do use postman, and I think this is a nice step for lowering the bar to entry; However, our experience tells us that anything that is untested will eventually fail.
I'm looking forward to having this contribution merged if we can find a way to include in in CI.