openapi: 3.0.3
info:
  title: AviationWeather.gov Alerts Icons API
  description: Schema for public data API of AviationWeather.gov.
  termsOfService: /data/api/
  version: v4.0
tags:
- name: Icons
paths:
  /icons/{set}/{timeOfDay}/{first}:
    parameters:
    - name: set
      in: path
      description: .
      required: true
      schema:
        type: string
    - name: timeOfDay
      in: path
      description: .
      required: true
      schema:
        type: string
    - name: first
      in: path
      description: .
      required: true
      schema:
        type: string
    - name: size
      in: query
      description: Font size
      schema:
        anyOf:
        - enum:
          - small
          - medium
          - large
          type: string
        - maximum: 500
          minimum: 10
          type: integer
    - name: fontsize
      in: query
      description: Font size
      schema:
        maximum: 24
        minimum: 2
        type: integer
    get:
      description: Returns a forecast icon. Icon services in API are deprecated.
      operationId: icons
      responses:
        '200':
          description: success
          headers:
            X-Correlation-Id:
              $ref: '#/components/headers/CorrelationId'
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-Server-Id:
              $ref: '#/components/headers/ServerId'
          content:
            image/png:
              schema:
                $ref: '#/components/schemas/BinaryFile'
        default:
          $ref: '#/components/responses/Error'
      deprecated: true
      parameters: []
      tags:
      - Icons
  /icons/{set}/{timeOfDay}/{first}/{second}:
    parameters:
    - name: set
      in: path
      description: .
      required: true
      schema:
        type: string
    - name: timeOfDay
      in: path
      description: .
      required: true
      schema:
        type: string
    - name: first
      in: path
      description: .
      required: true
      schema:
        type: string
    - name: second
      in: path
      description: .
      required: true
      schema:
        type: string
    - name: size
      in: query
      description: Font size
      schema:
        anyOf:
        - enum:
          - small
          - medium
          - large
          type: string
        - maximum: 500
          minimum: 10
          type: integer
    - name: fontsize
      in: query
      description: Font size
      schema:
        maximum: 24
        minimum: 2
        type: integer
    get:
      description: Returns a forecast icon. Icon services in API are deprecated.
      operationId: iconsDualCondition
      responses:
        '200':
          description: success
          headers:
            X-Correlation-Id:
              $ref: '#/components/headers/CorrelationId'
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-Server-Id:
              $ref: '#/components/headers/ServerId'
          content:
            image/png:
              schema:
                $ref: '#/components/schemas/BinaryFile'
        default:
          $ref: '#/components/responses/Error'
      deprecated: true
      parameters: []
      tags:
      - Icons
  /icons:
    get:
      description: Returns a list of icon codes and textual descriptions. Icon services in API are deprecated.
      operationId: icons_summary
      responses:
        '200':
          description: success
          headers:
            X-Correlation-Id:
              $ref: '#/components/headers/CorrelationId'
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-Server-Id:
              $ref: '#/components/headers/ServerId'
          content:
            application/ld+json:
              schema:
                required:
                - icons
                type: object
                properties:
                  '@context':
                    $ref: '#/components/schemas/JsonLdContext'
                  icons:
                    type: object
                    additionalProperties:
                      required:
                      - description
                      type: object
                      properties:
                        description:
                          type: string
                      additionalProperties: false
                additionalProperties: false
        default:
          $ref: '#/components/responses/Error'
      deprecated: true
      parameters: []
      tags:
      - Icons
components:
  schemas:
    JsonLdContext:
      anyOf:
      - type: array
        items: {}
      - type: object
    ProblemDetail:
      required:
      - type
      - title
      - status
      - detail
      - instance
      - correlationId
      type: object
      properties:
        type:
          type: string
          description: 'A URI reference (RFC 3986) that identifies the problem type. This is only an identifier and is not necessarily a resolvable URL.

            '
          format: uri
          default: about:blank
          examples:
          - urn:noaa:nws:api:UnexpectedProblem
        title:
          type: string
          description: A short, human-readable summary of the problem type.
          examples:
          - Unexpected Problem
        status:
          maximum: 999
          minimum: 100
          type: number
          description: 'The HTTP status code (RFC 7231, Section 6) generated by the origin server for this occurrence of the problem.

            '
          examples:
          - 500
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          examples:
          - An unexpected problem has occurred.
        instance:
          type: string
          description: 'A URI reference (RFC 3986) that identifies the specific occurrence of the problem. This is only an identifier and is not necessarily a resolvable URL.

            '
          format: uri
          examples:
          - urn:noaa:nws:api:request:493c3a1d-f87e-407f-ae2c-24483f5aab63
        correlationId:
          type: string
          description: 'A unique identifier for the request, used for NWS debugging purposes. Please include this identifier with any correspondence to help us investigate your issue.

            '
          examples:
          - 493c3a1d-f87e-407f-ae2c-24483f5aab63
      description: Detail about an error. This document conforms to RFC 7807 (Problem Details for HTTP APIs).
      additionalProperties: true
    BinaryFile:
      type: string
      format: binary
  headers:
    CorrelationId:
      description: 'A unique identifier for the request, used for NWS debugging purposes. Please include this identifier with any correspondence to help us investigate your issue.

        '
      schema:
        type: string
    RequestId:
      description: 'A unique identifier for the request, used for NWS debugging purposes. Please include this identifier with any correspondence to help us investigate your issue.

        '
      schema:
        type: string
    ServerId:
      description: 'The identifier of the server that generated the response, used for NWS debugging purposes. Please include this identifier with any correspondence to help us investigate your issue.

        '
      schema:
        type: string
  responses:
    Error:
      description: An error response.
      headers:
        X-Correlation-Id:
          $ref: '#/components/headers/CorrelationId'
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        X-Server-Id:
          $ref: '#/components/headers/ServerId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetail'