{
  "openapi": "3.1.0",
  "info": {
    "title": "Famim Farhaz Development Studio API",
    "description": "Public programmatic REST API for Famim Farhaz Development Studio. Access case studies, service packages, articles, availability, project inquiries, and the Lumen AI Assistant.",
    "version": "1.0.0",
    "x-rate-limit": {
      "limit": 100,
      "window": "60s",
      "policy": "100;w=60",
      "headers": [
        "RateLimit-Limit",
        "RateLimit-Remaining",
        "RateLimit-Reset",
        "RateLimit-Policy",
        "X-RateLimit-Limit",
        "X-RateLimit-Remaining",
        "X-RateLimit-Reset",
        "Retry-After"
      ]
    },
    "x-versioning-policy": {
      "strategy": "URI path versioning (/api/v1/*)",
      "currentVersion": "1.0.0",
      "deprecationNotice": "12 months minimum advance notice via Sunset and Deprecation headers",
      "policyDocumentation": "https://famimfarhaz.com/docs#versioning-and-deprecation"
    },
    "contact": {
      "name": "Famim Farhaz",
      "email": "hello@famimfarhaz.com",
      "url": "https://famimfarhaz.com"
    },
    "license": {
      "name": "MIT",
      "url": "https://opensource.org/licenses/MIT"
    }
  },
  "servers": [
    {
      "url": "https://famimfarhaz.com/api/v1",
      "description": "Production API Server"
    }
  ],
  "paths": {
    "/health": {
      "get": {
        "summary": "Check API health status",
        "description": "Returns the current health and operational status of the Famim Farhaz API.",
        "operationId": "getHealthStatus",
        "responses": {
          "200": {
            "description": "API is operational",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": ["status", "timestamp", "service"],
                  "properties": {
                    "status": { "type": "string", "example": "ok" },
                    "timestamp": { "type": "string", "format": "date-time", "example": "2026-08-26T12:00:00Z" },
                    "service": { "type": "string", "example": "famim-farhaz-api" }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/projects": {
      "get": {
        "summary": "List portfolio projects and case studies",
        "description": "Retrieves the list of featured client projects, case studies, and studio concept websites built by Famim Farhaz.",
        "operationId": "listProjects",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "Maximum number of projects to return",
            "schema": { "type": "integer", "default": 10, "minimum": 1, "maximum": 50 }
          }
        ],
        "responses": {
          "200": {
            "description": "List of portfolio projects",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": ["projects", "count"],
                  "properties": {
                    "count": { "type": "integer", "example": 5 },
                    "projects": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/Project"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/projects/{id}": {
      "get": {
        "summary": "Get project details by ID",
        "description": "Retrieves comprehensive information, technical challenges, solutions, and outcomes for a specific portfolio project.",
        "operationId": "getProjectById",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "Unique identifier of the project (e.g. abrynth-animations, veldenberg-case-study)",
            "schema": { "type": "string", "example": "abrynth-animations" }
          }
        ],
        "responses": {
          "200": {
            "description": "Project details found",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/Project" }
              }
            }
          },
          "404": {
            "description": "Project not found",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" }
              }
            }
          }
        }
      }
    },
    "/services": {
      "get": {
        "summary": "List studio services and packages",
        "description": "Retrieves all development and design services offered by Famim Farhaz Development Studio, including deliverables and best-fit client types.",
        "operationId": "listServices",
        "responses": {
          "200": {
            "description": "List of studio services",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": ["services"],
                  "properties": {
                    "services": {
                      "type": "array",
                      "items": { "$ref": "#/components/schemas/Service" }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/blog": {
      "get": {
        "summary": "List engineering insights and blog articles",
        "description": "Retrieves published articles, hospitality engineering guides, and conversion optimization insights.",
        "operationId": "listBlogPosts",
        "responses": {
          "200": {
            "description": "List of articles",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": ["posts", "count"],
                  "properties": {
                    "count": { "type": "integer", "example": 3 },
                    "posts": {
                      "type": "array",
                      "items": { "$ref": "#/components/schemas/BlogPost" }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/blog/{slug}": {
      "get": {
        "summary": "Get article by slug",
        "description": "Retrieves a specific article by URL slug.",
        "operationId": "getBlogPostBySlug",
        "parameters": [
          {
            "name": "slug",
            "in": "path",
            "required": true,
            "description": "Article URL slug",
            "schema": { "type": "string", "example": "stopped-building-local-business-websites-2026" }
          }
        ],
        "responses": {
          "200": {
            "description": "Article details",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/BlogPost" }
              }
            }
          },
          "404": {
            "description": "Article not found",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" }
              }
            }
          }
        }
      }
    },
    "/chat": {
      "post": {
        "summary": "Send message to Lumen AI Assistant",
        "description": "Allows users and AI agents to converse with Lumen, the studio's AI assistant, to inquire about services, portfolio fit, and scheduling.",
        "operationId": "sendChatMessage",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["messages"],
                "properties": {
                  "messages": {
                    "type": "array",
                    "description": "Conversation message history",
                    "items": {
                      "type": "object",
                      "required": ["role", "content"],
                      "properties": {
                        "role": { "type": "string", "enum": ["user", "assistant", "system"], "example": "user" },
                        "content": { "type": "string", "example": "What services do you offer for boutique hotels?" }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Chat response generated",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": ["content"],
                  "properties": {
                    "content": { "type": "string", "example": "Famim builds custom, direct-booking websites for boutique hotels..." }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" }
              }
            }
          },
          "503": {
            "description": "Chatbot Service Unavailable",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" }
              }
            }
          }
        }
      }
    },
    "/contact": {
      "post": {
        "summary": "Submit project inquiry",
        "description": "Submits a project inquiry or consultation request directly to Famim Farhaz.",
        "operationId": "submitContactInquiry",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": ["name", "email", "message"],
                "properties": {
                  "name": { "type": "string", "example": "Alex Morgan" },
                  "email": { "type": "string", "format": "email", "example": "alex@boutiquehotel.com" },
                  "message": { "type": "string", "example": "We are looking for a bespoke website for our 30-key luxury retreat." },
                  "service": { "type": "string", "example": "Custom Website Development" },
                  "budget": { "type": "string", "example": "$5k-$10k" }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Inquiry successfully received",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": ["success", "message"],
                  "properties": {
                    "success": { "type": "boolean", "example": true },
                    "message": { "type": "string", "example": "Thank you! Your inquiry has been received. I will reply within 24 hours." }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Invalid input data",
            "content": {
              "application/json": {
                "schema": { "$ref": "#/components/schemas/ErrorResponse" }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Project": {
        "type": "object",
        "required": ["id", "title", "subtitle", "description", "scope"],
        "properties": {
          "id": { "type": "string", "example": "abrynth-animations" },
          "title": { "type": "string", "example": "Abrynth Animations." },
          "subtitle": { "type": "string", "example": "Independent Animation Studio" },
          "type": { "type": "string", "example": "Client Project (2025)" },
          "year": { "type": "string", "example": "2025" },
          "client": { "type": "string", "nullable": true, "example": "MD Zubayer Rana Abir" },
          "scope": { "type": "string", "example": "Web Design & Development" },
          "description": { "type": "string", "example": "Bespoke digital showroom and visual storytelling platform." },
          "liveLink": { "type": "string", "nullable": true, "example": "https://zubayerabir.art" },
          "problem": { "type": "string" },
          "solution": { "type": "string" },
          "results": {
            "type": "array",
            "items": { "type": "string" }
          }
        }
      },
      "Service": {
        "type": "object",
        "required": ["number", "title", "description"],
        "properties": {
          "number": { "type": "string", "example": "(001)" },
          "title": { "type": "string", "example": "Custom Website Development" },
          "description": { "type": "string", "example": "From blank canvas to a fully deployed, conversion-optimized website." },
          "package": { "type": "string", "example": "Full Stack package" }
        }
      },
      "BlogPost": {
        "type": "object",
        "required": ["id", "title", "slug", "excerpt"],
        "properties": {
          "id": { "type": "string", "example": "1" },
          "title": { "type": "string", "example": "Why I Stopped Building Websites for Local Businesses in 2026" },
          "slug": { "type": "string", "example": "stopped-building-local-business-websites-2026" },
          "date": { "type": "string", "example": "February 2026" },
          "readTime": { "type": "string", "example": "5 min read" },
          "excerpt": { "type": "string", "example": "A strategic shift toward high-converting hospitality platforms." }
        }
      },
      "ErrorResponse": {
        "type": "object",
        "required": ["error"],
        "properties": {
          "error": {
            "type": "object",
            "required": ["code", "message"],
            "properties": {
              "code": { "type": "string", "example": "RESOURCE_NOT_FOUND" },
              "message": { "type": "string", "example": "The requested resource could not be found." },
              "resolution": { "type": "string", "example": "Verify the endpoint path using GET /openapi.json or consult https://famimfarhaz.com/docs" }
            }
          }
        }
      }
    }
  }
}