Azure / Azure/openapi-diff

OpenAPI-diff should flag changes in the tags for an operation

Open
#371 7 comments 0 reactions 1 assignee Claimed by @mikeharder View on GitHub
Dominant language
C#
Stars
290
Forks
50
Avg merge
5d 13h
Merged PRs (30d)
5

Description

Some tooling uses the operation tags to group or namespace the operations in an API definition. SwaggerUI is one example, but many other tools do as well.

For this reason, OpenAPI diff should detect and report any change in the array of tags specified for an operation. The message should be a warning since this change does not impact the "on the wire" behavior of the API.

A real-life example that tripped up Terraform generation is [#34736](https://github.com/Azure/azure-rest-api-specs/pull/34736).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.