Skip to content

Commit bddc57a

Browse files
committed
updated pages - upgrading format
Signed-off-by: bidi47 <bidi@apidemia.com>
1 parent d79a5fd commit bddc57a

4 files changed

Lines changed: 71 additions & 67 deletions

File tree

‎docs/book/v7/upgrading/UPGRADE-6.0.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,26 @@ This release reorganised shared logic into the Core module, refactored handlers
99

1010
> You can find a complete list in [Changelog](https://github.com/dotkernel/api/blob/7.0/CHANGELOG.md)
1111
12-
* [#358](https://github.com/dotkernel/api/pull/358): Move common logic to Core module
13-
* [#385](https://github.com/dotkernel/api/pull/385): Refactored Handlers
14-
* [#389](https://github.com/dotkernel/api/pull/389): Inject `InputFilters` in handlers
15-
* [#391](https://github.com/dotkernel/api/pull/391): Implemented route grouping
16-
* [#396](https://github.com/dotkernel/api/pull/396): Service refactoring
17-
* [#398](https://github.com/dotkernel/api/pull/398): Autogenerate `OAuth2` keys when cloning the project
18-
* [#400](https://github.com/dotkernel/api/pull/400): Refresh Postman documentation
19-
* [#401](https://github.com/dotkernel/api/pull/401): Merge `Admin.Core` into `API.Core`
20-
* [#402](https://github.com/dotkernel/api/pull/402): Implemented `mezzio/mezzio-problem-details`
21-
* [#404](https://github.com/dotkernel/api/pull/404): Update pre-run.sh
22-
* [#408](https://github.com/dotkernel/api/pull/408): Update `GetIndexResourceHandler.php`
23-
* [#409](https://github.com/dotkernel/api/pull/409): Update `local.php.dist`
24-
* [#412](https://github.com/dotkernel/api/pull/412): Fixed error handling
25-
* [#403](https://github.com/dotkernel/api/pull/403): Implemented `ResourceProviderMiddleware` and added `ResourceGuardInterface`
26-
* [#413](https://github.com/dotkernel/api/pull/413): Updated logic in `ContentNegotiationMiddleware`
27-
* [#418](https://github.com/dotkernel/api/pull/418): `AuthenticationMiddleware` no longer extends `AuthenticationMiddleware` from `mezzio/mezzio-authentication`
28-
* [#416](https://github.com/dotkernel/api/pull/416): Update `qodana_code_quality.yml`
29-
* [#419](https://github.com/dotkernel/api/pull/419): Replaced `Twig` with custom templating solution
30-
* [#421](https://github.com/dotkernel/api/pull/421): Increased `PHPStan` level to 8
31-
* [#423](https://github.com/dotkernel/api/pull/423): Split the `/security/token` endpoint into two separate endpoints
12+
* [https://github.com/dotkernel/api/pull/358](https://github.com/dotkernel/api/pull/358): Move common logic to Core module
13+
* [https://github.com/dotkernel/api/pull/385](https://github.com/dotkernel/api/pull/385): Refactored Handlers
14+
* [https://github.com/dotkernel/api/pull/389](https://github.com/dotkernel/api/pull/389): Inject `InputFilters` in handlers
15+
* [https://github.com/dotkernel/api/pull/391](https://github.com/dotkernel/api/pull/391): Implemented route grouping
16+
* [https://github.com/dotkernel/api/pull/396](https://github.com/dotkernel/api/pull/396): Service refactoring
17+
* [https://github.com/dotkernel/api/pull/398](https://github.com/dotkernel/api/pull/398): Autogenerate `OAuth2` keys when cloning the project
18+
* [https://github.com/dotkernel/api/pull/400](https://github.com/dotkernel/api/pull/400): Refresh Postman documentation
19+
* [https://github.com/dotkernel/api/pull/401](https://github.com/dotkernel/api/pull/401): Merge `Admin.Core` into `API.Core`
20+
* [https://github.com/dotkernel/api/pull/402](https://github.com/dotkernel/api/pull/402): Implemented `mezzio/mezzio-problem-details`
21+
* [https://github.com/dotkernel/api/pull/404](https://github.com/dotkernel/api/pull/404): Update pre-run.sh
22+
* [https://github.com/dotkernel/api/pull/408](https://github.com/dotkernel/api/pull/408): Update `GetIndexResourceHandler.php`
23+
* [https://github.com/dotkernel/api/pull/409](https://github.com/dotkernel/api/pull/409): Update `local.php.dist`
24+
* [https://github.com/dotkernel/api/pull/412](https://github.com/dotkernel/api/pull/412): Fixed error handling
25+
* [https://github.com/dotkernel/api/pull/403](https://github.com/dotkernel/api/pull/403): Implemented `ResourceProviderMiddleware` and added `ResourceGuardInterface`
26+
* [https://github.com/dotkernel/api/pull/413](https://github.com/dotkernel/api/pull/413): Updated logic in `ContentNegotiationMiddleware`
27+
* [https://github.com/dotkernel/api/pull/418](https://github.com/dotkernel/api/pull/418): `AuthenticationMiddleware` no longer extends `AuthenticationMiddleware` from `mezzio/mezzio-authentication`
28+
* [https://github.com/dotkernel/api/pull/416](https://github.com/dotkernel/api/pull/416): Update `qodana_code_quality.yml`
29+
* [https://github.com/dotkernel/api/pull/419](https://github.com/dotkernel/api/pull/419): Replaced `Twig` with custom templating solution
30+
* [https://github.com/dotkernel/api/pull/421](https://github.com/dotkernel/api/pull/421): Increased `PHPStan` level to 8
31+
* [https://github.com/dotkernel/api/pull/423](https://github.com/dotkernel/api/pull/423): Split the `/security/token` endpoint into two separate endpoints
3232

3333
## FAQ
3434

‎docs/book/v7/upgrading/UPGRADE-7.0.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ Version 7.0 does not change the PHP version or any Composer dependency constrain
1414

1515
These changes affect your database schema, configuration, entities or runtime behavior.
1616

17-
* [#456](https://github.com/dotkernel/api/pull/456): Use native UUIDs in database via `ramsey/uuid`: entities get their identifier from the new `UuidIdentifierTrait` and a `UuidType` that declares the SQL type `UUID`. `getUuid()` becomes `getId()` and the `uuid` key becomes `id` in entities, repositories, services, input filters and OpenAPI. A schema migration is required
18-
* [#462](https://github.com/dotkernel/api/pull/462): PostgreSQL implementation: in `config/autoload/local.php.dist` the `default` connection is renamed `mariadb`, a `postgresql` connection is added, and `charset` and `collate` are replaced by `collation`. `AbstractEnumType` is reworked, `MigrationsMigratedSubscriber` is added and `config/cli-config.php` is updated
19-
* [#470](https://github.com/dotkernel/api/pull/470): Remove `MethodDeprecation` implementation: the attribute and its tests are deleted, and `DeprecationMiddleware` and the error-report handler no longer use it
17+
* [https://github.com/dotkernel/api/pull/456](https://github.com/dotkernel/api/pull/456): Use native UUIDs in database via `ramsey/uuid`: entities get their identifier from the new `UuidIdentifierTrait` and a `UuidType` that declares the SQL type `UUID`. `getUuid()` becomes `getId()` and the `uuid` key becomes `id` in entities, repositories, services, input filters and OpenAPI. A schema migration is required
18+
* [https://github.com/dotkernel/api/pull/462](https://github.com/dotkernel/api/pull/462): PostgreSQL implementation: in `config/autoload/local.php.dist` the `default` connection is renamed `mariadb`, a `postgresql` connection is added, and `charset` and `collate` are replaced by `collation`. `AbstractEnumType` is reworked, `MigrationsMigratedSubscriber` is added and `config/cli-config.php` is updated
19+
* [https://github.com/dotkernel/api/pull/470](https://github.com/dotkernel/api/pull/470): Remove `MethodDeprecation` implementation: the attribute and its tests are deleted, and `DeprecationMiddleware` and the error-report handler no longer use it
2020

2121
### Optional updates
2222

2323
These changes cover documentation and comments.
2424
Skipping them does not affect how the API runs.
2525

26-
* [#472](https://github.com/dotkernel/api/pull/472): Clarify instructions regarding multiple connections in `config/autoload/local.php.dist`
27-
* [#461](https://github.com/dotkernel/api/pull/461): Update readme and security documents
26+
* [https://github.com/dotkernel/api/pull/472](https://github.com/dotkernel/api/pull/472): Clarify instructions regarding multiple connections in `config/autoload/local.php.dist`
27+
* [https://github.com/dotkernel/api/pull/461](https://github.com/dotkernel/api/pull/461): Update readme and security documents
2828

2929
## FAQ
3030

‎docs/book/v7/upgrading/UPGRADE-7.1.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,37 +13,37 @@ The headline items are the new PHP 8.3 minimum, the upgrade to `mezzio-authentic
1313

1414
These changes affect your PHP version, dependencies, configuration, database schema, entities or runtime behavior.
1515

16-
* [#511](https://github.com/dotkernel/api/pull/511): Upgrade `mezzio/mezzio-authentication-oauth2` to `^3.0.1`: the OAuth entities and repositories are adapted, `Admin` and `NumericIdentifierTrait` types are tightened, and the post-install script now generates `config/autoload/mail.local.php`
17-
* [#510](https://github.com/dotkernel/api/pull/510): Bump PHPUnit to `^12.5.23` and drop PHP 8.2 support: `composer.json` now requires PHP `~8.3.0 || ~8.4.0 || ~8.5.0` and tests use stubs instead of mocks
18-
* [#513](https://github.com/dotkernel/api/pull/513): Implement browscap in `AdminLogin`: the columns `deviceBrand`, `deviceModel`, `osPlatform`, `clientEngine` and `clientVersion` are removed and `isCrawler` is added, so a schema migration is required
19-
* [#499](https://github.com/dotkernel/api/pull/499): Remove `config/autoload/mail.global.php`: mail settings now live in `mail.local.php`
20-
* [#506](https://github.com/dotkernel/api/pull/506): OAuth2 token invalidated on Composer install/update: adds `bin/generate-oauth2-keys.php`, which skips existing keys, and points `post-update-cmd` to it
21-
* [#490](https://github.com/dotkernel/api/pull/490): Add security headers in `config/autoload/response-header.global.php`: `X-Content-Type-Options` and `Referrer-Policy` on all responses, `Cache-Control: no-store` and `Pragma: no-cache` on the token endpoints
22-
* [#476](https://github.com/dotkernel/api/pull/476): Add `MalformedRequestBodyMiddleware`, piped in `config/pipeline.php`: a malformed request body now results in a `BadRequestException`
23-
* [#485](https://github.com/dotkernel/api/pull/485): Require `symfony/var-exporter` to keep LazyGhost support
24-
* [#486](https://github.com/dotkernel/api/pull/486): Core sync: `created` becomes nullable in `TimestampsTrait` and `EntityInterface`, and the Admin, User and role entities are updated
25-
* [#522](https://github.com/dotkernel/api/pull/522): Bump `zircote/swagger-php` to `^6.0.0`
16+
* [https://github.com/dotkernel/api/pull/511](https://github.com/dotkernel/api/pull/511): Upgrade `mezzio/mezzio-authentication-oauth2` to `^3.0.1`: the OAuth entities and repositories are adapted, `Admin` and `NumericIdentifierTrait` types are tightened, and the post-install script now generates `config/autoload/mail.local.php`
17+
* [https://github.com/dotkernel/api/pull/510](https://github.com/dotkernel/api/pull/510): Bump PHPUnit to `^12.5.23` and drop PHP 8.2 support: `composer.json` now requires PHP `~8.3.0 || ~8.4.0 || ~8.5.0` and tests use stubs instead of mocks
18+
* [https://github.com/dotkernel/api/pull/513](https://github.com/dotkernel/api/pull/513): Implement browscap in `AdminLogin`: the columns `deviceBrand`, `deviceModel`, `osPlatform`, `clientEngine` and `clientVersion` are removed and `isCrawler` is added, so a schema migration is required
19+
* [https://github.com/dotkernel/api/pull/499](https://github.com/dotkernel/api/pull/499): Remove `config/autoload/mail.global.php`: mail settings now live in `mail.local.php`
20+
* [https://github.com/dotkernel/api/pull/506](https://github.com/dotkernel/api/pull/506): OAuth2 token invalidated on Composer install/update: adds `bin/generate-oauth2-keys.php`, which skips existing keys, and points `post-update-cmd` to it
21+
* [https://github.com/dotkernel/api/pull/490](https://github.com/dotkernel/api/pull/490): Add security headers in `config/autoload/response-header.global.php`: `X-Content-Type-Options` and `Referrer-Policy` on all responses, `Cache-Control: no-store` and `Pragma: no-cache` on the token endpoints
22+
* [https://github.com/dotkernel/api/pull/476](https://github.com/dotkernel/api/pull/476): Add `MalformedRequestBodyMiddleware`, piped in `config/pipeline.php`: a malformed request body now results in a `BadRequestException`
23+
* [https://github.com/dotkernel/api/pull/485](https://github.com/dotkernel/api/pull/485): Require `symfony/var-exporter` to keep LazyGhost support
24+
* [https://github.com/dotkernel/api/pull/486](https://github.com/dotkernel/api/pull/486): Core sync: `created` becomes nullable in `TimestampsTrait` and `EntityInterface`, and the Admin, User and role entities are updated
25+
* [https://github.com/dotkernel/api/pull/522](https://github.com/dotkernel/api/pull/522): Bump `zircote/swagger-php` to `^6.0.0`
2626

2727
### Optional updates
2828

2929
These changes cover development tooling, CI and documentation.
3030
Skipping them does not affect how the API runs.
3131

32-
* [#494](https://github.com/dotkernel/api/pull/494): Bump `dotkernel/dot-maker` to `^2.0.0` and add a Composer `conflict` on versions below `2.0`
33-
* [#465](https://github.com/dotkernel/api/pull/465): Update PostgreSQL host configuration in `config/autoload/local.php.dist` to `127.0.0.1`
34-
* [#516](https://github.com/dotkernel/api/pull/516): Add Bruno collection, update readme
35-
* [#473](https://github.com/dotkernel/api/pull/473): Update API version in README example
36-
* [#515](https://github.com/dotkernel/api/pull/515): Configure Renovate
37-
* [#491](https://github.com/dotkernel/api/pull/491): Update branch for Qodana workflow to 7.0
38-
* [#500](https://github.com/dotkernel/api/pull/500): Update Qodana action version to v2025.3
39-
* [#523](https://github.com/dotkernel/api/pull/523): Update `JetBrains/qodana-action` to v2026
40-
* [#527](https://github.com/dotkernel/api/pull/527): Update `JetBrains/qodana-action` to v2026.1.3
41-
* [#518](https://github.com/dotkernel/api/pull/518): Update `actions/checkout` to v6
42-
* [#528](https://github.com/dotkernel/api/pull/528): Update `actions/checkout` to v7
43-
* [#517](https://github.com/dotkernel/api/pull/517): Update `actions/cache` to v5
44-
* [#530](https://github.com/dotkernel/api/pull/530): Update `actions/cache` to v6
45-
* [#520](https://github.com/dotkernel/api/pull/520): Update `codecov/codecov-action` to v6
46-
* [#526](https://github.com/dotkernel/api/pull/526): Update `codecov/codecov-action` to v7
32+
* [https://github.com/dotkernel/api/pull/494](https://github.com/dotkernel/api/pull/494): Bump `dotkernel/dot-maker` to `^2.0.0` and add a Composer `conflict` on versions below `2.0`
33+
* [https://github.com/dotkernel/api/pull/465](https://github.com/dotkernel/api/pull/465): Update PostgreSQL host configuration in `config/autoload/local.php.dist` to `127.0.0.1`
34+
* [https://github.com/dotkernel/api/pull/516](https://github.com/dotkernel/api/pull/516): Add Bruno collection, update readme
35+
* [https://github.com/dotkernel/api/pull/473](https://github.com/dotkernel/api/pull/473): Update API version in README example
36+
* [https://github.com/dotkernel/api/pull/515](https://github.com/dotkernel/api/pull/515): Configure Renovate
37+
* [https://github.com/dotkernel/api/pull/491](https://github.com/dotkernel/api/pull/491): Update branch for Qodana workflow to 7.0
38+
* [https://github.com/dotkernel/api/pull/500](https://github.com/dotkernel/api/pull/500): Update Qodana action version to v2025.3
39+
* [https://github.com/dotkernel/api/pull/523](https://github.com/dotkernel/api/pull/523): Update `JetBrains/qodana-action` to v2026
40+
* [https://github.com/dotkernel/api/pull/527](https://github.com/dotkernel/api/pull/527): Update `JetBrains/qodana-action` to v2026.1.3
41+
* [https://github.com/dotkernel/api/pull/518](https://github.com/dotkernel/api/pull/518): Update `actions/checkout` to v6
42+
* [https://github.com/dotkernel/api/pull/528](https://github.com/dotkernel/api/pull/528): Update `actions/checkout` to v7
43+
* [https://github.com/dotkernel/api/pull/517](https://github.com/dotkernel/api/pull/517): Update `actions/cache` to v5
44+
* [https://github.com/dotkernel/api/pull/530](https://github.com/dotkernel/api/pull/530): Update `actions/cache` to v6
45+
* [https://github.com/dotkernel/api/pull/520](https://github.com/dotkernel/api/pull/520): Update `codecov/codecov-action` to v6
46+
* [https://github.com/dotkernel/api/pull/526](https://github.com/dotkernel/api/pull/526): Update `codecov/codecov-action` to v7
4747

4848
## FAQ
4949

0 commit comments

Comments
 (0)