rename swagger actions

yii2mod · Oct 16, 2017 · 5304629 · 5304629
1 parent a3dd037
commit 5304629
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/SwaggerApiAction.php → OpenAPIRenderer.php b/SwaggerApiAction.php → OpenAPIRenderer.php
@@ -10,11 +10,11 @@
 use yii\web\Response;
 
 /**
- * Class SwaggerApiAction
+ * Class OpenAPIRenderer is responsible for generating the JSON spec.
  *
- * @package yii2mod\swagger
+ * @package yii2mod\swagger\actions
  */
-class SwaggerApiAction extends Action
+class OpenAPIRenderer extends Action
 {
     /**
      * @var string|array|\Symfony\Component\Finder\Finder The directory(s) or filename(s).

diff --git a/README.md b/README.md
@@ -61,11 +61,11 @@ class SiteController extends Controller
     {
         return [
             'docs' => [
-                'class' => 'yii2mod\swagger\SwaggerAction',
+                'class' => 'yii2mod\swagger\SwaggerUIRenderer',
                 'restUrl' => Url::to(['site/json-schema']),
             ],
             'json-schema' => [
-                'class' => 'yii2mod\swagger\SwaggerApiAction',
+                'class' => 'yii2mod\swagger\OpenAPIRenderer',
                 // Тhe list of directories that contains the swagger annotations.
                 'scanDir' => [
                     Yii::getAlias('@app/controllers'),

diff --git a/SwaggerAction.php → SwaggerUIRenderer.php b/SwaggerAction.php → SwaggerUIRenderer.php
@@ -5,11 +5,11 @@
 use yii\base\Action;
 
 /**
- * Class SwaggerAction
+ * Class SwaggerUIRenderer renders the UI (HTML/JS/CSS).
  *
  * @package yii2mod\swagger
  */
-class SwaggerAction extends Action
+class SwaggerUIRenderer extends Action
 {
     /**
      * @var string the rest url configuration