Skip to content
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

Add condition for 401 on invalid key and changelog on API Guide #10127

Merged
merged 7 commits into from
Nov 17, 2023

Conversation

jp-tosca
Copy link
Contributor

@jp-tosca jp-tosca commented Nov 17, 2023

What this PR does / why we need it:

Which issue(s) this PR closes:

Special notes for your reviewer:
n/a
Suggestions on how to test this:
n/a
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
n/a
Is there a release notes update needed for this change?:
Probably we could add that now we have a changelog for the API in the general notes.

Additional documentation:

https://dataverse-guide--10127.org.readthedocs.build/en/10127/api/changelog.html

@jp-tosca jp-tosca added Type: Feature a feature request Type: Bug a defect Size: 3 A percentage of a sprint. 2.1 hours. labels Nov 17, 2023
@coveralls
Copy link

coveralls commented Nov 17, 2023

Coverage Status

coverage: 19.996%. remained the same
when pulling 70edaa7 on jp-tosca:10070-api-doc-changelog
into 8d8f35f on IQSS:develop.

Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left some feedback.

Can we have this PR also close the following issue?

doc/sphinx-guides/source/api/changelog.rst Outdated Show resolved Hide resolved
doc/sphinx-guides/source/api/changelog.rst Outdated Show resolved Hide resolved
@scolapasta scolapasta added this to the 6.1 milestone Nov 17, 2023
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A tiny comment on style/formatting.

doc/sphinx-guides/source/api/changelog.rst Outdated Show resolved Hide resolved
jp-tosca and others added 2 commits November 17, 2023 11:38
Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>
Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added more detail as a suggestion.

doc/sphinx-guides/source/api/changelog.rst Outdated Show resolved Hide resolved
@pdurbin
Copy link
Member

pdurbin commented Nov 17, 2023

In 640f69e I added a release note snippet about the new API changelog.

jp-tosca and others added 2 commits November 17, 2023 14:55
Co-authored-by: Philip Durbin <philip_durbin@harvard.edu>
@pdurbin
Copy link
Member

pdurbin commented Nov 17, 2023

Tests are passing: https://jenkins.dataverse.org/job/IQSS-Dataverse-Develop-PR/job/PR-10127/4/testReport/

@landreev and @scolapasta are good with the changes as well. Merging.

Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@pdurbin pdurbin merged commit 9186b06 into IQSS:develop Nov 17, 2023
9 checks passed
@jp-tosca jp-tosca deleted the 10070-api-doc-changelog branch February 18, 2024 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Size: 3 A percentage of a sprint. 2.1 hours. Type: Bug a defect Type: Feature a feature request
Projects
Status: No status
4 participants