Repository navigation
Conversation
…tions via API (no superuser)
Add source-level OpenAPI annotations across Dataverse REST resources, including class tags, operation summaries/descriptions, parameter and request-body docs, API key security metadata, and response schema fixes for generated OpenAPI/MCP tooling. IQSS#12437 describes this effort in more details
Enable DataverseOpenApiFilter in the SmallRye OpenAPI Maven generation and add the filter implementation to normalize generated API docs after annotation scanning. The filter adds the Dataverse API key security scheme, rewrites selected Access download responses as binary wire payloads instead of internal writer helper schemas, removes a known circular schema back-reference, and prunes component schemas no longer reachable from public operations.
Update Dataverse REST API source annotations to make the generated OpenAPI document more complete and better aligned with the vacuum linter ruleset. See scripts/openapi/README.md for running vacuum. Add missing operation summaries, parameter descriptions, request body descriptions, security requirements, response metadata, and schema descriptions across API resources and exposed DTO/model classes. Refine binary response schemas and remove duplicate API key security scheme metadata.
# Conflicts: # src/main/java/edu/harvard/iq/dataverse/api/Access.java # src/main/java/edu/harvard/iq/dataverse/api/Datasets.java # src/main/java/edu/harvard/iq/dataverse/api/Dataverses.java # src/main/java/edu/harvard/iq/dataverse/api/Guestbooks.java
Move DataverseApiKey OpenAPI security generation into DataverseOpenApiFilter and remove duplicated @securityrequirement annotations from API resources. The filter now derives operation security from @AuthRequired while preserving generated securitySchemes metadata.
Bumps [actions/cache](https://github.com/actions/cache) from 5 to 6. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](actions/cache@v5...v6) --- updated-dependencies: - dependency-name: actions/cache dependency-version: '6' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com>
Updated the doc to include the requirements that the user must comply before creating an Anonymous Preview URL.
…cess Now reading 6.12-...
…ions/cache-6 chore(deps): bump actions/cache from 5 to 6
…-image-bug Featured Items API can now retrieve images for creator
…for-JSONbuilders Introduce factory method for Json-P Builders
…hub/codeql-action-4.37.4 chore(deps): bump github/codeql-action from 4 to 4.37.4
…e-stats-fix Fix pagination stats for Guestbook Responses
Fix conflict in FilesIT with Json.create vs JsonUtil.create
3 tasks
…ncy-api 'API inconsistency for release time between JsonParser and JsonPrinter
Updated the release notes for Dataverse 6.10 to include the request timeout setting migration step.
update security docs
remove QA Guide
Revise upgrade instructions for request timeout setting
Member
|
@ffritze hi! Thanks for the pull request. I switched to a draft because (as you say), it targets master and we don't merge PRs into master. Like @jggautier mentioned in the linked issue, it should target develop. Also, can you please look at DDIExporterTest? Tests are failing in there. |
add release note snippet for http request timeout
…taverse_topicClassTermURI
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+168
to
+184
| needs: integration-test | ||
| name: Check for Secrets Availability | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| available: ${{ steps.secret-check.outputs.available }} | ||
| steps: | ||
| - id: secret-check | ||
| # perform secret check & put boolean result as an output | ||
| shell: bash | ||
| run: | | ||
| if [ "${{ secrets.SONAR_TOKEN }}" != '' ]; then | ||
| echo "available=true" >> "$GITHUB_OUTPUT"; | ||
| else | ||
| echo "available=false" >> "$GITHUB_OUTPUT"; | ||
| fi | ||
|
|
||
| sonarcloud: |
Contributor
Author
|
I will handle the failing test soon. Meanwhile I have merged dataverse/develop in my branch. Should I create a new pull request for develop or can I make the changes in this one here switching to develop and discarding the DRAFT state? |
Member
|
@ffritze new PR, please! Hopefully with fewer commits. 😄 Thanks!! |
Contributor
Author
|
I will close it. |
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
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.
What this PR does / why we need it:
It adds a valueURI attribute for topicClassification subjects in the exporter implementation.
Which issue(s) this PR closes:
#10736 (comment)
Special notes for your reviewer:
I developed it on dataverse6.11. I decided to use your master branch instead of develop because on develop you wouldn't see easily what simpe changes I have made.
Suggestions on how to test this:
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Is there a release notes update needed for this change?:
Additional documentation: