Azure / Azure/azure-functions-openapi-extension

Ordering tags alphanumerically

Open
#636 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
388
Forks
202
PR merge metrics
No merged PRs in 30d

Description

Building a c# Azure functions API, using .Net8, isolated. v1.5.1 of the OpenApi package

I have about 13 endpoints and 6 tags, where some endpoints are under more then 1 tag. The endpoints are in 4 separate classes, for various resons.

The order the tags are displayed on the swagger ui seems to be somewhat related to the order they are encountered in the code but in no way is it alphanumerically ordered. I even tried to add numbers at the start of the tags but this did not change the order the tags were displayed.

There should be a way to control this, and the default should be alphanumerically I think.

Similar to [issue 339](https://github.com/Azure/azure-functions-openapi-extension/issues/339)

Contributor guide

Open the contributing guide

Research direction

Reproduce the ordering with a C# Azure Functions isolated .NET 8 app using the OpenAPI package, with endpoints spread across classes and multiple tags. Trace how tags reach Swagger UI; done should mean a deterministic alphanumeric default or a documented way to configure the order.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, csharp, openapi
Domain
api, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.