fix(hydra): use correctly enable_docs #7062
Open
Conversation
This file contains 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
alanpoulain
force-pushed
the
fix-hydra-enable-docs
branch
from
9a5eac4 to
b7033a4
Compare
soyuka
reviewed
Apr 2, 2025
| @@ -111,7 +111,11 @@ public function load(array $configs, ContainerBuilder $container): void | |||
| $formats = $this->getFormats($config['formats']); | |||
| $patchFormats = $this->getFormats($config['patch_formats']); | |||
| $errorFormats = $this->getFormats($config['error_formats']); | |||
| $docsFormats = $this->getFormats($config['docs_formats']); | |||
| // JSON-LD documentation format is mandatory, even if documentation is disabled. | |||
| $docsFormats = ['jsonld' => ['application/ld+json']]; | |||
There was a problem hiding this comment.
this should be the defaults only if jsonld is actually in the formats (isset($formats['jsonld']))
| @@ -65,8 +67,9 @@ public function normalize(mixed $object, ?string $format = null, array $context | |||
| $classes = []; | |||
| $entrypointProperties = []; | |||
| $hydraPrefix = $this->getHydraPrefix($context + $this->defaultContext); | |||
| $resourceClasses = $this->docsEnabled ? $object->getResourceNameCollection() : []; | |||
There was a problem hiding this comment.
I think that this could be a single configuration like:
defaults:
hideHydraOperation: truesince 12c4209
| $hydraPrefix.'returns' => 'Entrypoint', | ||
| ], | ||
| ]; | ||
| } |
There was a problem hiding this comment.
I think it's quite weird to have an API with hydra that's not discoverable but nothing in the spec says we can't. We should check whether the Link is sent when entrypointEnabled is set to false (I think we do).
| @@ -538,11 +542,6 @@ private function registerJsonLdHydraConfiguration(ContainerBuilder $container, a | |||
| if (!$container->has('api_platform.json_schema.schema_factory')) { | |||
| $container->removeDefinition('api_platform.hydra.json_schema.schema_factory'); | |||
| } | |||
|
|
|||
| if (!$config['enable_docs']) { | |||
| $container->removeDefinition('api_platform.hydra.listener.response.add_link_header'); | |||
There was a problem hiding this comment.
I think that we should check if the operation has hideHydraOperation directly we can do this inside the listener to avoid playing with DI
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.
This PR aims to fix definitively a recurring issue: JSON-LD documentation is mandatory but users don't want to expose their endpoints when the API is private: #1568
The
enable_docsconfiguration parameter removes theapi_docroute: the documentation is not exposed anymore, but the URL is needed in some parts of the API Platform code: JSON-LD context, Hydra links, etc.It regularly causes some bugs.
A relating PR was done in 2018:
#1731
This PR was removing the code adding the Hydra headers when the docs is disabled.
IMO @dunglas's comment was right:
In 2023 another PRs were done but never merged:
#5676
#5862
@dunglas's comments were having the same point:
#5676 (comment)
#5862 (comment)
My proposal:
enable_docsis set tofalse, only thejsonlddocumentation format is registered.enable_docsisfalse,hydra:supportedClassis not filled: the API resources are not included in the documentation but all the other keys stay (@context,@vocab...).enable_entrypointset tofalse), the entrypoint is not added tohydra:entrypointandhydra:supportedClass.