forked from dotkernel/api-documentation
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmkdocs.yml
More file actions
160 lines (160 loc) · 8.34 KB
/
mkdocs.yml
File metadata and controls
160 lines (160 loc) · 8.34 KB
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
docs_dir: docs/book
site_dir: docs/html
extra:
project: API
current_version: v6
versions:
- v4
- v5
- v6
nav:
- Home: index.md
- v6:
- Introduction: v6/introduction/introduction.md
- Overview:
- "Server Requirements": v6/introduction/server-requirements.md
- "File Structure": v6/introduction/file-structure.md
- "Packages": v6/introduction/packages.md
- "PSRs": v6/introduction/psr.md
- Installation:
- "Getting Started": v6/installation/getting-started.md
- "Composer": v6/installation/composer.md
- "Configuration Files": v6/installation/configuration-files.md
- "Doctrine ORM": v6/installation/doctrine-orm.md
- "Test the Installation": v6/installation/test-the-installation.md
- "FAQ": v6/installation/faq.md
- Upgrading:
- "Upgrade procedure": v6/upgrading/upgrading.md
- "Upgrading 5.* to 6.0": v6/upgrading/UPGRADE-6.0.md
- Flow:
- "Middleware Flow": v6/flow/middleware-flow.md
- "Default Library Flow": v6/flow/default-library-flow.md
- "Library Flow for Email": v6/flow/library-flow-for-email.md
- Core Features:
- "Authentication": v6/core-features/authentication.md
- "Authorization": v6/core-features/authorization.md
- "Content Validation": v6/core-features/content-validation.md
- "Exceptions": v6/core-features/exceptions.md
- "Dependency Injection": v6/core-features/dependency-injection.md
- "Error reporting": v6/core-features/error-reporting.md
- Extended features:
- "Core and App": v6/extended-features/core-and-app.md
- "New Handler Structure": v6/extended-features/handler-structure.md
- Commands:
- "Create admin account": v6/commands/create-admin-account.md
- "Generate database migrations": v6/commands/generate-database-migrations.md
- "Display available endpoints": v6/commands/display-available-endpoints.md
- "Generate tokens": v6/commands/generate-tokens.md
- Tutorials:
- "Setting up CORS": v6/tutorials/cors.md
- "Creating a book module": v6/tutorials/create-book-module.md
- "Token authentication": v6/tutorials/token-authentication.md
- "API Evolution": v6/tutorials/api-evolution.md
- "Find user by identity": v6/tutorials/find-user-by-identity.md
- Transition from API Tools:
- "Laminas API Tools vs Dotkernel API": v6/transition-from-api-tools/api-tools-vs-dotkernel-api.md
- "Transition Approach": v6/transition-from-api-tools/transition-approach.md
- "Discovery Phase": v6/transition-from-api-tools/discovery-phase.md
- OpenAPI:
- "Introduction": v6/openapi/introduction.md
- "Initialized Components": v6/openapi/initialized-components.md
- "Write Documentation": v6/openapi/write-documentation.md
- "Generate Documentation": v6/openapi/generate-documentation.md
- "Render Documentation": v6/openapi/render-documentation.md
- "Use Documentation": v6/openapi/use-documentation.md
- "Getting Help": v6/openapi/getting-help.md
- Reference:
- "Anonymize Accounts": v6/reference/account-anonymization.md
- v5:
- Introduction: v5/introduction/introduction.md
- Overview:
- "Server Requirements": v5/introduction/server-requirements.md
- "File Structure": v5/introduction/file-structure.md
- "Packages": v5/introduction/packages.md
- "PSRs": v5/introduction/psr.md
- Installation:
- "Getting Started": v5/installation/getting-started.md
- "Composer": v5/installation/composer.md
- "Configuration Files": v5/installation/configuration-files.md
- "Doctrine ORM": v5/installation/doctrine-orm.md
- "Test the Installation": v5/installation/test-the-installation.md
- "FAQ": v5/installation/faq.md
- Upgrading:
- "Upgrade procedure": v5/upgrading/upgrading.md
- "Upgrading 5.2 to 5.3": v5/upgrading/UPGRADE-5.3.md
- Flow:
- "Middleware Flow": v5/flow/middleware-flow.md
- "Default Library Flow": v5/flow/default-library-flow.md
- "Library Flow for Email": v5/flow/library-flow-for-email.md
- Core Features:
- "Authentication": v5/core-features/authentication.md
- "Authorization": v5/core-features/authorization.md
- "Content Validation": v5/core-features/content-validation.md
- "Exceptions": v5/core-features/exceptions.md
- "Dependency Injection": v5/core-features/dependency-injection.md
- "Error reporting": v5/core-features/error-reporting.md
- Commands:
- "Create admin account": v5/commands/create-admin-account.md
- "Generate database migrations": v5/commands/generate-database-migrations.md
- "Display available endpoints": v5/commands/display-available-endpoints.md
- "Generate tokens": v5/commands/generate-tokens.md
- Tutorials:
- "Setting up CORS": v5/tutorials/cors.md
- "Creating a book module": v5/tutorials/create-book-module.md
- "Token authentication": v5/tutorials/token-authentication.md
- "API Evolution": v5/tutorials/api-evolution.md
- "Find user by identity": v5/tutorials/find-user-by-identity.md
- Transition from API Tools:
- "Laminas API Tools vs Dotkernel API": v5/transition-from-api-tools/api-tools-vs-dotkernel-api.md
- "Transition Approach": v5/transition-from-api-tools/transition-approach.md
- "Discovery Phase": v5/transition-from-api-tools/discovery-phase.md
- OpenAPI:
- "Introduction": v5/openapi/introduction.md
- "Initialized Components": v5/openapi/initialized-components.md
- "Write Documentation": v5/openapi/write-documentation.md
- "Generate Documentation": v5/openapi/generate-documentation.md
- "Render Documentation": v5/openapi/render-documentation.md
- "Use Documentation": v5/openapi/use-documentation.md
- "Getting Help": v5/openapi/getting-help.md
- Reference:
- "Anonymize Accounts": v5/reference/account-anonymization.md
- v4:
- Introduction: v4/introduction/introduction.md
- Overview:
- "Server Requirements": v4/introduction/server-requirements.md
- "File Structure": v4/introduction/file-structure.md
- "Packages": v4/introduction/packages.md
- Installation:
- "Getting Started": v4/installation/getting-started.md
- "Composer": v4/installation/composer.md
- "Configuration Files": v4/installation/configuration-files.md
- "Doctrine ORM": v4/installation/doctrine-orm.md
- "Test the Installation": v4/installation/test-the-installation.md
- "FAQ": v4/installation/faq.md
- Flow:
- "Middleware Flow": v4/flow/middleware-flow.md
- "Default Library Flow": v4/flow/default-library-flow.md
- "Library Flow for Email": v4/flow/library-flow-for-email.md
- Core Features:
- "Authentication": v4/core-features/authentication.md
- "Authorization": v4/core-features/authorization.md
- "Content Validation": v4/core-features/content-validation.md
- "Exceptions": v4/core-features/exceptions.md
- "CORS": v4/core-features/cors.md
- Commands:
- "Create admin account": v4/commands/create-admin-account.md
- "Generate database migrations": v4/commands/generate-database-migrations.md
- "Display available endpoints": v4/commands/display-available-endpoints.md
- "Generate tokens": v4/commands/generate-tokens.md
- Tutorials:
- "Creating a book module": v4/tutorials/create-book-module.md
- "Token authentication": v4/tutorials/token-authentication.md
- Transition from API Tools:
- "Laminas API Tools vs Dotkernel API": v4/transition-from-api-tools/api-tools-vs-dotkernel-api.md
- "Transition Approach": v4/transition-from-api-tools/transition-approach.md
- "Discovery Phase": v4/transition-from-api-tools/discovery-phase.md
site_name: api
site_description: "Dotkernel API"
repo_url: "https://github.com/dotkernel/api"
plugins:
- search