openapi: 3.1.0
info:
    title: SeismologyService API
    version: 1.0.0
paths:
    /api/seismology/v1/list-earthquakes:
        get:
            tags:
                - SeismologyService
            summary: ListEarthquakes
            description: ListEarthquakes retrieves recent earthquakes from the USGS GeoJSON feed.
            operationId: ListEarthquakes
            parameters:
                - name: start
                  in: query
                  description: Start of time range (inclusive), Unix epoch milliseconds.
                  required: false
                  schema:
                    type: string
                    format: int64
                - name: end
                  in: query
                  description: End of time range (inclusive), Unix epoch milliseconds.
                  required: false
                  schema:
                    type: string
                    format: int64
                - name: page_size
                  in: query
                  description: Maximum items per page (1-100).
                  required: false
                  schema:
                    type: integer
                    format: int32
                - name: cursor
                  in: query
                  description: Cursor for next page.
                  required: false
                  schema:
                    type: string
                - name: min_magnitude
                  in: query
                  description: Minimum magnitude filter (e.g., 4.0 for significant quakes).
                  required: false
                  schema:
                    type: number
                    format: double
            responses:
                "200":
                    description: Successful response
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/ListEarthquakesResponse'
                "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.
        ListEarthquakesRequest:
            type: object
            properties:
                start:
                    type: integer
                    format: int64
                    description: 'Start of time range (inclusive), Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
                end:
                    type: integer
                    format: int64
                    description: 'End of time range (inclusive), Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
                pageSize:
                    type: integer
                    format: int32
                    description: Maximum items per page (1-100).
                cursor:
                    type: string
                    description: Cursor for next page.
                minMagnitude:
                    type: number
                    format: double
                    description: Minimum magnitude filter (e.g., 4.0 for significant quakes).
            description: ListEarthquakesRequest specifies filters for retrieving earthquake data from USGS.
        ListEarthquakesResponse:
            type: object
            properties:
                earthquakes:
                    type: array
                    items:
                        $ref: '#/components/schemas/Earthquake'
                pagination:
                    $ref: '#/components/schemas/PaginationResponse'
            description: ListEarthquakesResponse contains the list of earthquakes matching the request filters.
        Earthquake:
            type: object
            properties:
                id:
                    type: string
                    maxLength: 100
                    minLength: 1
                    description: Unique USGS event identifier (e.g., "us7000abcd").
                place:
                    type: string
                    description: Human-readable place description (e.g., "10 km SW of Anchorage, Alaska").
                magnitude:
                    type: number
                    format: double
                    description: Earthquake magnitude on the Richter scale.
                depthKm:
                    type: number
                    format: double
                    description: Depth in kilometers below the surface.
                location:
                    $ref: '#/components/schemas/GeoCoordinates'
                occurredAt:
                    type: integer
                    format: int64
                    description: 'Time the earthquake occurred, as Unix epoch milliseconds.. Warning: Values > 2^53 may lose precision in JavaScript'
                sourceUrl:
                    type: string
                    description: URL to the USGS event detail page.
            required:
                - id
            description: Earthquake represents a seismic event from USGS GeoJSON feed.
        GeoCoordinates:
            type: object
            properties:
                latitude:
                    type: number
                    maximum: 90
                    minimum: -90
                    format: double
                    description: Latitude in decimal degrees (-90 to 90).
                longitude:
                    type: number
                    maximum: 180
                    minimum: -180
                    format: double
                    description: Longitude in decimal degrees (-180 to 180).
            description: GeoCoordinates represents a geographic location using WGS84 coordinates.
        PaginationResponse:
            type: object
            properties:
                nextCursor:
                    type: string
                    description: Cursor for fetching the next page. Empty string indicates no more pages.
                totalCount:
                    type: integer
                    format: int32
                    description: Total count of items matching the query, if known. Zero if the total is unknown.
            description: PaginationResponse contains pagination metadata returned alongside list results.