You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The existing documentation is good as far as it goes, but leaves out a lot of context. To illustrate more fully how the library is to be used, we need to make clear that the library is essentially used to create a (very simple) API.
This means we need to lay out a straightforward sequence for developers walking them through from receiving the request to returning the response. We thus need steps, with examples, illustrating:
Receiving a request
Parsing the request for parameters
Querying the database
Using the query results to create data items
Sequencing these data items
Wrapping up these data items as an RPDE feed
Serialising the RPDE feed to JSON
Returning this JSON as a response
The text was updated successfully, but these errors were encountered:
The existing documentation is good as far as it goes, but leaves out a lot of context. To illustrate more fully how the library is to be used, we need to make clear that the library is essentially used to create a (very simple) API.
This means we need to lay out a straightforward sequence for developers walking them through from receiving the request to returning the response. We thus need steps, with examples, illustrating:
The text was updated successfully, but these errors were encountered: