Minor cleanup (#116)

* Swagger up * Publish swagger * API redirect and cleanup
badgeteam · Jun 24, 2022 · 4ad3814 · 4ad3814
1 parent 26f722c
commit 4ad3814
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -7,8 +7,7 @@
 [![Codecov](https://codecov.io/gh/badgeteam/Hatchery/branch/master/graph/badge.svg)](https://codecov.io/gh/badgeteam/Hatchery)
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbadgeteam%2FHatchery.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbadgeteam%2FHatchery?ref=badge_shield)
 [![Known Vulnerabilities](https://snyk.io/test/github/badgeteam/Hatchery/badge.svg)](https://snyk.io/test/github/badgeteam/Hatchery)
-[![Github Actions](https://github.com/badgeteam/Hatchery/workflows/Laravel/badge.svg)](https://github.com/badgeteam/Hatchery/actions)
-
+[![Laravel](https://github.com/badgeteam/Hatchery/actions/workflows/laravel.yml/badge.svg)](https://github.com/badgeteam/Hatchery/actions/workflows/laravel.yml)
 Simple micropython software repository for Badges.
 
 [Live Site](https://badge.team) \| 

diff --git a/app/Http/Controllers/MchController.php b/app/Http/Controllers/MchController.php
@@ -20,6 +20,7 @@ class MchController extends Controller
      *
      * @OA\Get(
      *   path="/mch2022/devices",
+     *   tags={"MCH2022"},
      * @OA\Response(response="default",ref="#/components/responses/undocumented")
      * )
      *

diff --git a/app/Http/Controllers/PublicController.php b/app/Http/Controllers/PublicController.php
@@ -12,6 +12,7 @@
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Http\JsonResponse;
+use Illuminate\Http\RedirectResponse;
 use Illuminate\Http\Request;
 use Illuminate\View\View;
 use OpenApi\Annotations as OA;
@@ -466,4 +467,12 @@ function ($query) {
             JSON_UNESCAPED_SLASHES
         );
     }
+
+    /**
+     * @return RedirectResponse
+     */
+    public function api(): RedirectResponse
+    {
+        return response()->redirectTo('/api/documentation');
+    }
 }
diff --git a/routes/web.php b/routes/web.php
@@ -17,6 +17,8 @@
 Route::get('badge/{badge}', 'PublicController@badge')->name('badge');
 Route::any('search', 'ProjectsController@index')->name('projects.search');
 
+Route::get('api', 'PublicController@api');
+
 Auth::routes();
 
 Route::middleware(['auth'])->group(function () {