ERS-32863: Preparing documentation for soon to be externalized report events #1410
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
RoseWyatt
changed the title
RoseWyatt
commented
Apr 14, 2025
| | `lastModifiedDate` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | | ||
| | `href` | `string` | RFC 3986 | URI of the report resource that can be called via the Expense v4 API. | | ||
|
|
||
| ### Report Updated Event Schema |
There was a problem hiding this comment.
Start of newly added event tables.
RoseWyatt
commented
Apr 14, 2025
| | `reportId` | `String` | `Alphanumeric` | **Required** Unique identifier of the newly created expense report. Maximum characters: 20 | | ||
| | `reportType` | `String` | `Enum` | **Required** This value identifies the method used to create the report. Supported values: <br>Regular, <br>Reconciliation, <br>Statement, <br>AutoCreated | | ||
| | `lastModifiedDate` | `timeStamp` | RFC 3339 | **Required** Current system time (UTC) when the event notification is issued. | | ||
|
|
There was a problem hiding this comment.
End of newly added event tables.
RoseWyatt
commented
Apr 14, 2025
| | `route` | `String` | `String` | For internal use. This will be set to stable. | | ||
| | `topic` | `String` | `Enum` | **Required** Identifies the topic that the event belongs to `public.concur.expense.report`. | | ||
| | `eventType` | `String` | `String` | **Required** Event Type: `reportCreated` - Identifies the event type on the topic. | | ||
| | `subtopic` | `UUID` | RFC 4122 | **Required** Unique identifier of the company the report belongs to. | |
There was a problem hiding this comment.
Corrected, this is populated by company ID for report created events.
Only status changed events populate subtopic with report ID.
|
Keeping this as a draft until reviewed by my project manager. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR's primary goal is to add documentation for the soon to be externalized Report Updated and Report Deleted events.
Additional tweaks: