Added UPGRADE.md

Author: lulco

CHANGELOG.md

@@ -7,6 +7,7 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 #### Changed
 
 * Update nette libs to version 3.0.0 (BC break)
+* Added typehints (BC break)
 * Pretty JSON output in API console - without escaping unicode and slashes
 * Replaced handler information array triplet (endpoint, handler, authorization) with Api
 

UPGRADE.md

@@ -0,0 +1,73 @@
+# UPGRADE
+
+## Upgrade from 1.x to 2.0.0
+
+### Removed support for old PHP versions
+New version not supported PHP versions 5.6 and 7.0 and also hhvm. Please use it with newer versions of PHP (>7.1)
+
+### Updated dependencies
+Version 2.0.0 requires nette packages in version 3.0, so probably you will have to upgrade whole your nette application 
+
+### Typehints
+There are some breaking changes because of typehints:
+
+#### ApiAuthorizationInterface
+Add typehints to methods:
+- `authorized(): bool`
+- `getErrorMessage(): ?string`
+
+#### ApiHandlerInterface
+Add typehints to methods:
+- `params(): array`
+- `handle(array $params): Tomaj\NetteApi\Response\ResponseInterface`
+
+#### ApiLoggerInterface
+Add typehints to method:
+- `log(int $responseCode, string $requestMethod, string $requestHeader, string $requestUri, string $requestIp, string $requestAgent, int $responseTime): bool`
+
+#### BearerTokenRepositoryInterface
+Add typehints to methods:
+- `validToken(string $token): bool`
+- `ipRestrictions(string $token): ?string`
+
+#### IpDetectorInterface
+Add typehints to method:
+- `getRequestIp(): string`
+
+#### ParamInterface
+Add typehints to methods:
+- `isValid(): bool`
+- `getKey(): string`
+
+#### EndpointInterface
+Add typehints to methods:
+- `getMethod(): string`
+- `getVersion(): int`
+- `getPackage(): string`
+- `getApiAction(): ?string`
+- `getUrl(): string`
+
+### Renamed methods
+Few methods have been renamed, please use their new versions:
+- `ApiDecider::addApiHandler()` -> `ApiDecider::addApi()`
+- `ApiDecider::getApiHandler()` -> `ApiDecider::getApi()`
+- `ApiDecider::getHandlers()` -> `ApiDecider::getApis()`
+
+### Final methods
+BaseHandler now have few final methods:
+- `setEndpointIdentifier` 
+- `getEndpoint`
+- `setupLinkGenerator`
+- `createLink`
+
+### Removed params
+Parameters $parent and $name have been removed from ApiListingControl. New usage is:
+```
+new ApiListingControl($apiDecider)
+```
+
+### Changed params
+Some parameters were strictly typed:
+- second parameter in `JsonApiResponse::__construct` (`$payload` formerly known as `$data`) is now `array`
+- fifth parameter in `JsonApiResponse::__construct` (`$expiration`) is now `DateTimeInteface` or `null`
+- fourth parameter in `InputParam::__construc` (`$availableValues`) is now `array` or `null`

src/Logger/ApiLoggerInterface.php

@@ -4,25 +4,13 @@
 
 interface ApiLoggerInterface
 {
-    /**
-     * Log processed api request
-     *
-     * @param integer   $responseCode
-     * @param string    $requestMethod
-     * @param string    $requestHeader
-     * @param string    $requestUri
-     * @param string    $requestIp
-     * @param string    $requestAgent
-     * @param integer   $responseTime
-     * @return boolean
-     */
     public function log(
-        $responseCode,
-        $requestMethod,
-        $requestHeader,
-        $requestUri,
-        $requestIp,
-        $requestAgent,
-        $responseTime
-    );
+        int $responseCode,
+        string $requestMethod,
+        string $requestHeader,
+        string $requestUri,
+        string $requestIp,
+        string $requestAgent,
+        int $responseTime
+    ): bool;
 }