<?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:----RQsY6TcRfwyUf/RcDM12rR209gaTSuwb0vmeRUs/MSxBzOZ8H1Xc4fOX4wv65r9GhhIIVIc1gwtpS9N1xCDiGZwaWLdrig9okcjIacvLMuu0qmYPvFj9Pj/mhhUidZ1PaFK4Riomv28OEGau0e9TDT1duyZ1Kc945G46rqoS5McUqQkBdzYkCr7jr3n0pv6cGno6/GdEq3VmxRkXPiFmhMCFYDkWTjNXDUPpwDBkNXYiS9B8JS+iXCAH1HIeFlEh+yHHp696fdysyYMwdVAmjgMF7hRF3DEPOEAkzvvjJf3JmzQOvzi0A08l03fN49j0O90Vyz1K6T9lUU/sVeo+Dh5mU/cGDoALAp3+rURimFx5tKIu14+OSTT7w+Z2Rbd6DSsfpuWhlgN9YEubhMFyImyNR6ObpghkuhpdtAR2leT1fxRfCmTFb43LcNJQ70AStZf+1VeiisqxrSiP/cHX0lFrBt+QCSM1bdV5jb+4I9yp6e23MammKTdQqJa1plBV/eKl5kaXeHnDvHXXLBzCV3Kvz90wQr06q8vNmXi6o/LGIoCmkils9LRgMFUy6Yn26ZcxdD8ZdBkHQ9pBg6qZ8UE/68fQasrZHiKf3YPUPbJ4k+ofNS/f2GKCPz8UGaAc5RFPMCriM7mhZfBkQJSUwsCG9CFqeYkSdyivopO2Y+o=----ATTACHMENT:----MzE0NDc0NDU4MjMwMjEwNSA4OTQwMTE2OTg2NjM5NDE1IDE2ODIxNjkzNzQ0NzQwODc=