CleanSlice API

openapi: 3.1.0
info:
  title: CleanSlice API
  version: '2026-11-04'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-04: 8 operation(s) read from 3 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; CleanSlice has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 6
    pages-with-code: 1
    pages-read: 3
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-04'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://cleanslice.org/backend/api-docs.html
  - https://cleanslice.org/backend/email.html
  - https://cleanslice.org/backend/controllers.html
paths:
  /api/v1/messages:
    delete:
      operationId: delete_api_v1_messages
      tags:
      - Api
      summary: DELETE /api/v1/messages
      x-source: https://cleanslice.org/backend/email.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -s -X DELETE http://localhost:8025/api/v1/messages # empty it between tests A green build proves the code compiles. The
          Mailpit round trip proves the relay handshake. What''s Next? ​ Gateways -- Abstract class in domain, implementation in data Error Handling
          -- BaseError and error codes Setup Slices -- Where the mail slice sits among the others Pager Previous page Slice Structure Next page
          Con'
    get:
      operationId: get_api_v1_messages
      tags:
      - Api
      summary: GET /api/v1/messages
      x-source: https://cleanslice.org/backend/email.html
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -s http://localhost:8025/api/v1/messages | jq ''.messages[] | {From, To, Subject}'' '
  /users:
    get:
      operationId: get_users
      tags:
      - Users
      summary: List all users
      x-source: https://cleanslice.org/backend/api-docs.html
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUsersResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_users
      tags:
      - Users
      summary: Create a new user
      x-source: https://cleanslice.org/backend/api-docs.html
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostUsersRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostUsersResponse'
      x-evidence:
        kind: documentation
  /users/{id}:
    delete:
      operationId: delete_users_id
      tags:
      - Users
      summary: Delete user
      x-source: https://cleanslice.org/backend/controllers.html
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_users_id
      tags:
      - Users
      summary: Get user by ID
      x-source: https://cleanslice.org/backend/api-docs.html
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUsersIdResponse'
      x-evidence:
        kind: documentation
    put:
      operationId: put_users_id
      tags:
      - Users
      summary: Update user
      x-source: https://cleanslice.org/backend/controllers.html
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutUsersIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutUsersIdResponse'
      x-evidence:
        kind: documentation
  /users/{id}/activate:
    post:
      operationId: post_users_id_activate
      tags:
      - Users
      summary: activateUser
      x-source: https://cleanslice.org/backend/controllers.html
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetUsersResponse:
      type: object
      properties:
        data:
          type: array
          description: Array of UserDto objects
        success:
          type: boolean
          description: Indicates request success
    PostUsersRequest:
      type: object
      properties:
        data:
          type: string
          description: User creation payload
      required:
      - data
    PostUsersResponse:
      type: object
      properties:
        id:
          type: string
          description: User identifier
        email:
          type: string
          description: User email
        name:
          type: string
          description: User name
        phone:
          type: string
          description: User phone (optional)
        createdAt:
          type: string
          description: Creation timestamp
    GetUsersIdResponse:
      type: object
      properties:
        data:
          type: string
          description: User data
        success:
          type: boolean
          description: Indicates request success
    PutUsersIdRequest:
      type: object
      properties:
        data:
          type: string
          description: User update payload
      required:
      - data
    PutUsersIdResponse:
      type: object
      properties:
        data:
          type: object
          description: UserDto
  securitySchemes:
    defaultBearerAuth:
      type: http
      scheme: bearer
      x-source: https://cleanslice.org/backend/getting-started.html
tags:
- name: Api
- name: Users
security:
- defaultBearerAuth: []