adapt-security / adapt-authoring-api Goto Github PK

Applies to all AbstractApiModules.

• Query string for options:
  • page
  • limit
  • skip
• Body data for query
• Return headers
  • X-Adapt-Page: current page of results
  • X-Adapt-PageTotal: total number of pages for current query
  • Link: standard link header for requesting further pages (see MDN docs)

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

What happened?

If a course has more than 100 models the server will only return the first 100 and not indicate that there is more data. The X-Adapt-PageTotal header only indicates 1 page.

Expected behaviour

X-Adapt-PageTotal should indicate to the client how many pages of data there are.

Steps to reproduce

Create a course with more than 100 models and inspect the /api/content/query headers. I can provide an example course with more than 100 models if required.

Authoring tool version

master

Framework version

No response

What browsers are you seeing the problem on?

No response

Relevant log output

No response