Skip to content

Conversation

@dfcoffin
Copy link

@dfcoffin dfcoffin commented Feb 7, 2026

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}_UsagePoint endpoint (uploadMyData operation)

API is now GET-only as requested.

2. Enhanced Styling (Pet Store-Inspired)

Color Scheme:

  • Primary color: Green Button green (#10a54a)
  • Success color: Green Button green
  • HTTP GET operations: Green-themed
  • Dark code panel (#263238) with light sidebar (#fafafa)

Typography:

  • Body: Open Sans, 16px
  • Headings: Montserrat, 600 weight
  • Code: Source Code Pro, 14px

UI Elements:

  • Sidebar: Light gray background with green active items
  • Right panel: Dark background for code samples
  • Professional color-coded HTTP methods

3. Logo Configuration

Added logo configuration in redocly.yaml:

logo:
  gutter: 20px
  # To add logo: Place logo.png in project root and uncomment below
  # src: ./logo.png
  # link: https://www.greenbuttonalliance.org/

To add logo:

  1. Place logo.png file in project root
  2. Uncomment the src and link lines in redocly.yaml
  3. Rebuild documentation

Visual Improvements

The documentation now features:

  • ✅ Clean, modern Green Button-themed color palette
  • ✅ Professional typography with proper font hierarchy
  • ✅ Green-themed GET operations matching Green Button branding
  • ✅ Improved readability with better spacing and contrast
  • ✅ Pet Store-style layout and structure

File Changes

  • Modified: openapi/paths/Batch_Bulk_{bulkId}.yaml (-32 lines)
  • Modified: openapi/paths/Batch_RetailCustomer_{retailCustomerId}_UsagePoint.yaml (-32 lines)
  • Modified: 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:

  • Green Button green as the primary accent color
  • Professional, readable typography
  • Clean sidebar navigation
  • Dark code samples panel
  • GET-only API operations

Sources:

Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com

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>
@dfcoffin dfcoffin merged commit 0920755 into main Feb 7, 2026
2 checks passed
@dfcoffin dfcoffin deleted the feature/remove-post-add-styling branch February 7, 2026 05:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant