Skip to content
Closed
campb303 opened this issue Mar 17, 2021 · 2 comments
Closed

Update Docs #8

campb303 opened this issue Mar 17, 2021 · 2 comments
Labels
documentation Related to the writing documentation or the tools used to generate docs high-priority Needs immediate extra focus
Projects

Comments

@campb303
Copy link
Collaborator

Continued from ECN/webqueue2-frontend#25

Need to add docs about docs to docs.

@campb303 campb303 added the documentation Related to the writing documentation or the tools used to generate docs label Mar 17, 2021
@campb303
Copy link
Collaborator Author

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

All examples should be given for JS fetch and cURL.

@campb303 campb303 added this to To do in v1.0 via automation Mar 29, 2021
@campb303 campb303 moved this from To do to In progress in v1.0 Mar 29, 2021
@campb303 campb303 added this to the production-ready milestone Mar 29, 2021
@campb303 campb303 added the high-priority Needs immediate extra focus label Mar 29, 2021
@campb303
Copy link
Collaborator Author

campb303 commented Apr 2, 2021

cURL examples will be dropped moving forward. cURL isn't the intended use case for this API and creating examples fit for cURL is taking a disproportionate amount of time. The necessary HTTP details can be pulled from the JavaScript examples and used by someone familiar with cURL.

@campb303 campb303 mentioned this issue Apr 4, 2021
@campb303 campb303 closed this as completed Apr 4, 2021
v1.0 automation moved this from In progress to Done Apr 4, 2021
Sign in to join this conversation on GitHub.
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
Development

No branches or pull requests

1 participant