5.0: Build REST API Ref W/ PHP API Ref #2744
Draft
Conversation
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
|
Preview of modified files: no change to preview. |
# Conflicts: # docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml # docs/api/rest_api/rest_api_reference/input/ibexa-corporate.raml # docs/api/rest_api/rest_api_reference/input/ibexa-types.raml # docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml # docs/api/rest_api/rest_api_reference/input/ibexa.raml # tools/api_refs/.phpdoc/template/menu-entry.html.twig # tools/api_refs/.phpdoc/template/menu.html.twig # tools/api_refs/.phpdoc/template/package-edition-map.twig # tools/api_refs/api_refs.sh # tools/raml2html/themes/default/index.html.twig
fatal: pathspec 'tools/api_refs/.phpdoc/template/package-edition-map.twig' did not match any files
adriendupuis
force-pushed
the
5.0-api-refs
branch
from
23466a3 to
43fb956
Compare
adriendupuis
force-pushed
the
5.0-api-refs
branch
from
43fb956 to
c0be681
Compare
adriendupuis
commented
Jul 17, 2025
tools/api_refs/api_refs.sh
Outdated
Comment on lines
10
to
13
| DXP_VERSION='5.0.0-rc1'; # Version from and for which the Reference is built | ||
| DXP_ADD_ONS=(automated-translation rector); # Packages not included in $DXP_EDITION but added to the Reference, listed without their vendor "ibexa" | ||
| DXP_EDITIONS=(oss headless experience commerce); # Available editions ordered by ascending capabilities | ||
| SF_VERSION='7.2'; # Symfony version used by Ibexa DXP |
There was a problem hiding this comment.
For the stable release:
Suggested change
| DXP_VERSION='5.0.0-rc1'; # Version from and for which the Reference is built | |
| DXP_ADD_ONS=(automated-translation rector); # Packages not included in $DXP_EDITION but added to the Reference, listed without their vendor "ibexa" | |
| DXP_EDITIONS=(oss headless experience commerce); # Available editions ordered by ascending capabilities | |
| SF_VERSION='7.2'; # Symfony version used by Ibexa DXP | |
| DXP_VERSION='5.0.*'; # Version from and for which the Reference is built | |
| DXP_ADD_ONS=(automated-translation rector); # Packages not included in $DXP_EDITION but added to the Reference, listed without their vendor "ibexa" | |
| DXP_EDITIONS=(oss headless experience commerce); # Available editions ordered by ascending capabilities | |
| SF_VERSION='7.3'; # Symfony version used by Ibexa DXP |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
5.0 REST API Reference is build from API Platform / OpenAPI.
Merge PHP API and REST API References builds.
(It was theorized in #2723.)
The workflow will always be called from repo default branch. It will checkout the doc branch according to the
versioninput and run the proper tool for 4.6 and "other than 4.6" (so, 5.x+).v5.0.0-rc1 test
gh workflow run api_refs.yaml -f version='v5.0.0-rc1' --ref=5.0-api-refs;Success in https://github.com/ibexa/documentation-developer/actions/runs/16344392797/job/46174303137 while on commit a02cc3f which opened the PR #2833
About maintenance
When 5.0 tool is modified, to update 4.6 accordingly isn't easy. And vice-versa.
We can use git diff like this (eventually with current
HEADinstead of one of branch names):Or I can rename on 4.6 side as well…
Checklist