{
  "openapi": "3.1.0",
  "info": {
    "title": "EasyTeX API",
    "version": "1.0.0",
    "description": "EasyTeX (easytex.ir) public API for LaTeX template discovery, download, and waitlist registration. The online editor lives at https://editor.easytex.ir. Landing site: https://easytex.ir.",
    "contact": {
      "name": "EasyTeX Support",
      "email": "tex@ipm.ir",
      "url": "https://easytex.ir/contact"
    }
  },
  "servers": [
    {
      "url": "https://api.easytex.ir",
      "description": "EasyTeX production API"
    }
  ],
  "tags": [
    {
      "name": "templates",
      "description": "LaTeX template catalog"
    },
    {
      "name": "waitlist",
      "description": "Early access waitlist"
    }
  ],
  "paths": {
    "/api/templates": {
      "get": {
        "tags": [
          "templates"
        ],
        "summary": "List templates (paginated)",
        "operationId": "listTemplates",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 12
            }
          },
          {
            "name": "sortBy",
            "in": "query",
            "schema": {
              "type": "string",
              "default": "createdAt"
            }
          },
          {
            "name": "sortDirection",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ],
              "default": "desc"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paged template list",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedTemplateResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/templates/search": {
      "get": {
        "tags": [
          "templates"
        ],
        "summary": "Search templates",
        "operationId": "searchTemplates",
        "parameters": [
          {
            "name": "keyword",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "categories",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "tags",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "texliveVersion",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "compilerEngine",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 12
            }
          },
          {
            "name": "sortBy",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sortDirection",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "asc",
                "desc"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search results",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedTemplateResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/templates/metadata": {
      "get": {
        "tags": [
          "templates"
        ],
        "summary": "Get template metadata (categories, tags, LaTeX info)",
        "operationId": "getTemplateMetadata",
        "responses": {
          "200": {
            "description": "Metadata",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExtendedMetadata"
                }
              }
            }
          }
        }
      }
    },
    "/api/templates/{id}": {
      "get": {
        "tags": [
          "templates"
        ],
        "summary": "Get template by ID",
        "operationId": "getTemplate",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Template details",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Template"
                }
              }
            }
          },
          "404": {
            "description": "Template not found"
          }
        }
      }
    },
    "/api/templates/{id}/download": {
      "get": {
        "tags": [
          "templates"
        ],
        "summary": "Download template archive",
        "operationId": "downloadTemplate",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "ZIP archive",
            "content": {
              "application/zip": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "404": {
            "description": "Template not found"
          }
        }
      }
    },
    "/api/templates/{id}/preview-image": {
      "get": {
        "tags": [
          "templates"
        ],
        "summary": "Get template preview image",
        "operationId": "getTemplatePreviewImage",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Preview image",
            "content": {
              "image/*": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          }
        }
      }
    },
    "/api/templates/categories/{category}": {
      "get": {
        "tags": [
          "templates"
        ],
        "summary": "List templates by category",
        "operationId": "getTemplatesByCategory",
        "parameters": [
          {
            "name": "category",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 12
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paged templates",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedTemplateResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/templates/tags/{tag}": {
      "get": {
        "tags": [
          "templates"
        ],
        "summary": "List templates by tag",
        "operationId": "getTemplatesByTag",
        "parameters": [
          {
            "name": "tag",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 12
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paged templates",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedTemplateResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/templates/latex/texlive/{version}": {
      "get": {
        "tags": [
          "templates"
        ],
        "summary": "List templates by TeXLive version",
        "operationId": "getTemplatesByTexliveVersion",
        "parameters": [
          {
            "name": "version",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 12
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paged templates",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedTemplateResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/templates/latex/compiler/{engine}": {
      "get": {
        "tags": [
          "templates"
        ],
        "summary": "List templates by compiler engine",
        "operationId": "getTemplatesByCompilerEngine",
        "parameters": [
          {
            "name": "engine",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 12
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paged templates",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedTemplateResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/templates/latex/compatible": {
      "get": {
        "tags": [
          "templates"
        ],
        "summary": "List LaTeX-compatible templates",
        "operationId": "getLatexCompatibleTemplates",
        "parameters": [
          {
            "name": "texliveVersion",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "compilerEngine",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "size",
            "in": "query",
            "schema": {
              "type": "integer",
              "default": 12
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paged templates",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PagedTemplateResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/waitlist/register": {
      "post": {
        "tags": [
          "waitlist"
        ],
        "summary": "Register email on the EasyTeX waitlist",
        "operationId": "registerWaitlist",
        "parameters": [
          {
            "name": "email",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "format": "email"
            }
          },
          {
            "name": "source",
            "in": "query",
            "schema": {
              "type": "string",
              "example": "landing_page"
            }
          },
          {
            "name": "recaptchaToken",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Registration accepted"
          },
          "400": {
            "description": "Invalid request or duplicate email"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Template": {
        "type": "object",
        "required": [
          "id",
          "name",
          "description",
          "categories",
          "tags"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "categories": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "version": {
            "type": "string"
          },
          "createdBy": {
            "type": "string"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time"
          },
          "hasZipFile": {
            "type": "boolean"
          },
          "hasDemoImage": {
            "type": "boolean"
          },
          "downloadCount": {
            "type": "integer"
          },
          "active": {
            "type": "boolean"
          },
          "texliveVersion": {
            "type": "string"
          },
          "compilerEngine": {
            "type": "string"
          },
          "sourceLink": {
            "type": "string",
            "format": "uri"
          }
        }
      },
      "PagedTemplateResponse": {
        "type": "object",
        "properties": {
          "content": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Template"
            }
          },
          "totalElements": {
            "type": "integer"
          },
          "totalPages": {
            "type": "integer"
          },
          "size": {
            "type": "integer"
          },
          "number": {
            "type": "integer"
          },
          "first": {
            "type": "boolean"
          },
          "last": {
            "type": "boolean"
          }
        }
      },
      "ExtendedMetadata": {
        "type": "object",
        "properties": {
          "categories": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "latex": {
            "type": "object",
            "properties": {
              "texliveVersions": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "compilerEngines": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}