From e3db51a9c012eba3eb553083670bc59ed6ad22a5 Mon Sep 17 00:00:00 2001 From: chris cnizzardini Date: Thu, 30 Apr 2020 23:17:36 -0400 Subject: [PATCH] updated readme --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6c220141..dc04ca36 100644 --- a/README.md +++ b/README.md @@ -125,7 +125,7 @@ Method level annotation for adding query parameters. ```php /** - * @Swag\SwagQuery(name="queryParamName", type="string", required=false) + * @Swag\SwagQuery(name="queryParamName", type="string", description="string", required=false) */ public function index() {} ``` @@ -135,7 +135,7 @@ Method level annotation for adding form data fields. ```php /** - * @Swag\SwagForm(name="fieldName", type="string", required=false) + * @Swag\SwagForm(name="fieldName", type="string", description="string", required=false) */ public function index() {} ``` @@ -145,7 +145,7 @@ Method level annotation for adding header parameters. ```php /** - * @Swag\SwagHeader(name="X-HEAD-ATTRIBUTE", type="string", required=false) + * @Swag\SwagHeader(name="X-HEAD-ATTRIBUTE", type="string", description="string", required=false) */ public function index() {} ``` @@ -185,8 +185,7 @@ Method level annotation for describing custom content in request body. ```php /** - * @Swag\SwagRequestBodyContent(refEntity="#/components/schemas/Lead", mimeType="application/x-www-form-urlencoded") - * @Swag\SwagRequestBodyContent(refEntity="", mimeType="text/plain") + * @Swag\SwagRequestBodyContent(refEntity="#/components/schemas/Lead", mimeType="application/json") */ public function index() {} ``` @@ -227,7 +226,7 @@ Class level annotation for customizing Schema Attributes with @SwagEntityAttribu ```php /** - * @Swag\SwagEntityAttribute(name="modified", type="string", readOnly=true, required=false) + * @Swag\SwagEntityAttribute(name="modified", type="string", description="string", readOnly=true, required=false) */ class Employee extends Entity { ```