[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
This repository has been archived by the owner on Apr 24, 2023. It is now read-only.

Fully document the REST API using Swagger annotations #797

Open
DaoWen opened this issue Mar 31, 2018 · 2 comments
Open

Fully document the REST API using Swagger annotations #797

DaoWen opened this issue Mar 31, 2018 · 2 comments
Assignees
@DaoWen
Labels
documentation good first issue help wanted

Comments

@DaoWen
Copy link
Contributor
DaoWen commented Mar 31, 2018

Our current REST API doc has some parts that are outdated or have always been inaccurate. We should fully document the REST API using the swagger annotations in the code. This would encourage/remind us to update the documentation when we make changes to the REST API.

We should also use defschema to get better JSON object names in the swagger data model descriptions. We're currently only doing this for the data on /info.link
@DaoWen DaoWen self-assigned this Mar 31, 2018
This was referenced Mar 31, 2018
Closed
Closed
@rjseymour66
Copy link

I am a professional technical writer with REST API experience. Do you still need help on this?

@DaoWen
Copy link
Contributor Author
DaoWen commented Oct 31, 2018

@rjseymour66 - A pull request for this would be welcome. Are you familiar with Clojure and Swagger?

The changes described here would be made almost exclusively to the following source file:
https://github.com/twosigma/Cook/blob/master/scheduler/src/cook/mesos/api.clj

All new contributors also need to sign and submit the Contributor License Agreement before we can accept any changes or other contributions to this project:
https://github.com/twosigma/Cook/tree/master/cla

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@DaoWen DaoWen

Labels
documentation good first issue help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dposada @DaoWen @rjseymour66