FairePlace Amendment Documents API

openapi: 3.2.0
info:
  title: FairePlace Property Management Amendment Documents API
  description: 'Comprehensive API for managing properties, leases, tenants, and all aspects of real estate management.

    Built with Rust and Actix-web following hexagonal architecture principles.


    ## Authentication

    This API uses API keys for authentication with tenant-based isolation.


    ## Base URL

    - Production: `https://api.faireplace.com/api`'
  version: 1.0.0
  contact:
    name: FairePlace API Support
    email: api-support@faireplace.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: https://api.faireplace.com/api
  description: Production server
security:
- BearerAuth: []
tags:
- name: Amendment Documents
  description: Documents attached to a lease amendment (avenant).
paths:
  /leases/{lease_id}/amendments/{amendment_id}/documents:
    get:
      operationId: listAmendmentDocuments
      summary: List amendment documents
      description: Returns all documents attached to an amendment (drafts, signed copies, supporting documents).
      tags:
      - Amendment Documents
      security:
      - BearerAuth: []
      parameters:
      - name: lease_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: amendment_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: List of documents
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AmendmentDocumentResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    post:
      operationId: createAmendmentDocument
      summary: Attach a document to an amendment
      tags:
      - Amendment Documents
      security:
      - BearerAuth: []
      parameters:
      - name: lease_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: amendment_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAmendmentDocumentDto'
      responses:
        '201':
          description: Document created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmendmentDocumentResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /leases/{lease_id}/amendments/{amendment_id}/documents/{document_id}:
    get:
      operationId: getAmendmentDocument
      summary: Get a specific document
      tags:
      - Amendment Documents
      security:
      - BearerAuth: []
      parameters:
      - name: lease_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: amendment_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Document details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmendmentDocumentResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateAmendmentDocument
      summary: Update an amendment document
      tags:
      - Amendment Documents
      security:
      - BearerAuth: []
      parameters:
      - name: lease_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: amendment_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAmendmentDocumentDto'
      responses:
        '200':
          description: Document updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmendmentDocumentResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteAmendmentDocument
      summary: Delete an amendment document
      tags:
      - Amendment Documents
      security:
      - BearerAuth: []
      parameters:
      - name: lease_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: amendment_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Document deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /leases/{lease_id}/amendments/{amendment_id}/documents/{document_id}/validate:
    put:
      operationId: validateAmendmentDocument
      summary: Validate an amendment document
      description: Mark a document as validated by a specific user.
      tags:
      - Amendment Documents
      security:
      - BearerAuth: []
      parameters:
      - name: lease_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: amendment_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: document_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateAmendmentDocumentDto'
      responses:
        '200':
          description: Document validated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmendmentDocumentResponse'
        '400':
          description: Document already validated
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    ValidateAmendmentDocumentDto:
      type: object
      required:
      - validated_by
      properties:
        validated_by:
          type: string
          format: uuid
          description: ID of the user validating the document
    AmendmentDocumentResponse:
      type: object
      description: Document attached to an amendment
      required:
      - id
      - amendment_id
      - document_type
      - file_path
      - upload_date
      - is_validated
      properties:
        id:
          type: string
          format: uuid
        amendment_id:
          type: string
          format: uuid
        document_type:
          type: string
          description: Type of document
          enum:
          - DRAFT
          - SIGNED_COPY
          - SUPPORTING_DOCUMENT
          - NOTICE
          - CALCULATION_DETAILS
          - LEGAL_NOTICE
          example: DRAFT
        file_path:
          type: string
          description: Path to the stored document (e.g., /api/media/serve/{media_id})
        upload_date:
          type: string
          format: date-time
        is_validated:
          type: boolean
          description: Whether the document has been validated
        validation_date:
          type:
          - string
          - 'null'
          format: date-time
        validated_by:
          type:
          - string
          - 'null'
          format: uuid
        notes:
          type:
          - string
          - 'null'
    UpdateAmendmentDocumentDto:
      type: object
      description: 'Partial update of an amendment document. Every field is optional: send only

        what changes.

        '
      properties:
        document_type:
          type: string
          enum:
          - DRAFT
          - SIGNED_COPY
          - SUPPORTING_DOCUMENT
          - NOTICE
          - CALCULATION_DETAILS
          - LEGAL_NOTICE
        file_path:
          type: string
          maxLength: 500
        notes:
          type:
          - string
          - 'null'
          maxLength: 1000
    Error:
      type: object
      description: "The error envelope returned by every authenticated endpoint.\n\nTwo things are worth knowing before you write your error handling:\n\n- **`code` is a symbolic string, not a number.** The numeric HTTP status is\n  in `status`. Branch on `code`: it is stable, and show `message`, which\n  is written for humans and may be reworded without notice.\n- The public guest-signature endpoints use a **different, flatter shape**\n  (`{ \"error_code\": …, \"message\": … }`, no `error` wrapper), because they\n  are consumed by a page that has no session. Their responses document it\n  inline.\n\nThe `X-Request-Id` response header carries the request identifier: quote it\nwhen reporting a problem. It is a header, not a body field.\n"
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - status
          properties:
            code:
              type: string
              description: Stable symbolic code. Branch on this.
              enum:
              - NOT_FOUND
              - UNAUTHORIZED
              - VALIDATION_ERROR
              - DATABASE_ERROR
              - BUSINESS_ERROR
              - STORAGE_ERROR
              - CONFIG_ERROR
              - FORBIDDEN
              - CONFLICT
              - PARSE_ERROR
              - SERIALIZATION_ERROR
              - AUTHENTICATION_ERROR
              - AUTHORIZATION_ERROR
              - EXTERNAL_SERVICE_ERROR
              - RATE_LIMIT_EXCEEDED
              - PAYMENT_REQUIRED
              - PLAN_LIMIT_REACHED
              - GONE
              - BAD_REQUEST
              - INTERNAL_ERROR
              - INTERNAL_SERVER_ERROR
              example: NOT_FOUND
            message:
              type: string
              description: 'Human-readable explanation, most often in French. Safe to display,

                not safe to parse.

                '
              example: Lease not found
            status:
              type: integer
              description: The HTTP status code, repeated in the body.
              example: 404
            details:
              type: object
              additionalProperties: true
              description: 'Extra machine-readable context. Only present on some errors: on

                `RATE_LIMIT_EXCEEDED` it carries `retry_after_seconds`.

                '
              example:
                retry_after_seconds: 12
    CreateAmendmentDocumentDto:
      type: object
      required:
      - document_type
      - file_path
      properties:
        document_type:
          type: string
          enum:
          - DRAFT
          - SIGNED_COPY
          - SUPPORTING_DOCUMENT
          - NOTICE
          - CALCULATION_DETAILS
          - LEGAL_NOTICE
        file_path:
          type: string
          maxLength: 500
        notes:
          type:
          - string
          - 'null'
          maxLength: 1000
  responses:
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: API key with fp_* prefix, passed as Bearer token
    WorkerApiKey:
      type: apiKey
      in: header
      name: X-API-Key
    WorkerBearer:
      type: http
      scheme: bearer
      bearerFormat: Worker