Provider_Interface.php
29 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Pods\REST\Interfaces\Swagger; |
| 4 | |
| 5 | /** |
| 6 | * Provider interface. |
| 7 | * |
| 8 | * @credit The Events Calendar team - https://github.com/the-events-calendar/tribe-common |
| 9 | * |
| 10 | * @since 3.0 |
| 11 | */ |
| 12 | interface Provider_Interface { |
| 13 | /** |
| 14 | * Returns an array in the format used by Swagger 2.0. |
| 15 | * |
| 16 | * While the structure must conform to that used by v2.0 of Swagger the structure can be that of a full document |
| 17 | * or that of a document part. |
| 18 | * The intelligence lies in the "gatherer" of information rather than in the single "providers" implementing this |
| 19 | * interface. |
| 20 | * |
| 21 | * @link http://swagger.io/ |
| 22 | * |
| 23 | * @since 3.0 |
| 24 | * |
| 25 | * @return array An array description of a Swagger supported component. |
| 26 | */ |
| 27 | public function get_documentation(); |
| 28 | } |
| 29 |