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

Integrate SwaggerHub #25

Closed NdagiStanley closed 6 years ago

NdagiStanley commented 6 years ago

What does this PR do?

The branch was created by SwaggerHub and updated automatically on updating the API spec.

Description of Task to be completed?

Add Github Sync on the program-registry API on SwaggerHub to this repository. Activate Github Push

How should this be manually tested?

Edit the API spec on SwaggerHub and Save. The .openapi/swagger.yaml will be updated automatically.

Any background context you want to provide?

The main aim for this synchronization was to achieve synchrony between the API spec on Github, SwaggerHub and docs.brighthive.io

What are the relevant pivotal tracker stories?

157679253

akebi commented 6 years ago

@NdagiStanley before this is merged:

rename the swagger-hub-output directory to something related to .openapi so naming is not dated
please update the README.md within the above directory with the steps for how developers can update the openapi spec through swaggerhub