diff --git a/ANNOTATIONS.md b/ANNOTATIONS.md index 2f307c4f9..ae980cd2c 100644 --- a/ANNOTATIONS.md +++ b/ANNOTATIONS.md @@ -179,7 +179,7 @@ iValueObject. @var int policy age {@min 18} {@max 100} When an api method is returning or having one of the parameters as an instance -of a custom class @var comments can be used with properties of that class. +of a custom class @var comments can be used with properties of that class. They will be used for validation and documentation. Supported child attributes are same as that of @param so they are documented under [@param](PARAM.md) @@ -223,4 +223,4 @@ Specify the view file to be loaded by HtmlFormat for the given api method as rel Similar to the `@view` but only used when an exception is thrown ---------------- \ No newline at end of file +--------------- diff --git a/README.md b/README.md index efc20f328..390f5d1e5 100644 --- a/README.md +++ b/README.md @@ -298,7 +298,7 @@ They are documented in detail under [Annotations](ANNOTATIONS.md) ### 6. Authorize -In order to protect your api, authenticate and allow valid users +In order to protect your api, authenticate and allow valid users ```php _data); - if (!String::contains($data, $response)) + if (!Text::contains($data, $response)) throw new Exception("Response value does not contain '$response' only\n\n" . $this->echoLastResponse()); } diff --git a/public/annotations.html b/public/annotations.html index 9663ae22f..f6032c553 100644 --- a/public/annotations.html +++ b/public/annotations.html @@ -325,7 +325,7 @@
Example:
-@pformat HtmlFormat
+@format HtmlFormat
IF you want to force the request and or response format for a specific api method @format comment can be used
@@ -364,4 +364,4 @@ @errorView