Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@

use ApiPlatform\Metadata\Operation;

/**
* Finds the operation that matches a URI template or an operation name.
*/
interface OperationMetadataFactoryInterface
{
public function create(string $uriTemplate, array $context = []): ?Operation;
Expand Down
3 changes: 3 additions & 0 deletions src/Metadata/ResourceAccessCheckerInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@

namespace ApiPlatform\Metadata;

/**
* Checks if the current user can access a resource, with a security expression.
*/
interface ResourceAccessCheckerInterface
{
/**
Expand Down
2 changes: 1 addition & 1 deletion src/Metadata/UrlGeneratorInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
use Symfony\Component\Routing\Exception\RouteNotFoundException;

/**
* UrlGeneratorInterface is the interface that all URL generator classes must implement.
* Generates URLs and paths from route names and parameters.
*
* This interface has been imported and adapted from the Symfony project.
*
Expand Down
3 changes: 3 additions & 0 deletions src/OpenApi/Factory/OpenApiFactoryInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@

use ApiPlatform\OpenApi\OpenApi;

/**
* Creates the OpenAPI document of the API.
*/
interface OpenApiFactoryInterface
{
/**
Expand Down
3 changes: 3 additions & 0 deletions src/OpenApi/Options.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@

use ApiPlatform\OpenApi\Model\Tag;

/**
* Holds the options of the OpenAPI document, such as its title, version and authentication schemes.
*/
final readonly class Options
{
/**
Expand Down
3 changes: 3 additions & 0 deletions src/State/Pagination/PaginationOptions.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@

namespace ApiPlatform\State\Pagination;

/**
* Holds the pagination options, such as the page size and the names of the query parameters.
*/
final class PaginationOptions
{
public function __construct(private readonly bool $paginationEnabled = true, private readonly string $paginationPageParameterName = 'page', private readonly bool $clientItemsPerPage = false, private readonly string $itemsPerPageParameterName = 'itemsPerPage', private readonly bool $paginationClientEnabled = false, private readonly string $paginationClientEnabledParameterName = 'pagination', private readonly int $itemsPerPage = 30, private readonly ?int $maximumItemsPerPage = null, private readonly bool $partialPaginationEnabled = false, private readonly bool $clientPartialPaginationEnabled = false, private readonly string $partialPaginationParameterName = 'partial')
Expand Down
Loading