summaryrefslogtreecommitdiffstats
path: root/vendor/gipfl/openrpc/src/ExternalDocumentation.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/gipfl/openrpc/src/ExternalDocumentation.php')
-rw-r--r--vendor/gipfl/openrpc/src/ExternalDocumentation.php37
1 files changed, 37 insertions, 0 deletions
diff --git a/vendor/gipfl/openrpc/src/ExternalDocumentation.php b/vendor/gipfl/openrpc/src/ExternalDocumentation.php
new file mode 100644
index 0000000..54b5883
--- /dev/null
+++ b/vendor/gipfl/openrpc/src/ExternalDocumentation.php
@@ -0,0 +1,37 @@
+<?php
+
+namespace gipfl\OpenRpc;
+
+use JsonSerializable;
+
+/**
+ * Allows referencing an external resource for extended documentation
+ */
+class ExternalDocumentation implements JsonSerializable
+{
+ use SimpleJsonSerializer;
+
+ /**
+ * REQUIRED. The URL for the target documentation. Value MUST be in the
+ * format of a URL.
+ *
+ * @var string
+ */
+ public $url;
+
+ /**
+ * A verbose explanation of the target documentation. GitHub Flavored Markdown
+ * syntax MAY be used for rich text representation.
+ *
+ * @var string|null
+ */
+ public $description;
+
+ /**
+ * @param $url
+ */
+ public function __construct($url)
+ {
+ $this->url = $url;
+ }
+}