openapi: 3.0.0
info:
  title: PropStack API
  version: 1.0.0
  description: API for interacting with the PropStack platform.
servers:
  - url: https://api.propstack.com/v1
    description: Production API server
paths:
  /properties:
    get:
      summary: List properties
      description: Retrieve a paginated list of properties for the authenticated user.
      responses:
        '200':
          description: A list of properties.
          content:
            application/json:
              schema:
                type: object
    post:
      summary: Create a property
      description: Create a new property listing.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Property created.
  /properties/{id}:
    get:
      summary: Get property details
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Property details.
    put:
      summary: Update a property
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Property updated.
    delete:
      summary: Delete a property
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '204':
          description: Property deleted.
  /users/me:
    get:
      summary: Get current user profile
      responses:
        '200':
          description: The authenticated user's profile.
  /agreements:
    get:
      summary: List tenancy agreements
      responses:
        '200':
          description: List of tenancy agreements.
    post:
      summary: Create an agreement
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Agreement created.
  /payments:
    get:
      summary: List payment history
      responses:
        '200':
          description: Payment history.
    post:
      summary: Process a payment
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Payment processed.
  /vehicles:
    get:
      summary: List vehicles
      responses:
        '200':
          description: Vehicle list.
    post:
      summary: Register a vehicle
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Vehicle registered.
  /deliveries:
    get:
      summary: List deliveries
      responses:
        '200':
          description: Delivery list.
    post:
      summary: Create a delivery request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Delivery request created.
  /marketplace/listings:
    get:
      summary: Browse marketplace listings
      responses:
        '200':
          description: Marketplace listings.
  /marketplace/shops:
    get:
      summary: List shops
      responses:
        '200':
          description: Marketplace shops.
  /marketplace/orders:
    get:
      summary: List marketplace orders
      responses:
        '200':
          description: Marketplace orders.
    post:
      summary: Place a marketplace order
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: Order placed.
  /notifications:
    get:
      summary: Get notifications
      responses:
        '200':
          description: Notifications list.
  /ai/rent-suggestion:
    post:
      summary: AI rent price suggestion
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Suggested rent.
  /ai/valuation:
    post:
      summary: AI property valuation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Valuation result.
  /ai/vacancy-prediction:
    post:
      summary: Property vacancy prediction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Vacancy prediction results.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
security:
  - bearerAuth: []