abpframework / abpframework/abp
REST API Versioning Improvements
Open
Nobody has claimed this yet.
abp-framework
feature
priority:low
- Dominant language
- C#
- Stars
- 14.4k
- Forks
- 3.7k
- Avg merge
- 15h 32m
- Merged PRs (30d)
- 106
Description
- [Obsolete] can be used to deprecate a method/class within a version.
- Add XML summaries to swagger definition (it's already possible, but find a flexible way)
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 locating the REST API versioning implementation and the Swagger definition integration in the repository. Determine how [Obsolete] should apply within a version and how XML summaries can be supplied flexibly. Done means both checklist items are implemented and covered by the relevant API or Swagger behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100