-
-
Notifications
You must be signed in to change notification settings - Fork 861
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
96 changed files
with
1,285 additions
and
366 deletions.
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| Feature: Documentation support | ||
| In order to play with GraphQL | ||
| As a client software developer | ||
| I want to reach the GraphQL documentation | ||
|
|
||
| Scenario: Retrieve the OpenAPI documentation | ||
| Given I add "Accept" header equal to "text/html" | ||
| And I send a "GET" request to "/graphql" | ||
| Then the response status code should be 200 | ||
| And the header "Content-Type" should be equal to "text/html; charset=utf-8" |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,44 @@ | |
|
|
||
| namespace ApiPlatform\Api; | ||
|
|
||
| interface FilterInterface extends \ApiPlatform\Metadata\FilterInterface | ||
| /** | ||
| * Filters applicable on a resource. | ||
| * | ||
| * @author Kévin Dunglas <[email protected]> | ||
| */ | ||
| interface FilterInterface | ||
| { | ||
| /** | ||
| * Gets the description of this filter for the given resource. | ||
| * | ||
| * Returns an array with the filter parameter names as keys and array with the following data as values: | ||
| * - property: the property where the filter is applied | ||
| * - type: the type of the filter | ||
| * - required: if this filter is required | ||
| * - strategy (optional): the used strategy | ||
| * - is_collection (optional): if this filter is for collection | ||
| * - swagger (optional): additional parameters for the path operation, | ||
| * e.g. 'swagger' => [ | ||
| * 'description' => 'My Description', | ||
| * 'name' => 'My Name', | ||
| * 'type' => 'integer', | ||
| * ] | ||
| * - openapi (optional): additional parameters for the path operation in the version 3 spec, | ||
| * e.g. 'openapi' => [ | ||
| * 'description' => 'My Description', | ||
| * 'name' => 'My Name', | ||
| * 'schema' => [ | ||
| * 'type' => 'integer', | ||
| * ] | ||
| * ] | ||
| * - schema (optional): schema definition, | ||
| * e.g. 'schema' => [ | ||
| * 'type' => 'string', | ||
| * 'enum' => ['value_1', 'value_2'], | ||
| * ] | ||
| * The description can contain additional data specific to a filter. | ||
| * | ||
| * @see \ApiPlatform\OpenApi\Factory\OpenApiFactory::getFiltersParameters | ||
| */ | ||
| public function getDescription(string $resourceClass): array; | ||
| } | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,15 +13,20 @@ | |
|
|
||
| namespace ApiPlatform\Api; | ||
|
|
||
| class_exists(\ApiPlatform\Metadata\IdentifiersExtractorInterface::class); | ||
| use ApiPlatform\Metadata\Exception\RuntimeException; | ||
| use ApiPlatform\Metadata\Operation; | ||
|
|
||
| class_alias( | ||
| \ApiPlatform\Metadata\IdentifiersExtractorInterface::class, | ||
| __NAMESPACE__.'\IdentifiersExtractorInterface' | ||
| ); | ||
|
|
||
| if (false) { // @phpstan-ignore-line | ||
| interface IdentifiersExtractorInterface extends \ApiPlatform\Metadata\IdentifiersExtractorInterface | ||
| { | ||
| } | ||
| /** | ||
| * Extracts identifiers for a given Resource according to the retrieved Metadata. | ||
| * | ||
| * @author Antoine Bluchet <[email protected]> | ||
| */ | ||
| interface IdentifiersExtractorInterface | ||
| { | ||
| /** | ||
| * Finds identifiers from an Item (object). | ||
| * | ||
| * @throws RuntimeException | ||
| */ | ||
| public function getIdentifiersFromItem(object $item, Operation $operation = null, array $context = []): array; | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,15 +13,33 @@ | |
|
|
||
| namespace ApiPlatform\Api; | ||
|
|
||
| class_exists(\ApiPlatform\Metadata\IriConverterInterface::class); | ||
| use ApiPlatform\Metadata\Exception\InvalidArgumentException; | ||
| use ApiPlatform\Metadata\Exception\ItemNotFoundException; | ||
| use ApiPlatform\Metadata\Exception\RuntimeException; | ||
| use ApiPlatform\Metadata\Operation; | ||
|
|
||
| class_alias( | ||
| \ApiPlatform\Metadata\IriConverterInterface::class, | ||
| __NAMESPACE__.'\IriConverterInterface' | ||
| ); | ||
| /** | ||
| * Converts item and resources to IRI and vice versa. | ||
| * | ||
| * @author Kévin Dunglas <[email protected]> | ||
| */ | ||
| interface IriConverterInterface | ||
| { | ||
| /** | ||
| * Retrieves an item from its IRI. | ||
| * | ||
| * @throws InvalidArgumentException | ||
| * @throws ItemNotFoundException | ||
| */ | ||
| public function getResourceFromIri(string $iri, array $context = [], Operation $operation = null): object; | ||
|
|
||
| if (false) { // @phpstan-ignore-line | ||
| interface IriConverterInterface extends \ApiPlatform\Metadata\IriConverterInterface | ||
| { | ||
| } | ||
| /** | ||
| * Gets the IRI associated with the given item. | ||
| * | ||
| * @param object|class-string $resource | ||
| * | ||
| * @throws InvalidArgumentException | ||
| * @throws RuntimeException | ||
| */ | ||
| public function getIriFromResource(object|string $resource, int $referenceType = UrlGeneratorInterface::ABS_PATH, Operation $operation = null, array $context = []): ?string; | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,10 +13,27 @@ | |
|
|
||
| namespace ApiPlatform\Api; | ||
|
|
||
| class_exists(\ApiPlatform\Metadata\ResourceClassResolverInterface::class); | ||
| use ApiPlatform\Metadata\Exception\InvalidArgumentException; | ||
|
|
||
| if (false) { // @phpstan-ignore-line | ||
| interface ResourceClassResolverInterface extends \ApiPlatform\Metadata\ResourceClassResolverInterface | ||
| { | ||
| } | ||
| /** | ||
| * Guesses which resource is associated with a given object. | ||
| * | ||
| * @author Kévin Dunglas <[email protected]> | ||
| */ | ||
| interface ResourceClassResolverInterface | ||
| { | ||
| /** | ||
| * Guesses the associated resource. | ||
| * | ||
| * @param string $resourceClass The expected resource class | ||
| * @param bool $strict If true, value must match the expected resource class | ||
| * | ||
| * @throws InvalidArgumentException | ||
| */ | ||
| public function getResourceClass(mixed $value, string $resourceClass = null, bool $strict = false): string; | ||
|
|
||
| /** | ||
| * Is the given class a resource class? | ||
| */ | ||
| public function isResourceClass(string $type): bool; | ||
| } | ||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,15 +13,24 @@ | |
|
|
||
| namespace ApiPlatform\Api; | ||
|
|
||
| class_exists(\ApiPlatform\Metadata\UriVariablesConverterInterface::class); | ||
| use ApiPlatform\Metadata\Exception\InvalidIdentifierException; | ||
|
|
||
| class_alias( | ||
| \ApiPlatform\Metadata\UriVariablesConverterInterface::class, | ||
| __NAMESPACE__.'\UriVariablesConverterInterface' | ||
| ); | ||
|
|
||
| if (false) { // @phpstan-ignore-line | ||
| interface UriVariablesConverterInterface extends \ApiPlatform\Metadata\UriVariablesConverterInterface | ||
| { | ||
| } | ||
| /** | ||
| * Identifier converter. | ||
| * | ||
| * @author Antoine Bluchet <[email protected]> | ||
| */ | ||
| interface UriVariablesConverterInterface | ||
| { | ||
| /** | ||
| * Takes an array of strings representing URI variables (identifiers) and transform their values to the expected type. | ||
| * | ||
| * @param array $data URI variables to convert to PHP values | ||
| * @param string $class The class to which the URI variables belong to | ||
| * | ||
| * @throws InvalidIdentifierException | ||
| * | ||
| * @return array Array indexed by identifiers properties with their values denormalized | ||
| */ | ||
| public function convert(array $data, string $class, array $context = []): array; | ||
| } | ||
Oops, something went wrong.