Skip to content

Commit

Permalink
Merge pull request #14 from USACE/feature/update-isamodel
Browse files Browse the repository at this point in the history 
Feature/update isamodel
  • Loading branch information
@ShaneMPutnam
ShaneMPutnam authored Jan 29, 2021
2 parents 8417d53 + 79ad94f commit 7a2f0d5
Show file tree
Hide file tree
Showing 15 changed files with 159 additions and 144 deletions.
10 changes: 5 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ Contains the HEC-RAS model content and analysis tool (MCAT). Given a .prj file,

The MCAT includes:
- a standard set of methods to evaluate a model's content:
- isamodel
- modeltype
- modelversion
- isamodel
- index
- isgeospatial
- index
- geospatialdata
- an API for executing the above methods.
- a docker container for running the methods and API.
Expand Down Expand Up @@ -42,18 +42,18 @@ The following requests can be used to interrogate a model whose storage location
`GET /isamodel?definition_file=<s3_key>`
`GET /isgeospatial?definition_file=<s3_key>`
`GET /modeltype?definition_file=<s3_key>`
`GET /modelversion?definition_file=<s3_key>`
`GET /index?definition_file=<s3_key>`
`GET /isgeospatial?definition_file=<s3_key>`
`GET /geospatialdata?definition_file=<s3_key>`
*For example: `http://mcat-ras:5600/isamodel?definition_file=models/ras/ex_model.prj`*
*For example: `http://mcat-ras:5600/isamodel?definition_file=models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj`*
### Swagger Documentation:
Expand Down
44 changes: 22 additions & 22 deletions docs/docs.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ var doc = `{
"parameters": [
{
"type": "string",
"description": "/pfra-models/mipmodels/MD/M000309/T1ChptnkR.prj",
"description": "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj",
"name": "definition_file",
"in": "query",
"required": true
Expand Down Expand Up @@ -82,7 +82,7 @@ var doc = `{
"parameters": [
{
"type": "string",
"description": "/pfra-models/mipmodels/MD/M000309/T1ChptnkR.prj",
"description": "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj",
"name": "definition_file",
"in": "query",
"required": true
Expand All @@ -92,7 +92,7 @@ var doc = `{
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ras.Model"
"$ref": "#/definitions/tools.Model"
}
},
"500": {
Expand Down Expand Up @@ -120,7 +120,7 @@ var doc = `{
"parameters": [
{
"type": "string",
"description": "/pfra-models/mipmodels/MD/M000309/T1ChptnkR.prj",
"description": "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj",
"name": "definition_file",
"in": "query",
"required": true
Expand Down Expand Up @@ -152,7 +152,7 @@ var doc = `{
"parameters": [
{
"type": "string",
"description": "/pfra-models/mipmodels/MD/M000309/T1ChptnkR.prj",
"description": "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj",
"name": "definition_file",
"in": "query",
"required": true
Expand Down Expand Up @@ -184,7 +184,7 @@ var doc = `{
"parameters": [
{
"type": "string",
"description": "/pfra-models/mipmodels/MD/M000309/T1ChptnkR.prj",
"description": "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj",
"name": "definition_file",
"in": "query",
"required": true
Expand Down Expand Up @@ -222,7 +222,7 @@ var doc = `{
"parameters": [
{
"type": "string",
"description": "/pfra-models/mipmodels/MD/M000309/T1ChptnkR.prj",
"description": "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj",
"name": "definition_file",
"in": "query",
"required": true
Expand Down Expand Up @@ -280,7 +280,7 @@ var doc = `{
}
}
},
"ras.ControlFiles": {
"tools.ControlFiles": {
"type": "object",
"properties": {
"data": {
Expand All @@ -296,7 +296,7 @@ var doc = `{
}
}
},
"ras.ForcingFiles": {
"tools.ForcingFiles": {
"type": "object",
"properties": {
"data": {
Expand All @@ -312,7 +312,7 @@ var doc = `{
}
}
},
"ras.GeometryFiles": {
"tools.GeometryFiles": {
"type": "object",
"properties": {
"featuresProperties": {
Expand All @@ -332,17 +332,17 @@ var doc = `{
}
}
},
"ras.InputFiles": {
"tools.InputFiles": {
"type": "object",
"properties": {
"controlFiles": {
"$ref": "#/definitions/ras.ControlFiles"
"$ref": "#/definitions/tools.ControlFiles"
},
"forcingFiles": {
"$ref": "#/definitions/ras.ForcingFiles"
"$ref": "#/definitions/tools.ForcingFiles"
},
"geometryFiles": {
"$ref": "#/definitions/ras.GeometryFiles"
"$ref": "#/definitions/tools.GeometryFiles"
},
"localVariables": {
"description": "placeholder",
Expand All @@ -354,14 +354,14 @@ var doc = `{
}
}
},
"ras.Model": {
"tools.Model": {
"type": "object",
"properties": {
"definitionFile": {
"type": "string"
},
"files": {
"$ref": "#/definitions/ras.ModelFiles"
"$ref": "#/definitions/tools.ModelFiles"
},
"type": {
"type": "string"
Expand All @@ -371,21 +371,21 @@ var doc = `{
}
}
},
"ras.ModelFiles": {
"tools.ModelFiles": {
"type": "object",
"properties": {
"inputFiles": {
"$ref": "#/definitions/ras.InputFiles"
"$ref": "#/definitions/tools.InputFiles"
},
"outputFiles": {
"$ref": "#/definitions/ras.OutputFiles"
"$ref": "#/definitions/tools.OutputFiles"
},
"supplementalFiles": {
"$ref": "#/definitions/ras.SupplementalFiles"
"$ref": "#/definitions/tools.SupplementalFiles"
}
}
},
"ras.OutputFiles": {
"tools.OutputFiles": {
"type": "object",
"properties": {
"modelPrediction": {
Expand All @@ -412,7 +412,7 @@ var doc = `{
}
}
},
"ras.SupplementalFiles": {
"tools.SupplementalFiles": {
"type": "object",
"properties": {
"observationalData": {
Expand Down
44 changes: 22 additions & 22 deletions docs/swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"parameters": [
{
"type": "string",
"description": "/pfra-models/mipmodels/MD/M000309/T1ChptnkR.prj",
"description": "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj",
"name": "definition_file",
"in": "query",
"required": true
Expand Down Expand Up @@ -66,7 +66,7 @@
"parameters": [
{
"type": "string",
"description": "/pfra-models/mipmodels/MD/M000309/T1ChptnkR.prj",
"description": "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj",
"name": "definition_file",
"in": "query",
"required": true
Expand All @@ -76,7 +76,7 @@
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ras.Model"
"$ref": "#/definitions/tools.Model"
}
},
"500": {
Expand Down Expand Up @@ -104,7 +104,7 @@
"parameters": [
{
"type": "string",
"description": "/pfra-models/mipmodels/MD/M000309/T1ChptnkR.prj",
"description": "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj",
"name": "definition_file",
"in": "query",
"required": true
Expand Down Expand Up @@ -136,7 +136,7 @@
"parameters": [
{
"type": "string",
"description": "/pfra-models/mipmodels/MD/M000309/T1ChptnkR.prj",
"description": "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj",
"name": "definition_file",
"in": "query",
"required": true
Expand Down Expand Up @@ -168,7 +168,7 @@
"parameters": [
{
"type": "string",
"description": "/pfra-models/mipmodels/MD/M000309/T1ChptnkR.prj",
"description": "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj",
"name": "definition_file",
"in": "query",
"required": true
Expand Down Expand Up @@ -206,7 +206,7 @@
"parameters": [
{
"type": "string",
"description": "/pfra-models/mipmodels/MD/M000309/T1ChptnkR.prj",
"description": "/models/ras/CHURCH HOUSE GULLY/CHURCH HOUSE GULLY.prj",
"name": "definition_file",
"in": "query",
"required": true
Expand Down Expand Up @@ -264,7 +264,7 @@
}
}
},
"ras.ControlFiles": {
"tools.ControlFiles": {
"type": "object",
"properties": {
"data": {
Expand All @@ -280,7 +280,7 @@
}
}
},
"ras.ForcingFiles": {
"tools.ForcingFiles": {
"type": "object",
"properties": {
"data": {
Expand All @@ -296,7 +296,7 @@
}
}
},
"ras.GeometryFiles": {
"tools.GeometryFiles": {
"type": "object",
"properties": {
"featuresProperties": {
Expand All @@ -316,17 +316,17 @@
}
}
},
"ras.InputFiles": {
"tools.InputFiles": {
"type": "object",
"properties": {
"controlFiles": {
"$ref": "#/definitions/ras.ControlFiles"
"$ref": "#/definitions/tools.ControlFiles"
},
"forcingFiles": {
"$ref": "#/definitions/ras.ForcingFiles"
"$ref": "#/definitions/tools.ForcingFiles"
},
"geometryFiles": {
"$ref": "#/definitions/ras.GeometryFiles"
"$ref": "#/definitions/tools.GeometryFiles"
},
"localVariables": {
"description": "placeholder",
Expand All @@ -338,14 +338,14 @@
}
}
},
"ras.Model": {
"tools.Model": {
"type": "object",
"properties": {
"definitionFile": {
"type": "string"
},
"files": {
"$ref": "#/definitions/ras.ModelFiles"
"$ref": "#/definitions/tools.ModelFiles"
},
"type": {
"type": "string"
Expand All @@ -355,21 +355,21 @@
}
}
},
"ras.ModelFiles": {
"tools.ModelFiles": {
"type": "object",
"properties": {
"inputFiles": {
"$ref": "#/definitions/ras.InputFiles"
"$ref": "#/definitions/tools.InputFiles"
},
"outputFiles": {
"$ref": "#/definitions/ras.OutputFiles"
"$ref": "#/definitions/tools.OutputFiles"
},
"supplementalFiles": {
"$ref": "#/definitions/ras.SupplementalFiles"
"$ref": "#/definitions/tools.SupplementalFiles"
}
}
},
"ras.OutputFiles": {
"tools.OutputFiles": {
"type": "object",
"properties": {
"modelPrediction": {
Expand All @@ -396,7 +396,7 @@
}
}
},
"ras.SupplementalFiles": {
"tools.SupplementalFiles": {
"type": "object",
"properties": {
"observationalData": {
Expand Down
Loading

0 comments on commit 7a2f0d5

Please sign in to comment.