summaryrefslogtreecommitdiffstats
path: root/vendor/gipfl/openrpc/src/ExamplePairing.php
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 12:44:51 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 12:44:51 +0000
commita1ec78bf0dc93d0e05e5f066f1949dc3baecea06 (patch)
treeee596ce1bc9840661386f96f9b8d1f919a106317 /vendor/gipfl/openrpc/src/ExamplePairing.php
parentInitial commit. (diff)
downloadicingaweb2-module-incubator-a1ec78bf0dc93d0e05e5f066f1949dc3baecea06.tar.xz
icingaweb2-module-incubator-a1ec78bf0dc93d0e05e5f066f1949dc3baecea06.zip
Adding upstream version 0.20.0.upstream/0.20.0upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/gipfl/openrpc/src/ExamplePairing.php')
-rw-r--r--vendor/gipfl/openrpc/src/ExamplePairing.php30
1 files changed, 30 insertions, 0 deletions
diff --git a/vendor/gipfl/openrpc/src/ExamplePairing.php b/vendor/gipfl/openrpc/src/ExamplePairing.php
new file mode 100644
index 0000000..6f34137
--- /dev/null
+++ b/vendor/gipfl/openrpc/src/ExamplePairing.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace gipfl\OpenRpc;
+
+use JsonSerializable;
+
+/**
+ * The example Pairing object consists of a set of example params and result.
+ * The result is what you can expect from the JSON-RPC service given the exact
+ * params.
+ */
+class ExamplePairing implements JsonSerializable
+{
+ use SimpleJsonSerializer;
+
+ /** @var string|null Name for the example pairing */
+ public $name;
+
+ /** @var string|null A verbose explanation of the example pairing */
+ public $summary;
+
+ /** @var string|null Short description for the example pairing */
+ public $description;
+
+ /** @var <Example|Reference>[] Example parameters */
+ public $params;
+
+ /** @var Example|Reference Example result */
+ public $result;
+}