Skip to content

Commit 7d910aa

Browse files
alexmerlinalexmerlin
committed
Fixed versioning URLs and other small fixes
Signed-off-by: alexmerlin <[email protected]>
1 parent e326a94 commit 7d910aa

File tree

6 files changed

+70
-78
lines changed

6 files changed

+70
-78
lines changed

‎docs/book/v4/transition-from-api-tools/api-tools-vs-dotkernel-api.md‎

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
11
# Laminas API Tools compared to Dotkernel API
22

3-
| | API Tools (formerly Apigility) | Dotkernel API |
4-
|---------------------|------------------------------------------------|---------------------------------------------------------------------------------------|
5-
| URL | [api-tools](https://api-tools.getlaminas.org/) | [Dotkernel API](https://www.dotkernel.org) |
6-
| First Release | 2012 | 2018 |
7-
| PHP Version | <= 8.2 | >= 8.1 |
8-
| Architecture | MVC, Event Driven | Middleware |
9-
| OSS Lifecycle | Archived | ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/api?style=flat&label=) |
10-
| Style | REST, RPC | REST |
11-
| Versioning | Yes | Deprecations * |
12-
| Documentation | Swagger (Automated) | Postman (Manual) * |
13-
| Content-Negotiation | Custom | Custom |
14-
| License | BSD-3 | MIT |
15-
| Default DB Layer | laminas-db | doctrine-orm |
16-
| Authorization | ACL | RBAC-guard |
17-
| Authentication | HTTP Basic/Digest OAuth2.0 | OAuth2.0 |
18-
| CI/CD | Yes | Yes |
19-
| Unit Tests | Yes | Yes |
20-
| Endpoint Generator | Yes | Under development |
21-
| PSR | PSR-7 | PSR-7, PSR-15 |
3+
| | API Tools (formerly Apigility) | Dotkernel API |
4+
|---------------------|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
5+
| URL | [api-tools](https://api-tools.getlaminas.org/) | [Dotkernel API](https://www.dotkernel.org) |
6+
| First Release | 2012 | 2018 |
7+
| PHP Version | <= 8.2 | >= 8.2 |
8+
| Architecture | MVC, Event Driven | Middleware |
9+
| OSS Lifecycle | Archived | ![OSS Lifecycle](https://img.shields.io/osslifecycle?style=flat&label=&file_url=https%3A%2F%2Fgithub.com%2Fdotkernel%2Fapi%2Fblob%2F4.0%2FOSSMETADATA) |
10+
| Style | REST, RPC | REST |
11+
| Versioning | Yes | Deprecations * |
12+
| Documentation | Swagger (Automated) | Postman (Manual) * |
13+
| Content-Negotiation | Custom | Custom |
14+
| License | BSD-3 | MIT |
15+
| Default DB Layer | laminas-db | doctrine-orm |
16+
| Authorization | ACL | RBAC-guard |
17+
| Authentication | HTTP Basic/Digest OAuth2.0 | OAuth2.0 |
18+
| CI/CD | Yes | Yes |
19+
| Unit Tests | Yes | Yes |
20+
| Endpoint Generator | Yes | Under development |
21+
| PSR | PSR-7 | PSR-7, PSR-15 |
2222

23-
## Note
24-
25-
> * Versioning is replaced by Deprecations, using evolution strategy
26-
> * Version 5 ([Roadmap](https://github.com/orgs/dotkernel/projects/15/views/1)) will implement OpenAPi 3.0
23+
> \* Versioning will be replaced by Deprecations, using evolution strategy
24+
> \* Version 5 will implement OpenAPI 3.0

‎docs/book/v5/transition-from-api-tools/api-tools-vs-dotkernel-api.md‎

Lines changed: 20 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,23 @@
11
# Laminas API Tools compared to Dotkernel API
22

3-
| | API Tools (formerly Apigility) | Dotkernel API |
4-
|---------------------|------------------------------------------------|---------------------------------------------------------------------------------------|
5-
| URL | [api-tools](https://api-tools.getlaminas.org/) | [Dotkernel API](https://www.dotkernel.org) |
6-
| First Release | 2012 | 2018 |
7-
| PHP Version | <= 8.2 | >= 8.1 |
8-
| Architecture | MVC, Event Driven | Middleware |
9-
| OSS Lifecycle | Archived | ![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/api?style=flat&label=) |
10-
| Style | REST, RPC | REST |
11-
| Versioning | Yes | [Deprecations *](https://docs.dotkernel.org/api-documentation/v5/tutorials/api-evolution/)|
12-
| Documentation | Swagger (Automated) | Postman (Manual) * |
13-
| Content-Negotiation | Custom | Custom |
14-
| License | BSD-3 | MIT |
15-
| Default DB Layer | laminas-db | doctrine-orm |
16-
| Authorization | ACL | RBAC-guard |
17-
| Authentication | HTTP Basic/Digest OAuth2.0 | OAuth2.0 |
18-
| CI/CD | Yes | Yes |
19-
| Unit Tests | Yes | Yes |
20-
| Endpoint Generator | Yes | Under development |
21-
| PSR | PSR-7 | PSR-7, PSR-15 |
3+
| | API Tools (formerly Apigility) | Dotkernel API |
4+
|---------------------|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
5+
| URL | [api-tools](https://api-tools.getlaminas.org/) | [Dotkernel API](https://www.dotkernel.org) |
6+
| First Release | 2012 | 2018 |
7+
| PHP Version | <= 8.2 | >= 8.2 |
8+
| Architecture | MVC, Event Driven | Middleware |
9+
| OSS Lifecycle | Archived | ![OSS Lifecycle](https://img.shields.io/osslifecycle?style=flat&label=&file_url=https%3A%2F%2Fgithub.com%2Fdotkernel%2Fapi%2Fblob%2F5.0%2FOSSMETADATA) |
10+
| Style | REST, RPC | REST |
11+
| Versioning | Yes | [Deprecations *](https://docs.dotkernel.org/api-documentation/v5/tutorials/api-evolution/) |
12+
| Documentation | Swagger (Automated) | Postman (Manual) * |
13+
| Content-Negotiation | Custom | Custom |
14+
| License | BSD-3 | MIT |
15+
| Default DB Layer | laminas-db | doctrine-orm |
16+
| Authorization | ACL | RBAC-guard |
17+
| Authentication | HTTP Basic/Digest OAuth2.0 | OAuth2.0 |
18+
| CI/CD | Yes | Yes |
19+
| Unit Tests | Yes | Yes |
20+
| Endpoint Generator | Yes | Under development |
21+
| PSR | PSR-7 | PSR-7, PSR-15 |
2222

23-
## Note
24-
25-
> * Versioning is replaced by Deprecations, using evolution strategy
26-
> * Version 5 ([Roadmap](https://github.com/orgs/dotkernel/projects/15/views/1)) will implement OpenAPi 3.0
23+
> \* Versioning is replaced by Deprecations, using evolution strategy

‎docs/book/v5/tutorials/api-evolution.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ When you want to mark an entire resource as deprecated you have to use the `Reso
2323
...
2424
#[ResourceDeprecation(
2525
sunset: '2038-01-01',
26-
link: 'https://docs.dotkernel.org/api-documentation/v5/core-features/versioning',
26+
link: 'https://docs.dotkernel.org/api-documentation/v5/tutorials/api-evolution/',
2727
deprecationReason: 'Resource deprecation example.',
2828
rel: 'sunset',
2929
type: 'text/html'
@@ -50,7 +50,7 @@ X-Powered-By: PHP/6.4.20
5050
Content-Type: application/json
5151
Permissions-Policy: interest-cohort=()
5252
Sunset: 2038-01-01
53-
Link: https://docs.dotkernel.org/api-documentation/v5/core-features/versioning;rel="sunset";type="text/html"
53+
Link: https://docs.dotkernel.org/api-documentation/v5/tutorials/api-evolution/;rel="sunset";type="text/html"
5454
Vary: Origin
5555
```
5656

@@ -67,7 +67,7 @@ class HomeHandler implements RequestHandlerInterface
6767

6868
#[MethodDeprecation(
6969
sunset: '2038-01-01',
70-
link: 'https://docs.dotkernel.org/api-documentation/v5/core-features/versioning',
70+
link: 'https://docs.dotkernel.org/api-documentation/v5/tutorials/api-evolution/',
7171
deprecationReason: 'Method deprecation example.',
7272
rel: 'sunset',
7373
type: 'text/html'
@@ -98,7 +98,7 @@ X-Powered-By: PHP/6.4.20
9898
Content-Type: application/json
9999
Permissions-Policy: interest-cohort=()
100100
Sunset: 2038-01-01
101-
Link: https://docs.dotkernel.org/api-documentation/v5/core-features/versioning;rel="sunset";type="text/html"
101+
Link: https://docs.dotkernel.org/api-documentation/v5/tutorials/api-evolution/;rel="sunset";type="text/html"
102102
Vary: Origin
103103
```
104104

‎docs/book/v6/extended-features/problem-details.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Example of a response with details:
77
```json
88
{
99
"title": "Unauthorized",
10-
"type": "https://docs.dotkernel.org/api-documentation/v5/core-features/error-reporting/",
10+
"type": "https://docs.dotkernel.org/api-documentation/v6/core-features/error-reporting/",
1111
"status": 401,
1212
"detail": "You are not allowed to report errors."
1313
}

0 commit comments

Comments
 (0)