Update documentation

art-institute-of-chicago · Apr 18, 2018 · ec0f4d9 · ec0f4d9
1 parent 716c725
commit ec0f4d9
Show file tree

Hide file tree

Showing 8 changed files with 732 additions and 921 deletions.
diff --git a/app/Console/Commands/CreateEndpointDocs.php b/app/Console/Commands/CreateEndpointDocs.php
@@ -66,7 +66,6 @@ public function handle()
         $doc .= \App\Models\Collections\Exhibition::instance()->docEndpoints($this->appUrl);
         $doc .= \App\Models\Collections\Image::instance()->docEndpoints($this->appUrl);
         $doc .= \App\Models\Collections\Video::instance()->docEndpoints($this->appUrl);
-        $doc .= \App\Models\Collections\Link::instance()->docEndpoints($this->appUrl);
         $doc .= \App\Models\Collections\Sound::instance()->docEndpoints($this->appUrl);
         $doc .= \App\Models\Collections\Text::instance()->docEndpoints($this->appUrl);
 

diff --git a/app/Console/Commands/CreateFieldsDocs.php b/app/Console/Commands/CreateFieldsDocs.php
@@ -44,7 +44,6 @@ public function handle()
         $doc .= \App\Models\Collections\Exhibition::instance()->docFields();
         $doc .= \App\Models\Collections\Image::instance()->docFields();
         $doc .= \App\Models\Collections\Video::instance()->docFields();
-        $doc .= \App\Models\Collections\Link::instance()->docFields();
         $doc .= \App\Models\Collections\Sound::instance()->docFields();
         $doc .= \App\Models\Collections\Text::instance()->docFields();
 

diff --git a/app/Console/Commands/CreateSwaggerDoc.php b/app/Console/Commands/CreateSwaggerDoc.php
@@ -93,7 +93,6 @@ public function handle()
         $doc .= \App\Models\Collections\Exhibition::instance()->swaggerEndpoints($this->appUrl);
         $doc .= \App\Models\Collections\Image::instance()->swaggerEndpoints($this->appUrl);
         $doc .= \App\Models\Collections\Video::instance()->swaggerEndpoints($this->appUrl);
-        $doc .= \App\Models\Collections\Link::instance()->swaggerEndpoints($this->appUrl);
         $doc .= \App\Models\Collections\Sound::instance()->swaggerEndpoints($this->appUrl);
         $doc .= \App\Models\Collections\Text::instance()->swaggerEndpoints($this->appUrl);
 

diff --git a/app/Models/Documentable.php b/app/Models/Documentable.php
@@ -952,8 +952,17 @@ public function swaggerSubresource($subresource, $includeExampleOutput = true)
         $doc .= $this->swaggerProduces();
         $doc .= $this->swaggerParameters(['id' => 'Resource id to retrieve']);
 
-        $subModel = app('Resources')->getModelForEndpoint($subresource);
-        $doc .= $this->swaggerResponses(class_basename($subModel));
+        try
+        {
+            $subModel = app('Resources')->getModelForEndpoint($subresource);
+            $doc .= $this->swaggerResponses(class_basename($subModel));
+        }
+        catch (\Exception $e)
+        {
+            // Fall back to using this model's own response, in cases like `parts` and `sets` where
+            // the subresource represensts a set of the same models
+            $doc .= $this->swaggerResponses();
+        }
 
         $doc .= "      }\n";
         $doc .= "    },\n";

diff --git a/app/Models/Mobile/TourStop.php b/app/Models/Mobile/TourStop.php
@@ -109,7 +109,19 @@ protected function transformMappingInternal()
     public function exampleId()
     {
 
-        return "3245";
+        return "77";
+
+    }
+
+    /**
+     * Whether this resource has a `/search` endpoint
+     *
+     * @return boolean
+     */
+    public function hasSearchEndpoint()
+    {
+
+        return false;
 
     }