Fix: Add resource-specific XML examples for each endpoint#2
Merged
Conversation
Create project-specific instructions to ensure: - New branches are always created before making changes - Proper branch naming conventions are followed - OpenAPI development best practices are documented - Commit message format is standardized Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Created 18 new resource-specific response files so each endpoint shows appropriate XML examples instead of generic UsagePoint data for all resources. New examples added for: - ApplicationInformation (OAuth client registration data) - Authorization (OAuth authorization records with tokens) - ElectricPowerQualitySummary (power quality events and measurements) - UsageSummary (billing summaries with costs and consumption) - ServiceStatus (online/offline status indicators) Extracted to standalone files: - UsagePoint, MeterReading, ReadingType, IntervalBlock, LocalTimeParameters Updated 24 path files to reference resource-specific responses. Batch endpoints still use generic multi-resource feed (correct behavior). All examples follow conventions: - Use data.greenbuttonconnect.org as host - Type 5 UUIDs for all IDs - Proper Atom and ESPI namespaces - Realistic example values based on XSD schemas Validation: Passes npm test with zero errors 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
Fixes the issue where all endpoints displayed the same generic XML examples (UsagePoint/IntervalBlock) regardless of the actual resource type being accessed.
Changes
New Resource-Specific Response Files (18 files)
Created dedicated response files for each resource type:
New Examples (previously had none):
Extracted to Standalone Files:
Inline Examples:
Path Files Updated (24 files)
Every non-Batch path file now references its resource-specific response file:
Preserved Generic Responses
AtomFeed.yamlandAtomEntry.yamlremain intactExample Conventions
All new examples follow Green Button standards:
data.greenbuttonconnect.orghttp://www.w3.org/2005/Atomhttp://naesb.org/espirel=href=type=Validation
✅
npm test- Passes with zero errors✅
npm run build- Successfully generates documentation (1007 KiB)Files Changed
Total: 44 files changed, 875 insertions, 24 deletions
Testing
After merge, verify at https://greenbuttonalliance.github.io/openapi-starter/ that:
Co-Authored-By: Claude Sonnet 4.5 noreply@anthropic.com