Crosby News Water API

openapi: 3.2.0
info:
  title: crosbynews.com Water API
  version: 1.7.0
  description: 'Crosby, Texas community data: current conditions, hourly and 7-day forecast, active alerts, the EPA UV index, and a measured air-quality index (EPA/AirNow monitors, with an Open-Meteo modeled fallback) from the U.S. National Weather Service, EPA/AirNow, and Open-Meteo; river/bayou flood levels; the Atlantic tropical outlook; the Houston Health Department''s measured daily pollen and mold count; the Harris County burn-ban status from the Texas A&M Forest Service; road incidents and lane closures from Houston TranStar; recent local news headlines; and the Crosby ISD school calendar. Public, no authentication.'
  contact:
    url: https://crosbynews.com/
  license:
    name: Public domain (NWS source data)
    url: https://www.weather.gov/disclaimer
servers:
- url: https://crosbynews.com
security: []
tags:
- name: Water
paths:
  /api/water:
    get:
      operationId: getWater
      summary: River and bayou levels with NWS flood stages for the Crosby, TX area
      parameters:
      - $ref: '#/components/parameters/IfNoneMatch'
      responses:
        '200':
          description: Current stage, flow, flood category, and thresholds per gauge
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Water'
        '304':
          $ref: '#/components/responses/NotModified'
        '502':
          description: Water data unavailable
      tags:
      - Water
components:
  responses:
    NotModified:
      description: Not Modified — the caller's If-None-Match matches the current snapshot, so no body is sent. The ETag is derived from the cache's refresh stamp, so it changes exactly when the payload would.
  parameters:
    IfNoneMatch:
      name: If-None-Match
      in: header
      required: false
      description: A previously returned weak ETag. When it still matches the cached snapshot, the endpoint answers 304 with no body — the cheap way to poll.
      schema:
        type: string
  schemas:
    Gauge:
      type: object
      properties:
        id:
          type: string
          description: NWPS location ID (e.g. HCDT2).
        name:
          type: string
        usgsId:
          type:
          - string
          - 'null'
        stage:
          type:
          - number
          - 'null'
          description: Observed gauge height, in stageUnit; null when the gauge is offline.
        stageUnit:
          type: string
        flow:
          type:
          - number
          - 'null'
          description: Observed discharge in cubic feet per second.
        flowUnit:
          type: string
        category:
          type: string
          description: NWS flood category. no_flooding/action/minor/moderate/major where NWS defines flood stages; not_defined for gauges without them (e.g. reservoir levels).
          enum:
          - no_flooding
          - action
          - minor
          - moderate
          - major
          - not_defined
          - unknown
        validTime:
          type:
          - string
          - 'null'
          format: date-time
        thresholds:
          type: object
          description: NWS flood-stage thresholds in thresholdUnit; only the categories NWS defines for this gauge are present.
          additionalProperties:
            type: number
        thresholdUnit:
          type: string
        officialUrl:
          type: string
          format: uri
    Water:
      type: object
      properties:
        location:
          type: string
        source:
          type: string
        updated:
          type:
          - string
          - 'null'
          format: date-time
        gauges:
          type: array
          items:
            $ref: '#/components/schemas/Gauge'