openapi: 3.0.3
info:
  title: Superhero API (akabab) Appearance API
  description: 'Open-source static REST API exposing 731 superheroes and villains from

    multiple comic universes (Marvel, DC, Dark Horse, Image, and more) as

    pre-built JSON files served from GitHub Pages and the jsDelivr CDN.

    All endpoints are unauthenticated GETs.

    '
  version: 0.3.0
  contact:
    name: akabab/superhero-api
    url: https://github.com/akabab/superhero-api
  license:
    name: MIT
    url: https://github.com/akabab/superhero-api/blob/master/LICENSE
servers:
- url: https://akabab.github.io/superhero-api/api
  description: Primary origin (GitHub Pages)
- url: https://cdn.jsdelivr.net/gh/akabab/superhero-api@0.3.0/api
  description: jsDelivr CDN mirror
tags:
- name: Appearance
  description: Per-character physical appearance slices.
paths:
  /appearance/{id}.json:
    get:
      operationId: getCharacterAppearance
      summary: Get Character Appearance
      description: Returns just the appearance slice for a single character.
      tags:
      - Appearance
      parameters:
      - $ref: '#/components/parameters/CharacterId'
      responses:
        '200':
          description: The character's appearance sub-document.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Appearance'
        '404':
          description: No character with the supplied id exists.
components:
  schemas:
    Appearance:
      type: object
      description: Physical appearance attributes.
      properties:
        gender:
          type: string
          description: Reported gender or "-" if unknown.
        race:
          type: string
          nullable: true
          description: Species / race designation (e.g. Human, Kryptonian, Mutant).
        height:
          type: array
          description: Height pair — imperial then metric.
          items:
            type: string
          example:
          - 6'8
          - 203 cm
        weight:
          type: array
          description: Weight pair — imperial then metric.
          items:
            type: string
          example:
          - 980 lb
          - 441 kg
        eyeColor:
          type: string
          description: Eye color or "-" if unknown.
        hairColor:
          type: string
          description: Hair color or "-" / "No Hair" if unknown / bald.
  parameters:
    CharacterId:
      name: id
      in: path
      required: true
      description: Numeric character id, 1..731.
      schema:
        type: integer
        minimum: 1
        maximum: 731