Skip to content

Conversation

@dfcoffin
Copy link

@dfcoffin dfcoffin commented Feb 8, 2026

Summary

Separates customer resources into individual documentation sections, matching the organization pattern used for energy resources. Previously, all customer resources were grouped under a single "Customer Data" section, making navigation difficult.

Changes

Tag Updates (openapi.yaml)

  • Before: Single Customer Resources tag for all customer endpoints
  • After: 9 individual tags, one per resource type:
    • Customer
    • CustomerAccount
    • CustomerAgreement
    • ServiceLocation
    • ServiceSupplier
    • EndDevice
    • Meter
    • Statement
    • ProgramDateIdMappings

Path File Updates (18 files)

Updated tag references in all customer resource path files:

  • Customer.yaml → uses Customer tag
  • Customer_{customerId}.yaml → uses Customer tag
  • CustomerAccount.yaml → uses CustomerAccount tag
  • CustomerAccount_{customerAccountId}.yaml → uses CustomerAccount tag
  • CustomerAgreement.yaml → uses CustomerAgreement tag
  • CustomerAgreement_{customerAgreementId}.yaml → uses CustomerAgreement tag
  • ServiceLocation.yaml → uses ServiceLocation tag
  • ServiceLocation_{serviceLocationId}.yaml → uses ServiceLocation tag
  • ServiceSupplier.yaml → uses ServiceSupplier tag
  • ServiceSupplier_{serviceSupplierId}.yaml → uses ServiceSupplier tag
  • EndDevice.yaml → uses EndDevice tag
  • EndDevice_{endDeviceId}.yaml → uses EndDevice tag
  • Meter.yaml → uses Meter tag
  • Meter_{meterId}.yaml → uses Meter tag
  • Statement.yaml → uses Statement tag
  • Statement_{statementId}.yaml → uses Statement tag
  • ProgramDateIdMappings.yaml → uses ProgramDateIdMappings tag
  • ProgramDateIdMappings_{programDateIdMappingsId}.yaml → uses ProgramDateIdMappings tag

x-tagGroups Update

Updated the Customer Data tag group to reference all 9 individual tags instead of the single parent tag.

Impact

Redocly Documentation: Customer resources now appear as 9 separate sections in the sidebar, matching the organization of energy resources (UsagePoint, MeterReading, IntervalBlock, etc.)

Swagger UI: Customer resources now appear as 9 separate sections, improving discoverability and navigation

Developer Experience: Easier to locate specific customer resource endpoints without scrolling through a single large section

Test Plan

  • OpenAPI spec validates successfully (npm test)
  • Documentation builds without errors (npm run build)
  • Redocly preview shows 9 separate customer sections
  • Swagger UI preview shows 9 separate customer sections
  • All customer endpoints remain functional with correct examples

🤖 Generated with Claude Code

Replace single "Customer Resources" tag with 9 individual tags to match
the energy section organization:

**New Tags:**
- Customer - Organizations receiving services
- CustomerAccount - Billing and payment information
- CustomerAgreement - Service terms at specific locations
- ServiceLocation - Physical premises where service is provided
- ServiceSupplier - Utility or energy service providers
- EndDevice - Metering and load management devices
- Meter - Physical metering assets at usage points
- Statement - Billing statements for services
- ProgramDateIdMappings - Energy efficiency program enrollments

**Updated:**
- 18 path files to use specific tags instead of generic "Customer Resources"
- x-tagGroups to list all 9 customer resource tags individually
- Tag descriptions to clarify each resource type's purpose

This makes customer resources appear as separate sections in Redocly and
Swagger UI documentation, matching the organization of energy resources
(UsagePoint, MeterReading, IntervalBlock, etc.).

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@dfcoffin dfcoffin merged commit 463bd64 into main Feb 8, 2026
2 checks passed
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