Skip to content
New issue
Jump to bottom

Finish API documentation #24

Closed
2 tasks
campb303 opened this issue Aug 6, 2020 · 1 comment
Closed
2 tasks

Finish API documentation #24

campb303 opened this issue Aug 6, 2020 · 1 comment
Assignees
@benne238
Labels
documentation Related to the writing documentation or the tools used to generate docs duplicate Extraneous issue tracking something already tracked elsewhere high-priority Needs immediate extra focus

Comments

@campb303
Copy link
Collaborator

campb303 commented Aug 6, 2020

There are four levels of documentation for the API:

Level Description
Module Public attributes, classes and methods.
Class Public attributes and methods with examples.
Method Public attributes and methods with examples
Specification Examples of endpoints, HTTP methods, and return info

All levels need to be completed. The following is a list of documentation, some completed and other not.

  • /api/string:queue
  • /api/string:queue/int:number
@campb303 campb303 added api documentation Related to the writing documentation or the tools used to generate docs labels Aug 7, 2020
@campb303 campb303 mentioned this issue Aug 7, 2020
Closed
@campb303 campb303 added this to the v1 milestone Sep 14, 2020
@campb303 campb303 added high-priority Needs immediate extra focus duplicate Extraneous issue tracking something already tracked elsewhere labels Nov 25, 2020
@campb303
Copy link
Collaborator Author

campb303 commented Dec 1, 2020

Closing as a duplicate of #25

@campb303 campb303 closed this as completed Dec 1, 2020
Sign in to join this conversation on GitHub.
Assignees

@benne238 benne238

Labels
documentation Related to the writing documentation or the tools used to generate docs duplicate Extraneous issue tracking something already tracked elsewhere high-priority Needs immediate extra focus
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@campb303 @benne238