NIAD-3234: endpoint docs update #1024
Conversation
| parameters: | ||
| - name: request | ||
| in: query | ||
| required: true | ||
| schema: | ||
| $ref: '#/components/schemas/EhrStatusRequestQuery' |
There was a problem hiding this comment.
For my understanding, is this saying you can pass the filtering parameters in via query parameters? Also it's a bit strange it's marked as required, given that I don't think I've ever used the /requests endpoint in this way. 🤔
| toAsid: "200000000359" | ||
| fromOdsCode: "P883302" | ||
| toOdsCode: "P113302" | ||
| required: true |
There was a problem hiding this comment.
Hmm, I'm pretty sure I've also called this endpoint without specifying a request body and it's worked. 🤔
| Any "in-progress" transfers are excluded from this list, but become available once they either succeed or fail. | ||
|
|
||
| Requests can be made to the following endpoint, where each attribute within the JSON POST body is an optional filter criteria. |
There was a problem hiding this comment.
Related to my comments below about required, this comment reaffirms my understanding which is that the filtering is optional.
There was a problem hiding this comment.
ok, I see, make sense, I will look into it and adjust it
There was a problem hiding this comment.
I think as object it is required but EhrStatusRequestQuery object has fields which are not mandatory and can be empty.
|
Looks good. No mutations were possible for these changes. |
|
What
Endpoints documentation update
Why
The documentation must remain synchronized with the code implementation to ensure accuracy, clarity, and ease of use. This alignment minimizes confusion, reduces the risk of errors during integration, and provides developers with reliable information to effectively utilize the API.
Type of change
Please delete options that are not relevant.
Checklist: