IQSS / IQSS/dataverse

Request: Extend API Changelog to list all changes since v4.20

Open
#10,362 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: API Feature: API Guide Help Wanted: Documentation Size: 10 User Role: API User
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

Overview of the Feature Request

With the API changelog introduced in #10060 we now have a place to list important changes to the API.
We should go through the release notes since and including v4.20 to list important events like APIs added, deprecated, broken, fixed, etc.

What kind of user is the feature intended for?
API User

What inspired the request?
#10060 as well as users asking for such an overview.

What existing behavior do you want changed?
None

Any brand new behavior do you want to add to Dataverse?
Nope

Any open or closed issues related to this feature request?

  • #10060
  • #9549
  • #9544
  • #5724

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the API changelog introduced in #10060 and the release notes from v4.20 onward. Identify important API additions, deprecations, breakages, and fixes, then add them to the changelog; done means the requested historical coverage is complete and each entry is accurate.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.