openapi: 3.1.0
info:
    title: NaturalService API
    version: 1.0.0
paths:
    /api/natural/v1/list-natural-events:
        get:
            tags:
                - NaturalService
            summary: ListNaturalEvents
            operationId: ListNaturalEvents
            parameters:
                - name: days
                  in: query
                  required: false
                  schema:
                    type: integer
                    format: int32
            responses:
                "200":
                    description: Successful response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/ListNaturalEventsResponse'
                "400":
                    description: Validation error
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/ValidationError'
                default:
                    description: Error response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/Error'
components:
    schemas:
        Error:
            type: object
            properties:
                message:
                    type: string
                    description: Error message (e.g., 'user not found', 'database connection failed')
            description: Error is returned when a handler encounters an error. It contains a simple error message that the developer can customize.
        FieldViolation:
            type: object
            properties:
                field:
                    type: string
                    description: The field path that failed validation (e.g., 'user.email' for nested fields). For header validation, this will be the header name (e.g., 'X-API-Key')
                description:
                    type: string
                    description: Human-readable description of the validation violation (e.g., 'must be a valid email address', 'required field missing')
            required:
                - field
                - description
            description: FieldViolation describes a single validation error for a specific field.
        ValidationError:
            type: object
            properties:
                violations:
                    type: array
                    items:
                        $ref: '#/components/schemas/FieldViolation'
                    description: List of validation violations
            required:
                - violations
            description: ValidationError is returned when request validation fails. It contains a list of field violations describing what went wrong.
        ListNaturalEventsRequest:
            type: object
            properties:
                days:
                    type: integer
                    format: int32
        ListNaturalEventsResponse:
            type: object
            properties:
                events:
                    type: array
                    items:
                        $ref: '#/components/schemas/NaturalEvent'
        NaturalEvent:
            type: object
            properties:
                id:
                    type: string
                title:
                    type: string
                description:
                    type: string
                category:
                    type: string
                categoryTitle:
                    type: string
                lat:
                    type: number
                    format: double
                lon:
                    type: number
                    format: double
                date:
                    type: integer
                    format: int64
                    description: 'Warning: Values > 2^53 may lose precision in JavaScript'
                magnitude:
                    type: number
                    format: double
                magnitudeUnit:
                    type: string
                sourceUrl:
                    type: string
                sourceName:
                    type: string
                closed:
                    type: boolean
                stormId:
                    type: string
                    description: Optional tropical cyclone fields (populated for severeStorms from GDACS TC / NHC)
                stormName:
                    type: string
                basin:
                    type: string
                stormCategory:
                    type: integer
                    format: int32
                classification:
                    type: string
                windKt:
                    type: integer
                    format: int32
                pressureMb:
                    type: integer
                    format: int32
                movementDir:
                    type: integer
                    format: int32
                movementSpeedKt:
                    type: integer
                    format: int32
                forecastTrack:
                    type: array
                    items:
                        $ref: '#/components/schemas/ForecastPoint'
                conePolygon:
                    type: array
                    items:
                        $ref: '#/components/schemas/CoordRing'
                pastTrack:
                    type: array
                    items:
                        $ref: '#/components/schemas/PastTrackPoint'
        ForecastPoint:
            type: object
            properties:
                lat:
                    type: number
                    format: double
                lon:
                    type: number
                    format: double
                hour:
                    type: integer
                    format: int32
                windKt:
                    type: integer
                    format: int32
                category:
                    type: integer
                    format: int32
        CoordRing:
            type: object
            properties:
                points:
                    type: array
                    items:
                        $ref: '#/components/schemas/Coordinate'
        Coordinate:
            type: object
            properties:
                lon:
                    type: number
                    format: double
                lat:
                    type: number
                    format: double
        PastTrackPoint:
            type: object
            properties:
                lat:
                    type: number
                    format: double
                lon:
                    type: number
                    format: double
                windKt:
                    type: integer
                    format: int32
                timestamp:
                    type: integer
                    format: int64
                    description: 'Warning: Values > 2^53 may lose precision in JavaScript'
