Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Include API publication in the CHORDS server #532

Open
MisterMartin opened this issue Jul 18, 2019 · 0 comments
Open

Include API publication in the CHORDS server #532

MisterMartin opened this issue Jul 18, 2019 · 0 comments
Assignees
@intRobyn @CrazyCatProgrammer
Labels
documentation create/modify documentation feature feature request (internal and external)
Projects
Release 1.1

Comments

@MisterMartin
Copy link
Member

The rswag gem allows you to add API documentation (via rspec files), which is then automagically served by the Rails app, via both a dynamic web page, and json endpoints. The web page allows you to test the endpoints.

Robyn has almost completed this for the existing CHORDS API.
@MisterMartin MisterMartin added feature feature request (internal and external) documentation create/modify documentation labels Jul 18, 2019
@MisterMartin MisterMartin added this to In progress in Release 1.1 Jul 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@intRobyn intRobyn

@CrazyCatProgrammer CrazyCatProgrammer

Labels
documentation create/modify documentation feature feature request (internal and external)
Projects
Release 1.1
  
In progress
Milestone
No milestone
Development

No branches or pull requests
3 participants
@MisterMartin @intRobyn @CrazyCatProgrammer