search

coner-tech / coner-core

DEPRECATED A REST API for autocross event operations
GNU Affero General Public License v3.0
7 stars 3 forks source link

Add Postman Collection file #195

Closed Moonchopper closed 6 years ago

Moonchopper commented 7 years ago

Postman collection to quickly build an event and capture responses via the existing Coner/caeos API - no validation yet. This can be imported into Postman (among other methods for getting the collection into Postman) (https://www.getpostman.com/)

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 90.462% when pulling f5258477fa127c11e21f1b86f82e2afe81b6b312 on Moonchopper:master into d8d2eb1a1498debe5348716f6334dcfeaa5d6987 on caeos:master.

carltonwhitehead commented 7 years ago

@Moonchopper Sorry for taking forever to get back to you about this.

I think this will be really useful to help people manually exercise the API. We don't have any UI yet, so this is the next best thing.

The only issue that I see with this is its discoverability. Could you make a folder postman-collections, move the file into it as coner-core.postman_collection.json, and write up a little bit of documentation for it? Give it a mention in the README.md. If you think it would help, feel free to spell out how to use it in more detail in a postman-collections/README.md. I remember there were some tricks with the environment variables that could throw people off.

Moonchopper commented 7 years ago

Can do.

carltonwhitehead commented 7 years ago

I've made a bunch of changes to the README.md on master that you'll need to merge. Check out the section Coner Core > Try it! > Actions. After the section API Spec would be a good spot to add a Postman section