microsoft / microsoft/OpenAPI.NET.OData
add dynamicRef/generic support for collections when openapi 3.1 is supported
Open
Nobody has claimed this yet.
blocked
type:enhancement
- Dominant language
- C#
- Stars
- 240
- Forks
- 70
- Avg merge
- 7h 59m
- Merged PRs (30d)
- 13
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- csharp
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100