Skip to content

Commit 079e0e7

Browse files
committed
Fixed versioning URLs and other small fixes
Signed-off-by: alexmerlin <[email protected]>
1 parent 1c89409 commit 079e0e7

File tree

7 files changed

+16
-150
lines changed

7 files changed

+16
-150
lines changed

docs/book/v4/transition-from-api-tools/discovery-phase.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

docs/book/v4/transition-from-api-tools/transition-approach.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/book/v5/transition-from-api-tools/discovery-phase.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

docs/book/v5/transition-from-api-tools/transition-approach.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/book/v6/transition-from-api-tools/discovery-phase.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,32 @@
11
# Discovery phase for a current system built using API Tools [WIP]
22

3-
In order to transition a system built using api-tools to Dotkernel API , we need to analyze the core components
4-
of it.
3+
To transition a system built using api-tools to Dotkernel API, we need to analyze the core components of it.
54

65
## Database
76

8-
- there is a database in the current API ?
9-
- which is the connection to database
10-
- which library is used for database interaction ( laminas-db, doctrine 2, eloquent, or else )
7+
- is there a database in the current API?
8+
- which is the connection to a database
9+
- which library is used for database interaction (laminas-db, doctrine 2, eloquent, or else)?
1110

1211
### Note
1312

14-
> Dotkernel API is tested only with MariaDB version 10.6 and 10.11 LTS
13+
> Dotkernel API is tested only with MariaDB version 10.6, 10.11 LTS, 11.4 LTS, and 11.8 LTS
1514
1615
## Authentication and Authorization
1716

18-
- how authentication is done ? (basic, digest, oauth2, etc.)
19-
- how authorization is done ? (acl, rbac)
17+
- how is authentication done? (basic, digest, oauth2, etc.)
18+
- how is authorization done? (acl, rbac)
2019

2120
## Modules
2221

23-
- analyze configuration files of the modules (what needs to be configured in order to use a module)
24-
- analyze routes (which are the routes, protection rules, which one need auth, etc.)
25-
- analyze response format (content negotiation and validation, which ones are json, hal, views, etc.)
22+
- analyze configuration files of the modules (what needs to be configured to use a module)
23+
- analyze routes (which are the routes, protection rules, which one needs auth, etc.)
24+
- analyze a response format (content negotiation and validation, which ones are JSON, hal, views, etc.)
2625
- analyze input field validations
2726

2827
## Custom functionalities
2928

30-
Analyze the custom code (code that cannot be generated through Admin UI and require manual implementation)
29+
Analyze the custom code (code that cannot be generated through Admin UI and requires manual implementation)
3130

3231
For instance:
3332

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
11
# Transition approach [WIP]
22

3-
Dotkernel API is not a one-to-one replacement of api-tools ( former Apigility), but is only a potential solution to
4-
migrate to.
3+
Dotkernel API is not a one-to-one replacement of api-tools (former Apigility), but is only a potential solution to migrate to.
54

65
Functionalities, components and architecture are different.
76

8-
See
9-
the [Comparison between Dotkernel APi and api-tools](https://docs.dotkernel.org/api-documentation/v4/transition-from-api-tools/api-tools-vs-dotkernel-api/)
7+
See the [Comparison between Dotkernel APi and api-tools](https://docs.dotkernel.org/api-documentation/v4/transition-from-api-tools/api-tools-vs-dotkernel-api/).
108

119
## Business cases
1210

13-
There are at least 2 approaches for this transition:
11+
There are at least two approaches for this transition:
1412

15-
### Clone 1:1
16-
17-
and recreate all endpoints and entities
18-
19-
### Build a new version of the current API using Dotkernel API
20-
21-
and keep it running as separate platforms until the sunset of the current version of api-tools
13+
- Clone 1:1 and recreate all endpoints and entities
14+
- Build a new version of the current API using Dotkernel API and keep it running as separate platforms until the sunset of the current version of api-tools

mkdocs.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,6 @@ nav:
114114
- "Find user by identity": v5/tutorials/find-user-by-identity.md
115115
- Transition from API Tools:
116116
- "Laminas API Tools vs Dotkernel API": v5/transition-from-api-tools/api-tools-vs-dotkernel-api.md
117-
- "Transition Approach": v5/transition-from-api-tools/transition-approach.md
118-
- "Discovery Phase": v5/transition-from-api-tools/discovery-phase.md
119117
- OpenAPI:
120118
- "Introduction": v5/openapi/introduction.md
121119
- "Initialized Components": v5/openapi/initialized-components.md
@@ -159,8 +157,6 @@ nav:
159157
- "Token authentication": v4/tutorials/token-authentication.md
160158
- Transition from API Tools:
161159
- "Laminas API Tools vs Dotkernel API": v4/transition-from-api-tools/api-tools-vs-dotkernel-api.md
162-
- "Transition Approach": v4/transition-from-api-tools/transition-approach.md
163-
- "Discovery Phase": v4/transition-from-api-tools/discovery-phase.md
164160
site_name: api
165161
site_description: "Dotkernel API"
166162
repo_url: "https://github.com/dotkernel/api"

0 commit comments

Comments
 (0)