Skip to content
Snippets Groups Projects
Commit 827ea853 authored by Clayton, Brandon Scott's avatar Clayton, Brandon Scott
Browse files

Add swagger class for ground motions

parent bbda354f
No related branches found
No related tags found
2 merge requests!128Production Release | nshmp-ws-static,!127Resolves - Handle Multiple NetCDF Files for AASHTO Service
package gov.usgs.earthquake.nshmp.netcdf.www;
import io.micronaut.http.HttpRequest;
/**
* Swagger page updates for ground motion services.
*
* @author U.S. Geological Survey
*/
class SwaggerGroundMotions extends Swagger<NetcdfServiceGroundMotions> {
SwaggerGroundMotions(HttpRequest<?> request, NetcdfServiceGroundMotions service) {
super(request, service);
}
@Override
String descriptionHeader() {
return String.format("AASHTO-%d Data Sets", service.netcdfDataFiles().aashtoYear());
}
@Override
String serviceInfo() {
return String.format(String.join("",
"Get risk-targeted design response spectra for the %d ",
"editions of American Association of State Highway and Transportation ",
"Officials (AASHTO) bridge design specifications."),
service.netcdfDataFiles().aashtoYear());
}
@Override
String servicePatternSection() {
var url = NetcdfWsUtils.getRequestUrl(request);
url = url.endsWith("/swagger") ? url.replace("/swagger", "") : url;
return new StringBuilder()
.append(
"<details>\n" +
"<summary>Service Call Patterns</summary>\n")
.append(
"### Query Pattern\n" +
"The query based service call is in the form of:\n" +
"```text\n" +
url + "/spectra?longitude={number}&latitude={number}\n" +
url + "/spectra?longitude={number}&latitude={number}&siteClass={string}\n" +
"````\n" +
"Example:\n" +
"```text\n" +
url + "/spectra?longitude=-118&latitude=34\n" +
url + "/spectra?longitude=-118&latitude=34&siteClass=BC\n" +
"```\n")
.append(
"### Slash Pattern\n" +
"The slash based service call is in the form of:\n" +
"```text\n" +
url + "/spectra/{longitude}/{latitude}\n" +
url + "/spectra/{longitude}/{latitude}/{siteClass}\n" +
"```\n" +
"Example:\n" +
"```text\n" +
url + "/spectra/-118/34\n" +
url + "/spectra/-118/34/BC\n" +
"```\n")
.append("</details>")
.toString();
}
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment