feat: separate customer resources into individual sections#9
Merged
Conversation
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>
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
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)
Customer Resourcestag for all customer endpointsPath File Updates (18 files)
Updated tag references in all customer resource path files:
Customer.yaml→ usesCustomertagCustomer_{customerId}.yaml→ usesCustomertagCustomerAccount.yaml→ usesCustomerAccounttagCustomerAccount_{customerAccountId}.yaml→ usesCustomerAccounttagCustomerAgreement.yaml→ usesCustomerAgreementtagCustomerAgreement_{customerAgreementId}.yaml→ usesCustomerAgreementtagServiceLocation.yaml→ usesServiceLocationtagServiceLocation_{serviceLocationId}.yaml→ usesServiceLocationtagServiceSupplier.yaml→ usesServiceSuppliertagServiceSupplier_{serviceSupplierId}.yaml→ usesServiceSuppliertagEndDevice.yaml→ usesEndDevicetagEndDevice_{endDeviceId}.yaml→ usesEndDevicetagMeter.yaml→ usesMetertagMeter_{meterId}.yaml→ usesMetertagStatement.yaml→ usesStatementtagStatement_{statementId}.yaml→ usesStatementtagProgramDateIdMappings.yaml→ usesProgramDateIdMappingstagProgramDateIdMappings_{programDateIdMappingsId}.yaml→ usesProgramDateIdMappingstagx-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
npm test)npm run build)🤖 Generated with Claude Code