add dynamicRef/generic support for collections when openapi 3.1 is supported

Open
#461 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
csharp
Domain
api

Research direction

Start by reviewing the collection response schema generation and the repository's OpenAPI 3.1 support. Define the generic base collection types and dynamicRef behavior, then verify that the generated document no longer needs the many resource-specific collection schemas.

Written by the indexing model from the issue text.

Description

blocked type:enhancement

today we implement collections as:

  • BaseCollectionResponse (Odata next link field, etc...)
  • BaseCounCollectionResponse (inherits from the previous, add the count field)
  • A lot of Users/Groups/Sites/...Collection response (inherits from one of the previous, adds the value property)

With the advent of OpenAPI 3.1 support we could get rid of all the UsersCollectionResponse schemas (about 4k in v1) and make the base types generic.

Dominant language
C#
Stars
240
Forks
70
Avg merge
7h 59m
Merged PRs (30d)
13

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.

More from microsoft/OpenAPI.NET.OData

All issues in microsoft/OpenAPI.NET.OData

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.