You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
build(deps-dev): bump zircote/swagger-php to 7.0 and keep OpenAPI 3.0.0 output - #4829
swagger-php 7.0 makes hybrid the default mode. Hybrid scans the same OpenApi\Attributes as
before, but builds the document with the new spec pipeline. Classic attributes keep working
through v7 and are removed in 8.0.
This bumps zircote/swagger-php from ~6.18.0 to ~7.0.0 and adds --version 3.0.0 to openapi:json and openapi:yaml. Hybrid defaults to OpenAPI 3.1.0, and the flag keeps the
documents at 3.0.0. With that, the generated docs/openapi.json and docs/openapi.yaml parse
equal to the committed ones. The raw output only differs in key order, so docs/ is left alone.
Reason for doing this ahead of the Dependabot bump: without --version 3.0.0, the next composer openapi:json moves the documents to 3.1.0 without anyone asking for it.
v7 marks the classic attributes @deprecated, so composer check now reports 224 deprecated-class warnings. It still passes. The warnings go away with a move to the spec
attributes (OpenApi\Spec), which the rector set does mostly
automatically. That touches every API controller, so it is probably better left for a major
release, and this PR does not start it.
I maintain swagger-php - any questions, feel free to ping me.
Checklist
composer check passes (format, lint, static analysis) - with the deprecation warnings above
composer test passes - all but two: SessionTest::testGetLast30DaysVisits and testGetLast30DaysVisitsIgnoresVisitsOutsideTheRange fail the same way on main with
swagger-php 6.18, and look time-of-day dependent. pnpm test not run, no JS/TS changes
pnpm tsc and pnpm oxlint pass for TypeScript changes - n/a
New or changed behaviour is covered by tests - n/a, no code changes
Database schema changes ship with an upgrade step in phpMyFAQ\Setup\Update - n/a
CHANGELOG.md is updated for user-facing changes - n/a, dev dependency only
Dependency major version bumps: upstream changelog read, old APIs grepped for, build green
Cheers,
mano
Summary by CodeRabbit
Chores
OpenAPI specifications generated by the project scripts now target version 3.0.0. Existing JSON and YAML formats and output locations are unchanged.
The Swagger PHP development dependency changes to ~7.0.0. Both OpenAPI generation scripts now specify version 3.0.0; the JSON script retains its JSON output option.
The Swagger PHP development dependency constraint changes to ~7.0.0. Both OpenAPI generation scripts specify version 3.0.0; the JSON script retains its -f json option.
The tooling update is compatible with the supported environments and preserves OpenAPI 3.0 output.
Pre-merge checks: 5
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title names the two main changes: the zircote/swagger-php dev dependency bump from 6.18 to 7.0, and keeping OpenAPI 3.0.0 output via --version 3.0.0. The raw summary and objectives confirm both ch…
Docstring Coverage
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title names the two main changes: the zircote/swagger-php dev dependency bump from 6.18 to 7.0, and keeping OpenAPI 3.0.0 output via --version 3.0.0. The raw summary and objectives confirm both changes. The title is specific and matches the changeset, and it omits no major point. Minor wording note: the title says 'bump to 7.0' while the constraint is ~7.0.0, which is equivalent.
Full details: Docstring Coverage
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Finishing Touches
🧪 Generate unit tests (beta)
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
This branch has not been deployed
No deployments
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Hi there,
swagger-php 7.0 makes hybrid the default mode. Hybrid scans the same
OpenApi\Attributesasbefore, but builds the document with the new spec pipeline. Classic attributes keep working
through v7 and are removed in 8.0.
This bumps
zircote/swagger-phpfrom~6.18.0to~7.0.0and adds--version 3.0.0toopenapi:jsonandopenapi:yaml. Hybrid defaults to OpenAPI 3.1.0, and the flag keeps thedocuments at 3.0.0. With that, the generated
docs/openapi.jsonanddocs/openapi.yamlparseequal to the committed ones. The raw output only differs in key order, so
docs/is left alone.Reason for doing this ahead of the Dependabot bump: without
--version 3.0.0, the nextcomposer openapi:jsonmoves the documents to 3.1.0 without anyone asking for it.v7 marks the classic attributes
@deprecated, socomposer checknow reports 224deprecated-classwarnings. It still passes. The warnings go away with a move to the specattributes (
OpenApi\Spec), which therector set does mostly
automatically. That touches every API controller, so it is probably better left for a major
release, and this PR does not start it.
I maintain swagger-php - any questions, feel free to ping me.
Checklist
composer checkpasses (format, lint, static analysis) - with the deprecation warnings abovecomposer testpasses - all but two:SessionTest::testGetLast30DaysVisitsandtestGetLast30DaysVisitsIgnoresVisitsOutsideTheRangefail the same way onmainwithswagger-php 6.18, and look time-of-day dependent.
pnpm testnot run, no JS/TS changespnpm tscandpnpm oxlintpass for TypeScript changes - n/aphpMyFAQ\Setup\Update- n/aCHANGELOG.mdis updated for user-facing changes - n/a, dev dependency onlyCheers,
mano
Summary by CodeRabbit