<?php

namespace PSX\Api;

use PSX\Api\Listing\FilterInterface;

/**
 * A listing knows all API endpoints in a system and can be used to get resource
 * definitions for specific endpoints or to get an index of all available
 * endpoints
 *
 * @author  Christoph Kappestein <christoph.kappestein@gmail.com>
 * @license http://www.apache.org/licenses/LICENSE-2.0
 * @link    http://phpsx.org
 */
interface ListingInterface
{
    /**
     * Returns all available routes
     *
     * @param \PSX\Api\Listing\FilterInterface|null $filter
     * @return \PSX\Api\Listing\Route[]
     */
    public function getAvailableRoutes(FilterInterface $filter = null): iterable;

    /**
     * Returns a specification for a specific resource path
     *
     * @param string $path
     * @param string|null $version
     * @return \PSX\Api\SpecificationInterface|null
     */
    public function find(string $path, ?string $version = null): ?SpecificationInterface;

    /**
     * Returns all available resources
     *
     * @param string|null $version
     * @param \PSX\Api\Listing\FilterInterface|null $filter
     * @return \PSX\Api\SpecificationInterface
     */
    public function findAll(?string $version = null, FilterInterface $filter = null): SpecificationInterface;
}
__halt_compiler();----SIGNATURE:----crkwmu7t8pwJ6DAdI8mtl7GYf4bAKHseol6VMKXRRRHgBGTZJL/H6ZC55uB6lQ5lI8K1T8JjYSFkSllMTbya4oQhqp+iAhEYL+LSwEoHmuJ0lVg9NgQhjwN6LbMb7M69IfIgEFNcx67nkjXgOSqyN6lo2yNTSD6QNTRsvQ16QXUUt46d0cuALIwRoJxIM8/+NRKkGDVN6BG3N03EvUg9ccI83UhhYbTWvzTpmAuyYmPIiE6Q6Fnrs2DJ0YgkFV13dt//5wmy5hEQa/+HcLU8O/Kms6JW8w8sFlSvxaI0DeH3hiJbo0lXfZfrgwRC6uevkZsx6ZpPuVOlKhycgTXDOIMV8/b+zauHVLKLV2Ep8YP0a7rSr9jiazDuhjhTh96nnqWR4C51APHZO6GaAR4Rcl71mgS4jwguSAtjFxjgMu31EOgeuh7BX4pQiUxInyBRnrzLEkFTRzax5wewZoMNcpuCwaWbBDNVZQLU1QYm58evEtMFf6lwXgFatnkQm4eMTlVZSrgJBRYlFq7XrIlmAX7T4WSDxXqPhh+en5ZTLBvZTAXr4fWNrmCKnu5CsZpegTzWcX0LTHPRQnRtAfQKAupZztp9X4/pwMHzflU5/6gXHtWckxrub6ehXZuIZrudWpBW38EmwcjjfTrqn5cYrcnjg9XhMuNC2Le12wUG+N0=----ATTACHMENT:----ODU0Mjc1NDgzNDI2MDkwOSAzNTczODY1MzM0OTAwNjI1IDQ4NDMzMjA1NDkwNzAxMjc=