Autogenerate api documentation for the public apis
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 20/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- ruby
- Domain
- api, documentation
Research direction
Start by reviewing the server's public APIs used by clients and the proposed rspec_api_documentation gem. Determine which trivial APIs can be covered and how generated documentation should be published. Done means the selected public APIs have autogenerated documentation that clients can use.
Written by the indexing model from the issue text.
Description
We should attempt on trying to autogenerate api documentation at least for the trivial APIs used by various clients. This probably should be done with a gem like https://github.com/zipmark/rspec_api_documentation
- Dominant language
- Ruby
- Stars
- 51
- Forks
- 42
- Avg merge
- 1h 27m
- Merged PRs (30d)
- 1
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from testmycode/tmc-server
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
testmycode/tmc-server#590 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 20/100
testmycode/tmc-server#576 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
testmycode/tmc-server#488 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
testmycode/tmc-server#487 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
testmycode/tmc-server#477 · 2 comments ·
All issues in testmycode/tmc-server
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
バグ
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
voxpupuli/puppet-epel#186 · 1 comment ·
-
external_created_at is no longer used for the message timestamp since the new message UI (v4.4.0) OpenBug Frontend
Difficulty 2/5 1-3 hours Newbie friendliness 78/100