feat: feedback API v1#211
Open
heyalexej wants to merge 1 commit into
Open
Conversation
Add the Commerce Feedback API (commerce/feedback/v1): - getItemsAwaitingFeedback, getFeedback, leaveFeedback, getFeedbackRatingSummary, respondToFeedback - OpenAPI spec + generated types (redocly + openapi-typescript) - Wired into ApiFactory and the Commerce group - Contract test added; README implementation status updated
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
Adds the Commerce Feedback API (
commerce/feedback/v1), accessible viaeBay.commerce.feedback. It mirrors the structure of the Message API (feat: message API v1).Methods:
getItemsAwaitingFeedbackgetFeedbackleaveFeedbackgetFeedbackRatingSummaryrespondToFeedbackChanges
specs/commerce_feedback_v1_beta_oas3.json, configured inredocly.yaml, generated types viaopenapi-typescript.Feedbackclass (src/api/restful/commerce/feedback/index.ts) extendingRestfuland implementingOpenApi<operations>.LeaveFeedbackRequestandRespondToFeedbackRequestfromrestfulTypes.ApiFactory.createCommerceApi()and theCommercegroup type/exports.test/api/restful/commerce/index.ts); updated the README implementation status.Testing
npm test→ 1373 passing (includes the new Feedback OAS contract tests).npm run lintandtsc --noEmitclean (noUnusedLocals/noUnusedParametersrespected).getFeedback,getFeedbackRatingSummary,getItemsAwaitingFeedback) andleaveFeedbackend-to-end.Usage: