Azure / Azure/azure-sdk-tools

[ApiView] Change in operationId should not look like entire operation was deleted and added

Open
#4,739 3 comments 0 reactions 0 assignees View on GitHub
APIView Swagger
Dominant language
C#
Stars
135
Forks
260
Avg merge
3d 1h
Merged PRs (30d)
143

Description

In the APIView for [PR 21240](https://github.com/Azure/azure-rest-api-specs/pull/21240), in the diff from revision 0 to revision 1

https://apiview.dev/Assemblies/Review/403f16af88e945baba69c06c0c445bea?diffRevisionId=06f379cd9bfe4f479a50d6efd1c14837&diffOnly=False&revisionId=dee606fa43c04080b8a89bb7cf31fa7b&doc=False

The GET on /linkconnections, and PUT, GET, and DELETE on /linkconnections/{linkConnectionName} _look like_ the entire operation is deleted and then re-added.

image

But in fact the only changes that happened in these operations was that the operationId changed.
```
34c34
< "operationId": "LinkConnection_ListLinkConnectionsByWorkspace",
---
> "operationId": "LinkConnection_ListByWorkspace",
70c70
< "operationId": "LinkConnection_CreateOrUpdateLinkConnection",
---
> "operationId": "LinkConnection_CreateOrUpdate",
113c113
< "operationId": "LinkConnection_GetLinkConnection",
---
> "operationId": "LinkConnection_Get",
147c147
< "operationId": "LinkConnection_DeleteLinkConnection",
---
> "operationId": "LinkConnection_Delete",
```

It would be really nice if APIView would show that only the operationId was changed in these situations.

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the linked APIView diff for PR 21240, comparing revisions 0 and 1. Trace how APIView matches operations when only operationId changes; done when those examples show an operationId field change rather than a deletion followed by an addition. The issue names no source files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Bug
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.