From 62ad1e929b54270b985a488e5b7cc51b1025e241 Mon Sep 17 00:00:00 2001
From: Awilum <sergey.romanenko@flextype.org>
Date: Thu, 28 Apr 2022 12:07:06 +0300
Subject: [PATCH] refactor(endpoints): typo updates

---
 src/flextype/routes/endpoints/entries.php  | 22 +++++++++++-----------
 src/flextype/routes/endpoints/registry.php |  2 +-
 src/flextype/routes/endpoints/utils.php    |  6 +++---
 3 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/src/flextype/routes/endpoints/entries.php b/src/flextype/routes/endpoints/entries.php
index 7cc22aa7..1953921f 100644
--- a/src/flextype/routes/endpoints/entries.php
+++ b/src/flextype/routes/endpoints/entries.php
@@ -31,7 +31,7 @@ use function app;
  * options - [OPTIONAL] - Select items in collection by given conditions.
  *
  * Returns:
- * An array of entry objects.
+ * Entry object.
  */
 app()->get('/api/v0/entries', [Entries::class, 'fetch'])->setName('entries.fetch');
 
@@ -43,11 +43,11 @@ app()->get('/api/v0/entries', [Entries::class, 'fetch'])->setName('entries.fetch
  * Body:
  * id            - [REQUIRED] - Unique identifier of the entry.
  * token         - [REQUIRED] - Valid public token.
- * access_token  - [REQUIRED] - Valid access token.
+ * access_token  - [REQUIRED] - Valid private access token.
  * data          - [REQUIRED] - Data to store for the entry.
  *
  * Returns:
- * Returns the entry object for the entry that was just created.
+ * Entry object with the entry that was just created.
  */
 app()->post('/api/v0/entries', [Entries::class, 'create'])->setName('entries.create');
 
@@ -59,11 +59,11 @@ app()->post('/api/v0/entries', [Entries::class, 'create'])->setName('entries.cre
  * Body:
  * id            - [REQUIRED] - Unique identifier of the entry.
  * token         - [REQUIRED] - Valid public token.
- * access_token  - [REQUIRED] - Valid access token.
+ * access_token  - [REQUIRED] - Valid private access token.
  * data          - [REQUIRED] - Data to update for the entry.
  *
  * Returns:
- * Returns the entry object for the entry that was just updated.
+ * Entry object for the entry that was just updated.
  */
 app()->patch('/api/v0/entries', [Entries::class, 'update'])->setName('entries.update');
 
@@ -76,10 +76,10 @@ app()->patch('/api/v0/entries', [Entries::class, 'update'])->setName('entries.up
  * id            - [REQUIRED] - Unique identifier of the entry.
  * new_id        - [REQUIRED] - New Unique identifier of the entry.
  * token         - [REQUIRED] - Valid public token.
- * access_token  - [REQUIRED] - Valid access token.
+ * access_token  - [REQUIRED] - Valid private access token.
  *
  * Returns:
- * Returns the entry object for the entry that was just moved.
+ * Entry object with the entry that was just moved.
  */
 app()->put('/api/v0/entries', [Entries::class, 'move']);
 
@@ -92,10 +92,10 @@ app()->put('/api/v0/entries', [Entries::class, 'move']);
  * id            - [REQUIRED] - Unique identifier of the entry.
  * new_id        - [REQUIRED] - New Unique identifier of the entry.
  * token         - [REQUIRED] - Valid public token.
- * access_token  - [REQUIRED] - Valid access token.
+ * access_token  - [REQUIRED] - Valid private access token.
  *
  * Returns:
- * Returns the entry object for the entry that was just copied.
+ * Entry object with the entry that was just copied.
  */
 app()->put('/api/v0/entries/copy', [Entries::class, 'copy'])->setName('entries.copy');
 
@@ -107,9 +107,9 @@ app()->put('/api/v0/entries/copy', [Entries::class, 'copy'])->setName('entries.c
  * Body:
  * id           - [REQUIRED] - Unique identifier of the entry.
  * token        - [REQUIRED] - Valid pulbic token.
- * access_token - [REQUIRED] - Valid access token.
+ * access_token - [REQUIRED] - Valid private access token.
  *
  * Returns:
- * Returns an empty body with HTTP status 204
+ * Empty body with HTTP status 204
  */
 app()->delete('/api/v0/entries', [Entries::class, 'delete'])->setName('entries.delete');
diff --git a/src/flextype/routes/endpoints/registry.php b/src/flextype/routes/endpoints/registry.php
index 1f3e7e1c..e84e3509 100644
--- a/src/flextype/routes/endpoints/registry.php
+++ b/src/flextype/routes/endpoints/registry.php
@@ -31,6 +31,6 @@ use function app;
  * default - [OPTIONAL] - Default value for registry item.
  *
  * Returns:
- * An array of registry objects.
+ * Registry object.
  */
 app()->get('/api/v0/registry', [Registry::class, 'get'])->setName('registry.get');
diff --git a/src/flextype/routes/endpoints/utils.php b/src/flextype/routes/endpoints/utils.php
index 46405edc..6559a52f 100644
--- a/src/flextype/routes/endpoints/utils.php
+++ b/src/flextype/routes/endpoints/utils.php
@@ -27,7 +27,7 @@ use function app;
  *
  * Body:
  * token        - [REQUIRED] - Valid public token.
- * access_token - [REQUIRED] - Valid access token.
+ * access_token - [REQUIRED] - Valid private access token.
  * 
  * Returns:
  * Generated token object.
@@ -41,7 +41,7 @@ app()->post('/api/v0/utils/generate-token', [Utils::class, 'generateToken'])->se
  *
  * Body:
  * token        - [REQUIRED] - Valid public token.
- * access_token - [REQUIRED] - Valid access token.
+ * access_token - [REQUIRED] - Valid private access token.
  * string       - [REQUIRED] - String to hash.
  * 
  * Returns:
@@ -56,7 +56,7 @@ app()->post('/api/v0/utils/generate-token-hash', [Utils::class, 'generateTokenHa
  *
  * Body:
  * token        - [REQUIRED] - Valid public token.
- * access_token - [REQUIRED] - Valid access token.
+ * access_token - [REQUIRED] - Valid private access token.
  * string       - [REQUIRED] - String to verify.
  * hash         - [REQUIRED] - Hash to verify.
  *