Skip to content
New issue
Jump to bottom

Create API Docs #195

Closed
campb303 opened this issue Feb 16, 2021 · 3 comments
Closed

Create API Docs #195

campb303 opened this issue Feb 16, 2021 · 3 comments
Assignees
@benne238
Labels
documentation Related to the writing documentation or the tools used to generate docs high-priority Needs immediate extra focus
Projects
v1.0

Comments

@campb303
Copy link
Collaborator

An issue to track the API docs separate of MkDocs integration.
@campb303 campb303 added api documentation Related to the writing documentation or the tools used to generate docs labels Feb 16, 2021
@campb303 campb303 added this to the v1-proof-of-concept milestone Feb 16, 2021
@campb303
Copy link
Collaborator Author

campb303 commented Feb 16, 2021 •
edited

Proposal for API hierarchy and ordering:

  • Getting Started:
    • Get Item and read date last updated.
    • Get Queue and read number of items.
  • Installation (?)
  • Authentication
    • Active Directory Auth
    • Access Tokens
    • Refresh Tokens
  • Items
    • Fields
    • Options
  • Queues
    • Fields
    • Options
  • Utilities
    • Get Queues

@campb303
Copy link
Collaborator Author

All examples should be given for both the JavaScript fetch() tool and cURL.

@campb303 campb303 mentioned this issue Feb 17, 2021
Closed
@campb303 campb303 added this to To do in v1.0 Mar 8, 2021
@campb303 campb303 moved this from To do to In progress in v1.0 Mar 8, 2021
@campb303 campb303 added the high-priority Needs immediate extra focus label Mar 8, 2021
@campb303
Copy link
Collaborator Author

Moved to ECN/webqueue2-api#8

v1.0 automation moved this from In progress to Done Mar 17, 2021
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 high-priority Needs immediate extra focus
Projects
No open projects
v1.0
  
Done
Milestone
No milestone
Development

No branches or pull requests
2 participants
@campb303 @benne238