openapi: 3.1.0
info:
  title: Ameer Albehar Shipping Public API Catalog
  version: "1.0.0"
  summary: Public machine-readable catalog for Ameer Albehar Shipping.
  description: >
    This OpenAPI catalog describes public, read-only discovery resources for
    Ameer Albehar Shipping. It does not expose private booking, shipment,
    tracking, invoice, customer, quotation, or operational APIs.
  contact:
    name: Ameer Albehar Shipping
    email: info@ameer-shipping.com
    url: https://ameer-shipping.com/
servers:
  - url: https://ameer-shipping.com
    description: Official production website
tags:
  - name: Website
    description: Public website pages.
  - name: Discovery
    description: Public machine-readable discovery files.
  - name: Articles
    description: Public article pages.
paths:
  /:
    get:
      tags: [Website]
      operationId: getHomepage
      summary: Arabic homepage
      description: Returns the Arabic homepage with company overview, services, articles link, profile, FAQ, and contact information.
      responses:
        "200":
          description: HTML page
          content:
            text/html:
              schema:
                type: string
  /en.html:
    get:
      tags: [Website]
      operationId: getEnglishHomepage
      summary: English homepage
      description: Returns the English homepage with company overview, services, articles link, profile, FAQ, and contact information.
      responses:
        "200":
          description: HTML page
          content:
            text/html:
              schema:
                type: string
  /articles.html:
    get:
      tags: [Articles]
      operationId: getArabicArticlesIndex
      summary: Arabic articles index
      description: Returns the Arabic article library for shipping, container freight, customs clearance, and logistics topics.
      responses:
        "200":
          description: HTML page
          content:
            text/html:
              schema:
                type: string
  /articles-en.html:
    get:
      tags: [Articles]
      operationId: getEnglishArticlesIndex
      summary: English articles index
      description: Returns the English article library for shipping, container freight, customs clearance, and logistics topics.
      responses:
        "200":
          description: HTML page
          content:
            text/html:
              schema:
                type: string
  /openapi.yaml:
    get:
      tags: [Discovery]
      operationId: getOpenApiCatalog
      summary: OpenAPI catalog
      description: Returns this public read-only OpenAPI catalog.
      responses:
        "200":
          description: OpenAPI YAML
          content:
            application/yaml:
              schema:
                type: string
            text/yaml:
              schema:
                type: string
  /api-catalog.json:
    get:
      tags: [Discovery]
      operationId: getApiCatalogJson
      summary: JSON API discovery catalog
      description: Returns a JSON discovery catalog for AI agents and crawlers.
      responses:
        "200":
          description: JSON catalog
          content:
            application/json:
              schema:
                type: object
  /docs/api.html:
    get:
      tags: [Discovery]
      operationId: getApiDocumentationPage
      summary: API documentation page
      description: Returns a human-readable API documentation page linking to machine-readable catalogs.
      responses:
        "200":
          description: HTML page
          content:
            text/html:
              schema:
                type: string
  /llms.txt:
    get:
      tags: [Discovery]
      operationId: getLlmsTxt
      summary: AI and LLM discovery file
      description: Returns AI-readable site guidance and links to the OpenAPI catalog.
      responses:
        "200":
          description: Plain text
          content:
            text/plain:
              schema:
                type: string
  /robots.txt:
    get:
      tags: [Discovery]
      operationId: getRobotsTxt
      summary: Robots file
      description: Returns crawler directives and sitemap location.
      responses:
        "200":
          description: Plain text
          content:
            text/plain:
              schema:
                type: string
  /sitemap.xml:
    get:
      tags: [Discovery]
      operationId: getSitemapXml
      summary: XML sitemap
      description: Returns public sitemap.
      responses:
        "200":
          description: XML sitemap
          content:
            application/xml:
              schema:
                type: string
components:
  schemas:
    PublicPage:
      type: object
      properties:
        url:
          type: string
          format: uri
        title:
          type: string
        language:
          type: string
        content_type:
          type: string