[web-server-plugin][ws-server-plugin] Updating documentation (#250)

* Updating documentation * Fix after upgraded library
FastyBird · Feb 27, 2024 · 0dd2cf6 · 0dd2cf6
1 parent cc4c92d
commit 0dd2cf6
Show file tree

Hide file tree

Showing 19 changed files with 167 additions and 1,058 deletions.
diff --git a/.editorconfig b/.editorconfig
diff --git a/src/FastyBird/Module/Devices/src/Queries/Entities/FindChannelControls.php b/src/FastyBird/Module/Devices/src/Queries/Entities/FindChannelControls.php
@@ -19,10 +19,8 @@
 use Doctrine\Common;
 use Doctrine\ORM;
 use FastyBird\Module\Devices\Entities;
-use FastyBird\Module\Devices\Exceptions;
 use IPub\DoctrineOrmQuery;
 use Ramsey\Uuid;
-use function in_array;
 
 /**
  * Find channel controls entities query
@@ -72,17 +70,13 @@ public function byChannelId(Uuid\UuidInterface $channelId): void
 		};
 	}
 
-	/**
-	 * @throws Exceptions\InvalidArgument
-	 */
-	public function sortBy(string $sortBy, string $sortDir = Common\Collections\Criteria::ASC): void
+	public function sortBy(
+		string $sortBy,
+		Common\Collections\Order $sortDir = Common\Collections\Order::Ascending,
+	): void
 	{
-		if (!in_array($sortDir, [Common\Collections\Criteria::ASC, Common\Collections\Criteria::DESC], true)) {
-			throw new Exceptions\InvalidArgument('Provided sortDir value is not valid.');
-		}
-
 		$this->filter[] = static function (ORM\QueryBuilder $qb) use ($sortBy, $sortDir): void {
-			$qb->addOrderBy($sortBy, $sortDir);
+			$qb->addOrderBy($sortBy, $sortDir->value);
 		};
 	}
 

diff --git a/src/FastyBird/Module/Devices/src/Queries/Entities/FindChannelProperties.php b/src/FastyBird/Module/Devices/src/Queries/Entities/FindChannelProperties.php
@@ -19,10 +19,8 @@
 use Doctrine\Common;
 use Doctrine\ORM;
 use FastyBird\Module\Devices\Entities;
-use FastyBird\Module\Devices\Exceptions;
 use IPub\DoctrineOrmQuery;
 use Ramsey\Uuid;
-use function in_array;
 
 /**
  * Find channel properties entities query
@@ -116,17 +114,13 @@ public function queryable(bool $state): void
 		};
 	}
 
-	/**
-	 * @throws Exceptions\InvalidArgument
-	 */
-	public function sortBy(string $sortBy, string $sortDir = Common\Collections\Criteria::ASC): void
+	public function sortBy(
+		string $sortBy,
+		Common\Collections\Order $sortDir = Common\Collections\Order::Ascending,
+	): void
 	{
-		if (!in_array($sortDir, [Common\Collections\Criteria::ASC, Common\Collections\Criteria::DESC], true)) {
-			throw new Exceptions\InvalidArgument('Provided sortDir value is not valid.');
-		}
-
 		$this->filter[] = static function (ORM\QueryBuilder $qb) use ($sortBy, $sortDir): void {
-			$qb->addOrderBy($sortBy, $sortDir);
+			$qb->addOrderBy($sortBy, $sortDir->value);
 		};
 	}
 

diff --git a/src/FastyBird/Module/Devices/src/Queries/Entities/FindChannels.php b/src/FastyBird/Module/Devices/src/Queries/Entities/FindChannels.php
@@ -19,10 +19,8 @@
 use Doctrine\Common;
 use Doctrine\ORM;
 use FastyBird\Module\Devices\Entities;
-use FastyBird\Module\Devices\Exceptions;
 use IPub\DoctrineOrmQuery;
 use Ramsey\Uuid;
-use function in_array;
 
 /**
  * Find device channels entities query
@@ -113,17 +111,13 @@ public function withSettableProperties(): void
 		};
 	}
 
-	/**
-	 * @throws Exceptions\InvalidArgument
-	 */
-	public function sortBy(string $sortBy, string $sortDir = Common\Collections\Criteria::ASC): void
+	public function sortBy(
+		string $sortBy,
+		Common\Collections\Order $sortDir = Common\Collections\Order::Ascending,
+	): void
 	{
-		if (!in_array($sortDir, [Common\Collections\Criteria::ASC, Common\Collections\Criteria::DESC], true)) {
-			throw new Exceptions\InvalidArgument('Provided sortDir value is not valid.');
-		}
-
 		$this->filter[] = static function (ORM\QueryBuilder $qb) use ($sortBy, $sortDir): void {
-			$qb->addOrderBy($sortBy, $sortDir);
+			$qb->addOrderBy($sortBy, $sortDir->value);
 		};
 	}
 

diff --git a/src/FastyBird/Module/Devices/src/Queries/Entities/FindConnectorControls.php b/src/FastyBird/Module/Devices/src/Queries/Entities/FindConnectorControls.php
@@ -19,10 +19,8 @@
 use Doctrine\Common;
 use Doctrine\ORM;
 use FastyBird\Module\Devices\Entities;
-use FastyBird\Module\Devices\Exceptions;
 use IPub\DoctrineOrmQuery;
 use Ramsey\Uuid;
-use function in_array;
 
 /**
  * Find connector properties entities query
@@ -72,17 +70,13 @@ public function byConnectorId(Uuid\UuidInterface $connectorId): void
 		};
 	}
 
-	/**
-	 * @throws Exceptions\InvalidArgument
-	 */
-	public function sortBy(string $sortBy, string $sortDir = Common\Collections\Criteria::ASC): void
+	public function sortBy(
+		string $sortBy,
+		Common\Collections\Order $sortDir = Common\Collections\Order::Ascending,
+	): void
 	{
-		if (!in_array($sortDir, [Common\Collections\Criteria::ASC, Common\Collections\Criteria::DESC], true)) {
-			throw new Exceptions\InvalidArgument('Provided sortDir value is not valid.');
-		}
-
 		$this->filter[] = static function (ORM\QueryBuilder $qb) use ($sortBy, $sortDir): void {
-			$qb->addOrderBy($sortBy, $sortDir);
+			$qb->addOrderBy($sortBy, $sortDir->value);
 		};
 	}
 

diff --git a/src/FastyBird/Module/Devices/src/Queries/Entities/FindConnectorProperties.php b/src/FastyBird/Module/Devices/src/Queries/Entities/FindConnectorProperties.php
@@ -19,10 +19,8 @@
 use Doctrine\Common;
 use Doctrine\ORM;
 use FastyBird\Module\Devices\Entities;
-use FastyBird\Module\Devices\Exceptions;
 use IPub\DoctrineOrmQuery;
 use Ramsey\Uuid;
-use function in_array;
 
 /**
  * Find connector properties entities query
@@ -101,17 +99,13 @@ public function queryable(bool $state): void
 		};
 	}
 
-	/**
-	 * @throws Exceptions\InvalidArgument
-	 */
-	public function sortBy(string $sortBy, string $sortDir = Common\Collections\Criteria::ASC): void
+	public function sortBy(
+		string $sortBy,
+		Common\Collections\Order $sortDir = Common\Collections\Order::Ascending,
+	): void
 	{
-		if (!in_array($sortDir, [Common\Collections\Criteria::ASC, Common\Collections\Criteria::DESC], true)) {
-			throw new Exceptions\InvalidArgument('Provided sortDir value is not valid.');
-		}
-
 		$this->filter[] = static function (ORM\QueryBuilder $qb) use ($sortBy, $sortDir): void {
-			$qb->addOrderBy($sortBy, $sortDir);
+			$qb->addOrderBy($sortBy, $sortDir->value);
 		};
 	}
 

diff --git a/src/FastyBird/Module/Devices/src/Queries/Entities/FindConnectors.php b/src/FastyBird/Module/Devices/src/Queries/Entities/FindConnectors.php
@@ -19,10 +19,8 @@
 use Doctrine\Common;
 use Doctrine\ORM;
 use FastyBird\Module\Devices\Entities;
-use FastyBird\Module\Devices\Exceptions;
 use IPub\DoctrineOrmQuery;
 use Ramsey\Uuid;
-use function in_array;
 
 /**
  * Find connectors entities query
@@ -57,17 +55,13 @@ public function byIdentifier(string $identifier): void
 		};
 	}
 
-	/**
-	 * @throws Exceptions\InvalidArgument
-	 */
-	public function sortBy(string $sortBy, string $sortDir = Common\Collections\Criteria::ASC): void
+	public function sortBy(
+		string $sortBy,
+		Common\Collections\Order $sortDir = Common\Collections\Order::Ascending,
+	): void
 	{
-		if (!in_array($sortDir, [Common\Collections\Criteria::ASC, Common\Collections\Criteria::DESC], true)) {
-			throw new Exceptions\InvalidArgument('Provided sortDir value is not valid.');
-		}
-
 		$this->filter[] = static function (ORM\QueryBuilder $qb) use ($sortBy, $sortDir): void {
-			$qb->addOrderBy($sortBy, $sortDir);
+			$qb->addOrderBy($sortBy, $sortDir->value);
 		};
 	}
 

diff --git a/src/FastyBird/Module/Devices/src/Queries/Entities/FindDeviceControls.php b/src/FastyBird/Module/Devices/src/Queries/Entities/FindDeviceControls.php
@@ -19,10 +19,8 @@
 use Doctrine\Common;
 use Doctrine\ORM;
 use FastyBird\Module\Devices\Entities;
-use FastyBird\Module\Devices\Exceptions;
 use IPub\DoctrineOrmQuery;
 use Ramsey\Uuid;
-use function in_array;
 
 /**
  * Find device controls entities query
@@ -72,17 +70,13 @@ public function byDeviceId(Uuid\UuidInterface $deviceId): void
 		};
 	}
 
-	/**
-	 * @throws Exceptions\InvalidArgument
-	 */
-	public function sortBy(string $sortBy, string $sortDir = Common\Collections\Criteria::ASC): void
+	public function sortBy(
+		string $sortBy,
+		Common\Collections\Order $sortDir = Common\Collections\Order::Ascending,
+	): void
 	{
-		if (!in_array($sortDir, [Common\Collections\Criteria::ASC, Common\Collections\Criteria::DESC], true)) {
-			throw new Exceptions\InvalidArgument('Provided sortDir value is not valid.');
-		}
-
 		$this->filter[] = static function (ORM\QueryBuilder $qb) use ($sortBy, $sortDir): void {
-			$qb->addOrderBy($sortBy, $sortDir);
+			$qb->addOrderBy($sortBy, $sortDir->value);
 		};
 	}
 

diff --git a/src/FastyBird/Module/Devices/src/Queries/Entities/FindDeviceProperties.php b/src/FastyBird/Module/Devices/src/Queries/Entities/FindDeviceProperties.php
@@ -19,10 +19,8 @@
 use Doctrine\Common;
 use Doctrine\ORM;
 use FastyBird\Module\Devices\Entities;
-use FastyBird\Module\Devices\Exceptions;
 use IPub\DoctrineOrmQuery;
 use Ramsey\Uuid;
-use function in_array;
 
 /**
  * Find device properties entities query
@@ -116,17 +114,13 @@ public function queryable(bool $state): void
 		};
 	}
 
-	/**
-	 * @throws Exceptions\InvalidArgument
-	 */
-	public function sortBy(string $sortBy, string $sortDir = Common\Collections\Criteria::ASC): void
+	public function sortBy(
+		string $sortBy,
+		Common\Collections\Order $sortDir = Common\Collections\Order::Ascending,
+	): void
 	{
-		if (!in_array($sortDir, [Common\Collections\Criteria::ASC, Common\Collections\Criteria::DESC], true)) {
-			throw new Exceptions\InvalidArgument('Provided sortDir value is not valid.');
-		}
-
 		$this->filter[] = static function (ORM\QueryBuilder $qb) use ($sortBy, $sortDir): void {
-			$qb->addOrderBy($sortBy, $sortDir);
+			$qb->addOrderBy($sortBy, $sortDir->value);
 		};
 	}
 

diff --git a/src/FastyBird/Module/Devices/src/Queries/Entities/FindDevices.php b/src/FastyBird/Module/Devices/src/Queries/Entities/FindDevices.php
@@ -19,10 +19,8 @@
 use Doctrine\Common;
 use Doctrine\ORM;
 use FastyBird\Module\Devices\Entities;
-use FastyBird\Module\Devices\Exceptions;
 use IPub\DoctrineOrmQuery;
 use Ramsey\Uuid;
-use function in_array;
 
 /**
  * Find devices entities query
@@ -144,17 +142,13 @@ public function withChannels(): void
 		};
 	}
 
-	/**
-	 * @throws Exceptions\InvalidArgument
-	 */
-	public function sortBy(string $sortBy, string $sortDir = Common\Collections\Criteria::ASC): void
+	public function sortBy(
+		string $sortBy,
+		Common\Collections\Order $sortDir = Common\Collections\Order::Ascending,
+	): void
 	{
-		if (!in_array($sortDir, [Common\Collections\Criteria::ASC, Common\Collections\Criteria::DESC], true)) {
-			throw new Exceptions\InvalidArgument('Provided sortDir value is not valid.');
-		}
-
 		$this->filter[] = static function (ORM\QueryBuilder $qb) use ($sortBy, $sortDir): void {
-			$qb->addOrderBy($sortBy, $sortDir);
+			$qb->addOrderBy($sortBy, $sortDir->value);
 		};
 	}
 

diff --git a/src/FastyBird/Module/Triggers/src/Queries/Entities/FindTriggerControls.php b/src/FastyBird/Module/Triggers/src/Queries/Entities/FindTriggerControls.php
@@ -19,10 +19,8 @@
 use Doctrine\Common;
 use Doctrine\ORM;
 use FastyBird\Module\Triggers\Entities;
-use FastyBird\Module\Triggers\Exceptions;
 use IPub\DoctrineOrmQuery;
 use Ramsey\Uuid;
-use function in_array;
 
 /**
  * Find trigger properties entities query
@@ -71,17 +69,13 @@ public function forTrigger(Entities\Triggers\Trigger $trigger): void
 		};
 	}
 
-	/**
-	 * @throws Exceptions\InvalidArgument
-	 */
-	public function sortBy(string $sortBy, string $sortDir = Common\Collections\Criteria::ASC): void
+	public function sortBy(
+		string $sortBy,
+		Common\Collections\Order $sortDir = Common\Collections\Order::Ascending,
+	): void
 	{
-		if (!in_array($sortDir, [Common\Collections\Criteria::ASC, Common\Collections\Criteria::DESC], true)) {
-			throw new Exceptions\InvalidArgument('Provided sortDir value is not valid.');
-		}
-
 		$this->filter[] = static function (ORM\QueryBuilder $qb) use ($sortBy, $sortDir): void {
-			$qb->addOrderBy($sortBy, $sortDir);
+			$qb->addOrderBy($sortBy, $sortDir->value);
 		};
 	}
 

diff --git a/src/FastyBird/Plugin/WebServer/.github/workflows/wiki.yml b/src/FastyBird/Plugin/WebServer/.github/workflows/wiki.yml
@@ -0,0 +1,22 @@
+name: "wiki"
+
+on:
+  push:
+    branches:
+      - "main"
+
+jobs:
+  deploy:
+    name: "Deploy docs to wiki"
+    runs-on: "ubuntu-latest"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v4"
+
+      - name: "Deploy to Wiki"
+        uses: "SwiftDocOrg/github-wiki-publish-action@v1"
+        with:
+          path: "docs"
+        env:
+          GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
diff --git a/src/FastyBird/Plugin/WebServer/README.md b/src/FastyBird/Plugin/WebServer/README.md
@@ -41,8 +41,7 @@ composer require fastybird/web-server-plugin
 
 ## Documentation
 
-Learn how to build and handle http api requests
-in [documentation](https://github.com/FastyBird/web-server-plugin/blob/main/docs/index.md).
+:book: Learn how to build and handle http api requests in [documentation](https://github.com/FastyBird/web-server-plugin/wiki).
 
 # FastyBird
 
@@ -54,7 +53,7 @@ FastyBird is an Open Source IOT solution built from decoupled components with po
 
 ## Documentation
 
-Documentation is available on [docs.fastybird.com](https://docs.fastybird.com).
+:book: Documentation is available on [docs.fastybird.com](https://docs.fastybird.com).
 
 ## Contributing