openapi: 3.0.3
info:
title: Superhero API (akabab) Appearance Work 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: Work
description: Per-character occupation and base slices.
paths:
/work/{id}.json:
get:
operationId: getCharacterWork
summary: Get Character Work
description: Returns just the work slice for a single character (occupation and base).
tags:
- Work
parameters:
- $ref: '#/components/parameters/CharacterId'
responses:
'200':
description: The character's work sub-document.
content:
application/json:
schema:
$ref: '#/components/schemas/Work'
'404':
description: No character with the supplied id exists.
components:
schemas:
Work:
type: object
description: Occupational record.
properties:
occupation:
type: string
description: Occupation(s), or "-" if unknown.
base:
type: string
description: Base of operations, or "-" if unknown.
parameters:
CharacterId:
name: id
in: path
required: true
description: Numeric character id, 1..731.
schema:
type: integer
minimum: 1
maximum: 731