-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
EES-4913 Allow preview access to Public API data sets #5133
Conversation
This file contains 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
c13807c
to
71aad21
Compare
ntsim
reviewed
Aug 21, 2024
src/GovUk.Education.ExploreEducationStatistics.Common/Extensions/HttpContextExtensions.cs
Show resolved
Hide resolved
src/GovUk.Education.ExploreEducationStatistics.Common/Extensions/HttpRequestExtensions.cs
Outdated
Show resolved
Hide resolved
...ploreEducationStatistics.Public.Data.Api.Tests/Controllers/DataSetVersionsControllerTests.cs
Outdated
Show resolved
Hide resolved
...ploreEducationStatistics.Public.Data.Api.Tests/Controllers/DataSetVersionsControllerTests.cs
Outdated
Show resolved
Hide resolved
...ploreEducationStatistics.Public.Data.Api.Tests/Controllers/DataSetVersionsControllerTests.cs
Outdated
Show resolved
Hide resolved
...ploreEducationStatistics.Public.Data.Api.Tests/Controllers/DataSetVersionsControllerTests.cs
Outdated
Show resolved
Hide resolved
...ovUk.Education.ExploreEducationStatistics.Public.Data.Api/Security/RequestHeaderConstants.cs
Outdated
Show resolved
Hide resolved
...ovUk.Education.ExploreEducationStatistics.Public.Data.Api/Security/RequestHeaderConstants.cs
Outdated
Show resolved
Hide resolved
...ovUk.Education.ExploreEducationStatistics.Public.Data.Api/Security/RequestHeaderConstants.cs
Outdated
Show resolved
Hide resolved
86a932c
to
4df8277
Compare
ntsim
reviewed
Aug 23, 2024
...cs.Public.Data.Api/Security/AuthorizationHandlers/QueryDataSetVersionAuthorizationHandler.cs
Outdated
Show resolved
Hide resolved
...ics.Public.Data.Api/Security/AuthorizationHandlers/ViewDataSetVersionAuthorizationHandler.cs
Outdated
Show resolved
Hide resolved
ntsim
approved these changes
Aug 23, 2024
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 adds preview access to Public API data set version data using preview tokens.
A preview token can be set for a request using a HTTP request header
Preview-Token
.It makes a change to the two authorisation handlers associated with the guards
IUserService.CheckCanQueryDataSetVersion
andIUserService.CheckCanViewDataSetVersion
. They now ensure a valid preview token is present in the request before succeeding where they would have otherwise failed due to the version being in an inaccessible status.A preview token is valid for the
DataSetVersion
in the context of the request if there exists aPreviewToken
entity with matchingId
, which is not expired, and the token has been issued for the sameDataSetVersion
which must also be inDraft
status.Example usage
Get a data set version
Get a data set version's changes
Get a data set’s metadata
Query a data Set
Example for (POST) method but preview tokens can also be used to query a data set (GET).