{
  "openapi": "3.1.0",
  "info": {
    "title": "eggs.download API",
    "description": "Static JSON API for Pterodactyl and Pelican eggs. Rebuilt every few hours from the upstream GitHub repositories.",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "https://eggs.download"
    }
  ],
  "paths": {
    "/api/v1/eggs/_index.json": {
      "get": {
        "operationId": "listEggs",
        "summary": "List eggs",
        "description": "Every egg as `{slug, name, category, repo, source}`. Also reachable as `/api/v1/eggs`.",
        "responses": {
          "200": {
            "description": "The egg index.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EggListItem"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/eggs/_names.json": {
      "get": {
        "operationId": "listEggNames",
        "summary": "List unique egg names",
        "description": "Sorted, de-duplicated names. Also reachable as `/api/v1/eggs?fields=name`.",
        "responses": {
          "200": {
            "description": "Egg names.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/v1/eggs/{slug}.json": {
      "get": {
        "operationId": "getEgg",
        "summary": "Get an egg",
        "description": "The full egg JSON, its index metadata and the README (if one exists). Also reachable as `/api/v1/eggs/{slug}`.",
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "description": "Egg slug from the list endpoint.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The egg.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "egg",
                    "meta",
                    "readme"
                  ],
                  "properties": {
                    "egg": {
                      "type": "object",
                      "additionalProperties": true
                    },
                    "meta": {
                      "$ref": "#/components/schemas/EggMeta"
                    },
                    "readme": {
                      "type": [
                        "string",
                        "null"
                      ]
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "Egg not found."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "EggListItem": {
        "type": "object",
        "required": [
          "slug",
          "name",
          "category",
          "repo",
          "source"
        ],
        "properties": {
          "slug": {
            "type": "string",
            "examples": [
              "paper"
            ]
          },
          "name": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "repo": {
            "type": "string"
          },
          "source": {
            "type": "string"
          }
        }
      },
      "EggMeta": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "source": {
            "type": "string"
          },
          "owner": {
            "type": "string"
          },
          "repo": {
            "type": "string"
          },
          "branch": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "rawUrl": {
            "type": "string",
            "format": "uri"
          },
          "indexedAt": {
            "type": "integer"
          }
        }
      }
    }
  }
}