Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
N
nshmp-ws-static
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
ghsc
National Seismic Hazard Model Project
nshmp-ws-static
Commits
c8f8fa6b
Commit
c8f8fa6b
authored
2 years ago
by
Clayton, Brandon Scott
Browse files
Options
Downloads
Patches
Plain Diff
add hazard swagger class
parent
b8613cc7
No related branches found
Branches containing commit
No related tags found
Tags containing commit
2 merge requests
!128
Production Release | nshmp-ws-static
,
!127
Resolves - Handle Multiple NetCDF Files for AASHTO Service
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
src/hazard/src/main/java/gov/usgs/earthquake/nshmp/netcdf/www/SwaggerHazardCurves.java
+111
-0
111 additions, 0 deletions
...usgs/earthquake/nshmp/netcdf/www/SwaggerHazardCurves.java
with
111 additions
and
0 deletions
src/hazard/src/main/java/gov/usgs/earthquake/nshmp/netcdf/www/SwaggerHazardCurves.java
0 → 100644
+
111
−
0
View file @
c8f8fa6b
package
gov.usgs.earthquake.nshmp.netcdf.www
;
import
java.io.IOException
;
import
java.util.List
;
import
java.util.Map
;
import
java.util.Set
;
import
gov.usgs.earthquake.nshmp.netcdf.Nshm
;
import
gov.usgs.earthquake.nshmp.www.SwaggerUtils
;
import
io.micronaut.http.HttpRequest
;
import
io.swagger.v3.oas.models.OpenAPI
;
import
io.swagger.v3.oas.models.media.Schema
;
import
io.swagger.v3.parser.util.SchemaTypeUtil
;
/**
* Swagger page updates for hazard services.
*
* @author U.S. Geological Survey
*/
public
class
SwaggerHazardCurves
extends
Swagger
<
NetcdfServiceHazardCurves
>
{
SwaggerHazardCurves
(
HttpRequest
<?>
request
,
NetcdfServiceHazardCurves
service
)
{
super
(
request
,
service
);
}
@Override
String
descriptionHeader
()
{
return
"NSHM Data Sets"
;
}
@Override
String
serviceInfo
()
{
return
String
.
join
(
""
,
"Get hazard curves for user-specified NSHM, latitudes, "
,
"longitudes, and/or site classes of the National Seismic Hazard Models data releases."
);
}
@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
+
"/hazard?nshm={nshm}&longitude={number}&latitude={number}\n"
+
url
+
"/hazard"
+
"?nshm={nshm}&longitude={number}&latitude={number}&siteClass={string}\n"
+
url
+
"/hazard"
+
"?nshm={nshm}&longitude={number}&latitude={number}&siteClass={string}&imt={string}\n"
+
"````\n"
+
"Example:\n"
+
"```text\n"
+
url
+
"/hazard?nshm=CONUS_2018&longitude=-118&latitude=34\n"
+
url
+
"/hazard?nshm=CONUS_2018&longitude=-118&latitude=34&siteClass=BC\n"
+
url
+
"/hazard?nshm=CONUS_2018&longitude=-118&latitude=34&siteClass=BC&imt=PGA\n"
+
"```\n"
)
.
append
(
"### Slash Pattern\n"
+
"The slash based service call is in the form of:\n"
+
"```text\n"
+
url
+
"/hazard/{nshm}/{longitude}/{latitude}\n"
+
url
+
"/hazard/{nshm}/{longitude}/{latitude}/{siteClass}\n"
+
url
+
"/hazard/{nshm}/{longitude}/{latitude}/{siteClass}/{imt}\n"
+
"```\n"
+
"Example:\n"
+
"```text\n"
+
url
+
"/hazard/CONUS_2018/-118/34\n"
+
url
+
"/hazard/CONUS_2018/-118/34/BC\n"
+
url
+
"/hazard/CONUS_2018/-118/34/BC/PGA\n"
+
"```\n"
)
.
append
(
"</details>"
)
.
toString
();
}
@Override
OpenAPI
updateOpenApi
()
throws
IOException
{
OpenAPI
openApi
=
super
.
updateOpenApi
();
SwaggerUtils
.
imtSchema
(
openApi
.
getComponents
().
getSchemas
(),
List
.
copyOf
(
service
.
netcdfDataFiles
().
imts
()));
nshmSchema
(
openApi
.
getComponents
().
getSchemas
(),
service
.
netcdfDataFiles
().
nshms
());
return
openApi
;
}
private
void
nshmSchema
(
Map
<
String
,
Schema
>
schemas
,
Set
<
Nshm
>
nshms
)
{
Schema
<
Nshm
>
schema
=
new
Schema
<>();
schema
.
setType
(
SchemaTypeUtil
.
STRING_TYPE
);
nshms
.
stream
()
.
sorted
()
.
forEach
(
nshm
->
schema
.
addEnumItemObject
(
nshm
));
schemas
.
put
(
Nshm
.
class
.
getSimpleName
(),
schema
);
}
}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment