From 93c6bd53693a73074ea3def65a94c949e4a99c44 Mon Sep 17 00:00:00 2001
From: Chris Deighton <chris@serato.com>
Date: Tue, 27 Nov 2018 10:31:19 +1300
Subject: [PATCH] Adds `Serato\SwsApp\InterfaceToApiSchemaArray`

---
 src/InterfaceToApiSchemaArray.php | 34 +++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 src/InterfaceToApiSchemaArray.php

diff --git a/src/InterfaceToApiSchemaArray.php b/src/InterfaceToApiSchemaArray.php
new file mode 100644
index 0000000..02fb6c6
--- /dev/null
+++ b/src/InterfaceToApiSchemaArray.php
@@ -0,0 +1,34 @@
+<?php
+namespace Serato\SwsApp;
+
+/**
+ * Defines the methods required for an object to return an array representation
+ * of it's data that conforms to a JSON specifications for an API endpoint.
+ */
+interface InterfaceToApiSchemaArray
+{
+    /**
+     * Returns an array representation of the data that conforms to the
+     * JSON schema. Can take an array `$options` of model-specific formatting
+     * options that can alter the content or format of the returned array.
+     *
+     * @param array $options    Formatting options
+     *
+     * @return array
+     */
+    public function toApiSchemaArray(array $options = []): array;
+
+    /**
+     * Returns the path to a JSON file containing the schema definition for the model
+     *
+     * @return string
+     */
+    public function getSchemaFilePath(): string;
+
+    /**
+     * Returns the name of the schema definition for the model
+     *
+     * @return string
+     */
+    public function getSchemaDefintion(): string;
+}