PCSM-167 Updated the pcsm status output #15
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the API documentation for the PCSM status output to reflect changes in field names and structure. The changes primarily involve renaming fields for clarity and restructuring the lastReplicatedOpTime field.
Key changes:
- Renamed metrics fields to be more descriptive (e.g.,
lagTime→lagTimeSeconds,eventsProcessed→eventsRead/eventsApplied) - Changed
lastReplicatedOpTimefrom a simple string to an object containing both timestamp and ISO date - Updated example response to reflect the new field structure
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/api.md
Outdated
| | `lagTimeSeconds` | number | Current lag time in logical seconds between source and target clusters. | | ||
| | `eventsRead` | number | Total number of events read from the source | | ||
| | `eventsApplied` | number | Total number of events applied to the target | | ||
| | `lastReplicatedOpTime` | string | The last replicated operation time. It includes both the time stamp and its human-readable representation | |
There was a problem hiding this comment.
The type is documented as 'string' but the example shows it as an object with 'ts' and 'isoDate' fields. Update the type to 'object' to match the actual structure.
| | `lastReplicatedOpTime` | string | The last replicated operation time. It includes both the time stamp and its human-readable representation | | |
| | `lastReplicatedOpTime` | object | The last replicated operation time. Object with `ts` (timestamp) and `isoDate` (human-readable date) fields. | |
There was a problem hiding this comment.
What do you think that we add ts and isoDate fields as separate, like
lastReplicatedOpTime.tslastReplicatedOpTime.isoDate
Just like we have for initialSync object.
| | `eventsApplied` | number | Total number of events applied to the target | | ||
| | `lastReplicatedOpTime` | string | The last replicated operation time. It includes both the time stamp and its human-readable representation | | ||
| | `initialSync.completed` | boolean | Initial sync completion status | | ||
| | `initialSync.lagTime` | number | The lag time in logical seconds until the initial sync completed| |
There was a problem hiding this comment.
The field initialSync.lagTime is documented but not shown in the example response. Either add it to the example or remove from documentation if it's no longer supported.
No description provided.