Create v4.expense-cash-advance-associations.markdown #1402
Conversation
src/api-reference/expense/expense-report/v4.expense-cash-advance-associations.markdown
Outdated
Show resolved
Hide resolved
| * [403 Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3) | ||
| * [404 Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4) | ||
| * [500 Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | ||
|
|
There was a problem hiding this comment.
Need Payloads section with link to CashAdvancesResponse schema
There was a problem hiding this comment.
Might be worth checking the old pages, I don't see any on https://github.com/SAP-docs/preview.developer.concur.com/blob/main/src/api-reference/expense/expense-report/expense-entry.markdown
There was a problem hiding this comment.
That's the v3 markdown. Check the v4 pages. https://github.com/SAP-docs/preview.developer.concur.com/blob/main/src/api-reference/expense/expense-report/v4.expenses.markdown
There was a problem hiding this comment.
FYI... There's actually a template markdown. https://github.concur.com/developer/documentation/blob/master/documentation-template.md
It's not adhered to well, but I'm trying to address documentation consistency, within ERS as a minimum but hopefully globally across Spend, as part of the overall externalization / parity / devcenter enhancement exercise.
| ## Associate Cash Advances with Report | ||
|
|
||
| Associates the specified cash advance(s) with the specified report. | ||
|
|
There was a problem hiding this comment.
Need a clarification that the POST operation REPLACES any prior associations rather than add them as amendments.
Also it should also be clear that an individual bad/unrecognized CA Id will lead to a non-action with no change to any pre-existing association list.
There was a problem hiding this comment.
Also it should also be clear that an individual bad/unrecognized CA Id will lead to a non-action with no change to any pre-existing association list.
Isn't that explained in the Swagger Documentation with the description of
'
Invalid reportId, Invalid field value specified, Invalid Cash Advance Id
'
?
Need a clarification that the POST operation REPLACES any prior associations rather than add them as amendments.
Isn't that common usage of a POST in that it does a full replace of the object that is being sent?
There was a problem hiding this comment.
Minor typo on 111. Cash advances, not Cash advanced.
The REPLACES comment was something that came out of the design review. The group felt it would be better to make this explicitly clear.
The swagger simply says that 400=bad ID/404=ID not found. It doesn't explain that any single failure for a list of IDs will result in non-action for the entire list.
src/api-reference/expense/expense-report/v4.expense-cash-advance-associations.markdown
Show resolved
Hide resolved
|
|
||
| # Expense Cash Advance Associations v4.0 | ||
|
|
||
| The Expense Cash Advance Associations v4 API can be used for operations related to associating and dissociating cash advances with an expense report. |
There was a problem hiding this comment.
Use disassociate for consistency with DELETE endpoint.
src/api-reference/expense/expense-report/v4.expense-cash-advance-associations.markdown
Show resolved
Hide resolved
src/api-reference/expense/expense-report/v4.expense-cash-advance-associations.markdown
Show resolved
Hide resolved
src/api-reference/expense/expense-report/v4.expense-cash-advance-associations.markdown
Show resolved
Hide resolved
src/api-reference/expense/expense-report/v4.expense-cash-advance-associations.markdown
Show resolved
Hide resolved
| #### Request | ||
|
|
||
| ```shell | ||
| curl --request DELETE 'https://us.api.concursolutions.com/expensereports/v4/reports/764428DD6A664AF0BFCB/cashAdvances?cashAdvanceIds=3fa85f64-5717-4562-b3fc-2c963f66afa6?cashAdvanceIds=75e1fbe2-7de8-467f-9f6f-67073908459b' \ |
There was a problem hiding this comment.
This is slightly different than what is shown in the template, I can keep as a curl or change to how they show them.
There was a problem hiding this comment.
We have lots of examples with curl. I'm fine with this for now.
No description provided.