EES-5934 Fixing Admin Public API Data Set Changelog page #5705
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
leeoades
reviewed
Mar 20, 2025
| @@ -73,6 +75,31 @@ public async Task<Either<ActionResult, PaginatedListViewModel<DataSetLiveVersion | |||
| }); | |||
| } | |||
|
|
|||
| public async Task<Either<ActionResult, DataSetVersionInfoViewModel>> GetDataSetVersion( | |||
There was a problem hiding this comment.
You don't want to call this GetDataSetVersionInfo ?
| @@ -267,7 +280,7 @@ private async Task<DataSetVersionSummaryViewModel> MapDraftVersionSummary( | |||
| }; | |||
| } | |||
|
|
|||
| private async Task<Either<ActionResult, DataSetVersion>> GetDataSetVersion( | |||
| private async Task<Either<ActionResult, DataSetVersion>> GetVersion( | |||
There was a problem hiding this comment.
I don't think this naming makes sense as it isn't returning a version.
Comment on lines
+25
to
+26
| const dataSetVersionIsDraft = (dataSetVersionStatus: DataSetVersionStatus) => | ||
| dataSetVersionStatus === 'Draft'; |
There was a problem hiding this comment.
NIT: seems a bit verbose, where we set isDraft this is fine
const isDraft = dataSetVersion?.status === 'Draft'
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.
Previously, when an admin visited the Public API version history page for a particular API data set, and clicked to view the changelog for versions
1.1and above, they were sometimes displayed with the incorrect version number and version 'type' (Major/Minor).This was because the frontend had some logic which only ever showed the version number and type for either the latest live version of the data set, or the current draft version, depending on whether or not the version you selected is the draft one or not. It didn't display the details for the version you have specifically requested (caveat - it DID do this sometimes, but only by coincidence).
For example, previously, the changelog page for the following versions showed:
2.0-> Displayed2.0Major-> CORRECT (Coincidentally)1.2-> Displayed2.0Major-> INCORRECT1.1-> Displayed2.0Major-> INCORRECT1.0-> Can't access the changelog page for the first versionThis PR makes the changes necessary for the page to retrieve the data it needs specific to the requested data set version. We have introduced a new Admin API
GETendpoint for this, for the Data Set Version.