Refactor OpenAPI spec: deduplicate into shared components#2
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
Refactor OpenAPI spec: deduplicate into shared components#2devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
…meters, and schemas - Extract 5 shared responses (UnauthorizedResponse, BadRequestResponse, NotFoundResponse, EmptyResultResponse, StoreItemListResponse) replacing 16 inline 401, 13 inline 400, and 9 inline EmptyResult response blocks - Extract 5 shared request bodies (UserModelBody, StoreItemBody, BuyProductReqBody, TransactionDBModelBody, NewImageModelBody) eliminating 11 repeated content-type triplets - Extract shared PathId parameter used by 3 endpoints - Consolidate DataTableResp base schema using allOf composition, deduplicating recordsTotal/recordsFiltered across TransactionRespDataTableResp and AdminUserInfoRespDataTableResp - Extract StoreItemListResponse shared by AdminStore and Store endpoints Net reduction: 123 lines (1211 -> 1088), removing 356 lines of duplication and adding 233 lines of shared component definitions. Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Eliminates pervasive duplication in the BankWeb OpenAPI spec by extracting repeated patterns into reusable
components/definitions. Net reduction: 123 lines (1211 → 1088), replacing 356 lines of inline duplication with 233 lines of shared definitions.Shared responses (
components/responses/)UnauthorizedResponse— replaces 16 inline401blocksBadRequestResponse— replaces 13 inline400blocksEmptyResultResponse— replaces 9 inline200+EmptyResultblocksStoreItemListResponse— shared byAdminStore/GetStoreItemsandStore/GetStoreItemsNotFoundResponse— replaces inline404blockShared request bodies (
components/requestBodies/)UserModelBody— used by 5 endpoints (Login, Register, PasswordRecovery, Recover, ContactUs)StoreItemBody— used by 3 endpoints (Create, Edit, DeleteStoreItem)BuyProductReqBody,TransactionDBModelBody,NewImageModelBodyEach eliminates the repeated
application/json+text/json+application/*+jsoncontent-type triplet.Shared parameter (
components/parameters/)PathId—{id}path param shared byAdminStore/Get/{id},AdminStore/Edit/{id},Transaction/Get/{id}Schema consolidation
Previously these two schemas duplicated the
recordsTotal/recordsFilteredwrapper; now they compose viaallOffrom a sharedDataTableRespbase.Link to Devin session: https://app.devin.ai/sessions/e02d6a21c64e466aa756e4f36c06d313
Requested by: @wsh92