CDA-118: Add input examples for Level endpoints#1815
Merged
Conversation
… ApiServlet to read example files and add content to specified endpoints.
adamkorynta
reviewed
Jul 1, 2026
adamkorynta
reviewed
Jul 1, 2026
…napi package. Updated example data.
# Conflicts: # cwms-data-api/src/main/java/cwms/cda/ApiServlet.java
adamkorynta
requested changes
Jul 1, 2026
adamkorynta
approved these changes
Jul 1, 2026
MikeNeilson
approved these changes
Jul 2, 2026
|
|
||
| // Enum to define example configurations by endpoint | ||
| // Add examples here for other endpoints | ||
| private enum EndpointExamples { |
Contributor
There was a problem hiding this comment.
This is certainly fine for now... but let's all agree this will grow insanely and longer term we probably want something like annotations on the DTOs that can be looked up and contain links to relevant data.
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
3 participants
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
Adds default JSON examples for the multiple level types to the Level POST, GET, PATCH endpoints. These examples can be overridden via controller annotations.
Related Issue
Closes #1723
Validation
Manually verified. See screenshots. Note that location names and comments have been updated since these screenshots were taken.
Checklist