Azure / Azure/azure-sdk-tools

[APIView] Support Forcing APIView Revision in More Scenarios

Open
#3,286 5 comments 0 reactions 0 assignees View on GitHub
APIView feature-request
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
144

Description

While reviewing the Java Core API views this month I noticed that many of the API views haven't been updated for a few weeks. From discussions with @praveenkuttappan I was informed that a new API view will only be generated if a meaningful difference has been made. At least for Java, changing dependency versions isn't a meaningful difference (one that'll require approval before releasing) and for many libraries that will be the only difference that may occur for months. Unfortunately, this means useful information may be lost and could result in confusing API views to exist. For example [azure-core-serializer-json-jackson](https://apiview.dev/Assemblies/Review/83768c0e56094634b973c8de003c09de/7702690237e743cdb7134c4534280611?diffRevisionId=b9f6537c29444b88900bb3b1ef76c64c&doc=False&diffOnly=True) looks like it has had a recent API difference but looking at API view metadata and knowing the library it has been API stable for a few months, only receiving dependency updates.

My request is that API view should support more granular updating, instead of checking for a meaningful difference to update the latest API view it should be any difference in what is generated. So, for Java this would mean that upgrading dependencies would cause a new API view, to give reviewers the most up-to-date information as possible.

Contributor guide

Open the contributing guide

Research direction

No files or tests are named. Start by locating the Java API view generation path and the meaningful-difference check described in the issue; done means dependency-only generated changes can produce a new revision so reviewers see current API view information.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Feature
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.