summaryrefslogtreecommitdiffstats
path: root/vendor/gipfl/openrpc/src/Components.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/gipfl/openrpc/src/Components.php')
-rw-r--r--vendor/gipfl/openrpc/src/Components.php68
1 files changed, 68 insertions, 0 deletions
diff --git a/vendor/gipfl/openrpc/src/Components.php b/vendor/gipfl/openrpc/src/Components.php
new file mode 100644
index 0000000..621a9a0
--- /dev/null
+++ b/vendor/gipfl/openrpc/src/Components.php
@@ -0,0 +1,68 @@
+<?php
+
+namespace gipfl\OpenRpc;
+
+use JsonSerializable;
+
+/**
+ * Holds a set of reusable objects for different aspects of the OpenRPC. All
+ * objects defined within the components object will have no effect on the API
+ * unless they are explicitly referenced from properties outside the components
+ * object.
+ *
+ * All the fixed fields declared are objects that MUST use keys that match the
+ * regular expression: ^[a-zA-Z0-9\.\-_]+$
+ */
+class Components implements JsonSerializable
+{
+ use SimpleJsonSerializer;
+
+ /**
+ * An object to hold reusable Content Descriptor Objects
+ *
+ * @var ContentDescriptor[] Map[string, Content Descriptor Object]
+ */
+ public $contentDescriptors;
+
+ /**
+ * An object to hold reusable Schema Objects
+ *
+ * @var SchemaObject[] Map[string, Schema Object]
+ */
+ public $schemas;
+
+ /**
+ * An object to hold reusable Example Objects
+ *
+ * @var Example[] Map[string, Example Object]
+ */
+ public $examples;
+
+ /**
+ * An object to hold reusable Link Objects
+ *
+ * @var Link[] Map[string, Link Object]
+ */
+ public $links;
+
+ /**
+ * An object to hold reusable Error Objects
+ *
+ * @var Error[] Map[string, Error Object]
+ */
+ public $errors;
+
+ /**
+ * An object to hold reusable Example Pairing Objects
+ *
+ * @var ExamplePairing[] Map[string, Example Pairing Object]
+ */
+ public $examplePairingObjects;
+
+ /**
+ * An object to hold reusable Tag Objects
+ *
+ * @var TagObject[] Map[string, Tag Object]
+ */
+ public $tags;
+}