diff --git a/app/library/App/Resources/AllPositionResource.php b/app/library/App/Resources/AllPositionResource.php index ec8b81a..145700e 100644 --- a/app/library/App/Resources/AllPositionResource.php +++ b/app/library/App/Resources/AllPositionResource.php @@ -34,7 +34,7 @@ class AllPositionResource extends ApiResource ApiEndpoint::factory('/project', HttpMethods::GET, 'projectAction') ->name('project') ->description('Данные о проекте') - ->exampleRequest([ + ->paramsDescription([ 'required params' => [ 'project' => "integer(ID проекта)" ] @@ -56,7 +56,7 @@ class AllPositionResource extends ApiResource ApiEndpoint::factory('/projects', HttpMethods::GET, 'projectsAction') ->name('projects') ->description('Список проектов пользователя') - ->exampleRequest([ + ->paramsDescription([ 'required params' => [], 'optional params' => [ 'id_group' => "integer(ID проекта)" @@ -91,7 +91,7 @@ class AllPositionResource extends ApiResource ApiEndpoint::factory('/projects_group', HttpMethods::GET, 'projectsGroupAction') ->name('projects group') ->description('Список групп проектов') - ->exampleRequest([ + ->paramsDescription([ 'required params' => [] ]) ->exampleResponse([ @@ -111,7 +111,7 @@ class AllPositionResource extends ApiResource ApiEndpoint::factory('/queries', HttpMethods::GET, 'queriesAction') ->name('queries') ->description('Список запросов, по которым определяется позиция сайта') - ->exampleRequest([ + ->paramsDescription([ 'required params' => [ 'project' => 'integer(ID проекта)' ], @@ -142,7 +142,7 @@ class AllPositionResource extends ApiResource ApiEndpoint::factory('/queries_group', HttpMethods::GET, 'queriesGroupAction') ->name('queries group') ->description('Список групп запросов') - ->exampleRequest([ + ->paramsDescription([ 'required params' => ['project' => 'integer(ID проекта)'] ]) ->exampleResponse([ @@ -162,7 +162,7 @@ class AllPositionResource extends ApiResource ApiEndpoint::factory('/report', HttpMethods::GET, 'reportAction') ->name('report') ->description('Отчет по позициям сайта') - ->exampleRequest([ + ->paramsDescription([ 'required params' => [ 'project' => 'integer(ID проекта)' ], @@ -224,7 +224,7 @@ class AllPositionResource extends ApiResource ApiEndpoint::factory('/visibility', HttpMethods::GET, 'visibilityAction') ->name('visibility') ->description('Данные о видимости сайта за указанный период') - ->exampleRequest([ + ->paramsDescription([ 'required params' => [ 'project' => 'integer(ID проекта)' ], diff --git a/app/library/App/Resources/GaResource.php b/app/library/App/Resources/GaResource.php index 92b3f8c..5eececd 100644 --- a/app/library/App/Resources/GaResource.php +++ b/app/library/App/Resources/GaResource.php @@ -40,16 +40,18 @@ class GaResource extends ApiResource { "Referral" => "128", "Social" => "29" ]) - ->exampleRequest([ + ->paramsDescription([ 'get params' => [ - 'required' => [], - 'optional' => [ - 'user_id' => '1', - 'view_id' => 'GA VIEW_ID', - 'start' => '30daysAgo / 2015-03-01', - 'end' => 'today', - 'metric' => 'users,sessions', - 'dimension' => 'source,browser' + 'required params' => [ + 'metric' => 'string(метрика Google, линк в описании запроса)', + 'dimension' => 'string(размерность Google, линк в описании запроса)', + 'start' => 'ГГГГ-ММ-ДД/NdaysAgo, где N – целое положительное число(дата начала загрузки данных)', + 'end' => 'ГГГГ-ММ-ДД/NdaysAgo, где N – целое положительное число(дата конца загрузки данных)' + ], + 'optional params' => [ + 'user_id' => 'integer(id пользователя в системе)', + 'view_id' => 'integer(id представления проэкта с гугл аналитики)', + 'chart' => 'boolean(Задает структуру возвращаемых данных(true для графиков))', ] ], 'summary' => 'http://test-30.artweb.com.ua/ga?view_id=119240817&metric=users,sessions&dimension=source,browser' diff --git a/app/views/general/documentation.phtml b/app/views/general/documentation.phtml index 224eb0d..f3bda13 100755 --- a/app/views/general/documentation.phtml +++ b/app/views/general/documentation.phtml @@ -23,9 +23,9 @@
Documentation
+Документация
-Description | +Описание | {{ collection.description }} | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Base path | +Префикс | {{ collection.prefix }} | |||||||||||||||||
Fields | +Поля |
|