How's My Waterway

Public access to local water quality status (rivers, lakes, beaches, drinking water) via the ATTAINS data layer.

OpenAPI Specification

mywaterway-openapi.json Raw ↑
{
  "openapi": "3.0.1",
  "info": {
    "title": "US EPA How's My Waterway",
    "contact": {
      "name": "US EPA Office of Water"
    },
    "license": {
      "name": "Creative Commons Zero Public Domain Dedication",
      "url": "https://edg.epa.gov/EPA_Data_License.html"
    },
    "version": "0.0.1"
  },
  "servers": [
    {
      "url": "https://mywaterway-stage.app.cloud.gov/"
    }
  ],
  "security": [
    {
      "basicAuth": []
    }
  ],
  "paths": {
    "/api/configFiles": {
      "get": {
        "tags": [
          "How's My Waterway"
        ],
        "responses": {
          "200": {
            "description": "Placeholder.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/generic"
                },
                "examples": {
                  "get_api_configFiles200Example": {
                    "summary": "Default get_api_configFiles 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/api/health": {
      "get": {
        "tags": [
          "How's My Waterway"
        ],
        "responses": {
          "200": {
            "description": "Placeholder.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/generic"
                },
                "examples": {
                  "get_api_health200Example": {
                    "summary": "Default get_api_health 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    },
    "/api/supportedBrowsers": {
      "get": {
        "tags": [
          "How's My Waterway"
        ],
        "responses": {
          "200": {
            "description": "Placeholder.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/generic"
                },
                "examples": {
                  "get_api_supportedBrowsers200Example": {
                    "summary": "Default get_api_supportedBrowsers 200 response",
                    "x-microcks-default": true,
                    "value": {
                      "status": "ok",
                      "message": "Example response"
                    }
                  }
                }
              }
            }
          }
        },
        "x-microcks-operation": {
          "delay": 0,
          "dispatcher": "FALLBACK"
        }
      }
    }
  },
  "components": {
    "schemas": {
      "generic": {
        "type": "object",
        "properties": {
          "Results": {
            "type": "string",
            "example": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "x-original-swagger-version": "2.0"
}