Remove POST operations and add Pet Store-style theming#3
Merged
Conversation
Removed all POST operations as requested - API now only contains GET operations. Enhanced documentation styling to match Pet Store OpenAPI appearance. Changes: - Removed POST operations from Batch_Bulk and Batch_RetailCustomer endpoints - Added Pet Store-inspired color scheme with Green Button green (#10a54a) - Enhanced typography with Open Sans and Montserrat fonts - Styled sidebar, panels, and HTTP methods - Added logo configuration placeholder (add logo.png file to project root) - Improved code sample styling Theming updates: - Primary color: Green Button green - Custom HTTP method colors (GET is green-themed) - Dark code panel with light sidebar - Professional typography hierarchy To add logo: - Place logo.png file in project root - Uncomment logo configuration in redocly.yaml Validation: Passes npm test with zero errors Build: Successfully generates 994 KiB documentation (down from 1007 KiB) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
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
Removes all POST operations from the API and adds Pet Store-inspired styling to make the documentation more visually appealing and professional.
Changes Made
1. Removed POST Operations
✅ Removed POST from
Batch_Bulk_{bulkId}endpoint (uploadBulkData operation)✅ Removed POST from
Batch_RetailCustomer_{retailCustomerId}_UsagePointendpoint (uploadMyData operation)API is now GET-only as requested.
2. Enhanced Styling (Pet Store-Inspired)
Color Scheme:
Typography:
UI Elements:
3. Logo Configuration
Added logo configuration in
redocly.yaml:To add logo:
logo.pngfile in project rootsrcandlinklines in redocly.yamlVisual Improvements
The documentation now features:
File Changes
openapi/paths/Batch_Bulk_{bulkId}.yaml(-32 lines)openapi/paths/Batch_RetailCustomer_{retailCustomerId}_UsagePoint.yaml(-32 lines)redocly.yaml(+37 lines)Total: 3 files changed, 37 insertions, 64 deletions
Validation
✅
npm test- Passes with zero errors✅
npm run build- Successfully generates 994 KiB documentation (reduced from 1007 KiB)Preview
The documentation will have:
Sources:
Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com