auth-framework 0.5.0-rc19

A comprehensive, production-ready authentication and authorization framework for Rust applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

# Common Schemas

ApiResponse:
    type: object
    description: Standard API response wrapper used by the REST handlers.
    properties:
        success:
            type: boolean
            example: true
        data:
            description: Response payload. Omitted when the endpoint returns no typed payload.
        error:
            $ref: "#/ApiError"
        message:
            type: string
            description: Optional human-readable message emitted by some success and error responses.
            example: "Password changed successfully"
    required:
        - success

ApiError:
    type: object
    description: Machine-readable and human-readable error details attached to a failed ApiResponse.
    properties:
        code:
            type: string
            example: "INVALID_CREDENTIALS"
        message:
            type: string
            example: "The provided credentials are invalid"
        details:
            type: object
            nullable: true
            description: Optional structured error context.
    required:
        - code
        - message

Pagination:
    type: object
    description: Pagination metadata returned by list-style endpoints.
    properties:
        page:
            type: integer
            minimum: 1
            example: 1
        limit:
            type: integer
            minimum: 1
            maximum: 100
            example: 20
        total:
            type: integer
            minimum: 0
            example: 150
        pages:
            type: integer
            minimum: 1
            example: 8
    required:
        - page
        - limit
        - total
        - pages

PaginatedResponse:
    allOf:
        - $ref: "#/ApiResponse"
        - type: object
          properties:
              data:
                  type: object
                  properties:
                      items:
                          type: array
                          items:
                              type: object
                      pagination:
                          $ref: "#/Pagination"
                  required:
                      - items
                      - pagination