Release of 3.1.5

[MikeNeilson]

We have now pushed version "3.1.5" to https://cwms-data.usace.army.mil/cwms-data.

Of great importance

We have altered the default data formats per #483 . If you desire old formats check the swagger-ui for what's available for a given datatype. Several will be going away by the end of next year so plan to migrate. There will be a "CWMS-DATA-Format-Deprecated" with information about the future remove date in the response for any deprecated data types.

The Swagger-UI shows the lock ICON on everything. Except for 2 GET requests each remains "public". This is a limitation of the Swagger-UI and OpenAPI spec we haven't been able to overcome yet.

There is improved, but definitely not perfect, handling for reporting user input error. As you use the new version try not to spend more than an hour figuring out "silent errors." We consider those bugs that should be addressed.

Performance improvements in catalog operations were made.

Added

Multiple new endpoints where added. Most of these are in support of "REGI" but of course available to all. These include

• the CWMS Properties Table (authentication required)
• Gate settings
• Outlets
• Projects
• APIKeys (authentication required)

Present but in progress

• TimeSeriesProfiles
• Forecasts

End points are present but may not work correctly due to required database schema updates. Changes to the interface are unlikely unless there's feedback from the community. Review the concepts and see how you might use them.

Profiles should be available in the next CDA release, Forecasts requires the next CWMS Schema update.

There's more

There's definitely more, but having waited so long to make this announcement it is proving difficult to sort though the various changes for user-facing vs internal changes.

Future

the version "3.1.5" is basically meaningless and we can't get release out fast enough during normal development to handle semantic versioning. We are going to follow suit of the CWMS Schema and adopt "Calendar Versioning" as well as actually having the current version available to client to access in some way. The format will be the same, just using the date of release. So YYYY.MM.DD. We have also found ways to speed up and move to github our integration testing, as such we are automating the release process more and will publish smaller releases more often. This is necessarily to help keep up with security compliance on our future environment of CWBI.