Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document req.apiData #4

Open
taylortom opened this issue Feb 25, 2022 · 0 comments
Open

Document req.apiData #4

taylortom opened this issue Feb 25, 2022 · 0 comments
Labels
documentation Requires docs to be written

Comments

@taylortom
Copy link
Collaborator

taylortom commented Feb 25, 2022 •
edited
Loading

AbstractApiModule adds a load of extra data to the request for use in handlers. This needs to be fully documented. Not sure of the best way to do this, possibly an API ref + a doc page, possibly just a doc page with examples.

  • config
    • route
    • modifying/modifiers
    • handlers
    • permissions
  • collectionName
  • data (body)
  • query (params + query)
  • schemaName
  • modifying

Notes

  • For /query route, options should be passed as querystring, with the query as the body
@taylortom taylortom added the documentation Requires docs to be written label Feb 25, 2022
@taylortom taylortom transferred this issue from adapt-security/adapt-authoring Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Requires docs to be written
Projects
adapt-authoring: The TODO Board
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@taylortom