-
Notifications
You must be signed in to change notification settings - Fork 505
add API for getting application terms of use #11422
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
Open
pdurbin
wants to merge
8
commits into
develop
Choose a base branch
from
11415-app-tou
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
It looks like this now: /info/applicationTermsOfUse: get: tags: - info operationId: Info_getApplicationTermsOfUse parameters: - name: lang in: query description: Two-character language code. required: false schema: type: string example: en responses: "200": description: Application Terms of Use (General Terms of Use) that must be agreed to at signup.
📦 Pushed preview images as
🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
FY25 Sprint 21
FY25 Sprint 21 (2025-04-09 - 2025-04-23)
Original size: 10
Size: 10
A percentage of a sprint. 7 hours.
SPA.Q2.7
Implement installation terms of use in account linking
Type: Feature
a feature request
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.
What this PR does / why we need it:
Client apps such as the SPA need to be able to retrieve the terms we present to users at signup.
Which issue(s) this PR closes:
Special notes for your reviewer:
It's sort of annoying that we call it
:ApplicationTermsOfUse
in the database but "General Terms of Use" in the UI. 🤷I followed this: https://guides.dataverse.org/en/6.6/developers/api-design.html#exposing-settings (from #9890).
I'm aware that to PUT we use
/lang/fr
but to GET I used&lang=fr
because it felt more natural. The PUT side was added in #6042.I made an effort to make the entry in
/openapi
useful. Here's how it looks:I cleaned up existing docs, including changing "Supported HTML Fields" to "Supported HTML Tags" while I was in there.
Suggestions on how to test this:
Try it with and without internationalization configured. Not that without the "lang" column in the "setting" table isn't used.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No.
Is there a release notes update needed for this change?:
Yes, added.
Additional documentation:
Included. Here's a good starting point: https://dataverse-guide--11422.org.readthedocs.build/en/11422/api/native-api.html#get-application-terms-of-use-general-terms-of-use