search

workforce-data-initiative / programs-registry

Machine readable, public directory of programs and services offered by eligible training providers
https://docs.brighthive.io
Apache License 2.0
1 stars 0 forks source link

Feature/api spec #11

Closed gitgik closed 6 years ago

gitgik commented 6 years ago

What does this PR do?

It defines an OpenAPI 2.0 specification for the program registry API

How can this be manually tested?

After setting migrations and all, run the service python app.py Access the swagger spec on your browser using http://localhost:8080/api/ui/

Relevant pivotal tracker stories

152197760

NdagiStanley commented 6 years ago

We still have an issue with docker-compose up. I will look it up

NdagiStanley commented 6 years ago

Figured it out. @gitgik. This is good to go!

URLs

Note to team: The root endpoints has shifted from /programs to /api

So the urls are: /api - as the main API endpoint /api/ui/ - as the API SPEC url endpoint