FairePlace Amendment Duration Details API

openapi: 3.2.0
info:
  title: FairePlace Property Management Amendment Duration Details…
  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 Duration Details
  description: Duration changes carried by an amendment.
paths:
  /leases/{lease_id}/amendments/{amendment_id}/duration-detail:
    post:
      operationId: createAmendmentDurationDetail
      summary: Create duration modification details
      description: 'Create the duration detail for a `DURATION_MODIFICATION` or `RENEWAL` amendment. Only one duration detail can exist per amendment (1:1 relationship).


        **Validation rules:**

        - For extensions/renewals: `new_end_date` must be > `previous_end_date`

        - For reductions/early termination: `new_end_date` can be <= `previous_end_date`'
      tags:
      - Amendment Duration Details
      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/CreateAmendmentDurationDetailDto'
      responses:
        '201':
          description: Duration detail created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmendmentDurationDetailResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '409':
          description: A duration detail already exists for this amendment
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
    get:
      operationId: getAmendmentDurationDetail
      summary: Get duration modification details
      tags:
      - Amendment Duration Details
      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: Duration detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmendmentDurationDetailResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateAmendmentDurationDetail
      summary: Update duration modification details
      description: 'Update the duration detail for an amendment. Since duration detail is a 1:1 relationship, no detail ID is needed: the system identifies the detail by amendment ID.'
      tags:
      - Amendment Duration Details
      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/UpdateAmendmentDurationDetailDto'
      responses:
        '200':
          description: Duration detail updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AmendmentDurationDetailResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteAmendmentDurationDetail
      summary: Delete duration modification details
      description: Delete the duration detail for an amendment. Since duration detail is a 1:1 relationship, no detail ID is needed.
      tags:
      - Amendment Duration Details
      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:
        '204':
          description: Duration detail deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    UpdateAmendmentDurationDetailDto:
      type: object
      description: Data for updating duration modification details
      properties:
        previous_end_date:
          type:
          - string
          - 'null'
          format: date
        new_end_date:
          type:
          - string
          - 'null'
          format: date
        extension_type:
          type:
          - string
          - 'null'
          enum:
          - RENEWAL
          - EXTENSION
          - REDUCTION
          - EARLY_TERMINATION
          - null
        reason_code:
          type:
          - string
          - 'null'
        reason_details:
          type:
          - string
          - 'null'
    CreateAmendmentDurationDetailDto:
      type: object
      description: Data for creating duration modification details
      required:
      - previous_end_date
      - new_end_date
      - extension_type
      properties:
        previous_end_date:
          type: string
          format: date
        new_end_date:
          type: string
          format: date
        extension_type:
          type: string
          enum:
          - RENEWAL
          - EXTENSION
          - REDUCTION
          - EARLY_TERMINATION
        reason_code:
          type:
          - string
          - 'null'
          maxLength: 50
        reason_details:
          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
    AmendmentDurationDetailResponse:
      type: object
      description: Duration modification details for a DURATION_MODIFICATION or RENEWAL amendment (1:1 relationship)
      required:
      - id
      - amendment_id
      - previous_end_date
      - new_end_date
      - extension_type
      properties:
        id:
          type: string
          format: uuid
        amendment_id:
          type: string
          format: uuid
        previous_end_date:
          type: string
          format: date
          description: Previous lease end date
          example: '2025-12-31'
        new_end_date:
          type: string
          format: date
          description: New lease end date. Must be > previous_end_date for extensions (not for REDUCTION/EARLY_TERMINATION)
          example: '2028-12-31'
        extension_type:
          type: string
          description: Type of duration change
          enum:
          - RENEWAL
          - EXTENSION
          - REDUCTION
          - EARLY_TERMINATION
          example: RENEWAL
        reason_code:
          type:
          - string
          - 'null'
          description: Reason code
          maxLength: 50
        reason_details:
          type:
          - string
          - 'null'
          description: Detailed reason
          maxLength: 1000
  responses:
    UnprocessableEntity:
      description: Unprocessable Entity
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    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