fix: move query to path in models swagger

NFDI4Chem · Dec 8, 2023 · c519798 · c519798
1 parent 526e92a
commit c519798
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/app/Http/Controllers/API/DatasetController.php b/app/Http/Controllers/API/DatasetController.php
@@ -42,15 +42,15 @@ public function all(Request $request)
 
     /**
      * @OA\Get(
-     * path="/api/v1/dataset/?id={id}",
+     * path="/api/v1/dataset/{id}",
      * summary="Fetch nmrXiv public datasets based on identifier",
      * description="Fetch details of nmrXiv public dataset based on identifier.",
      * operationId="publicDataset",
      * tags={"public"},
      *
      * @OA\Parameter(
      *  name="id",
-     *  in="query",
+     *  in="path",
      *  description="Public dataset identifier e.g. D12",
      *  required=true,
      *

diff --git a/app/Http/Controllers/API/ProjectController.php b/app/Http/Controllers/API/ProjectController.php
@@ -42,15 +42,15 @@ public function all(Request $request)
 
     /**
      * @OA\Get(
-     * path="/api/v1/project/?id={id}",
+     * path="/api/v1/project/{id}",
      * summary="Fetch nmrXiv public project based on identifier",
      * description="Fetch details of nmrXiv public project based on identifier.",
      * operationId="publicProject",
      * tags={"public"},
      *
      * @OA\Parameter(
      *  name="id",
-     *  in="query",
+     *  in="path",
      *  description="Public project identifier e.g. P12",
      *  required=true,
      *

diff --git a/app/Http/Controllers/API/StudyController.php b/app/Http/Controllers/API/StudyController.php
@@ -42,15 +42,15 @@ public function all(Request $request)
 
     /**
      * @OA\Get(
-     * path="/api/v1/sample/?id={id}",
+     * path="/api/v1/sample/{id}",
      * summary="Fetch nmrXiv public samples based on identifier",
      * description="Fetch details of nmrXiv public sample based on identifier.",
      * operationId="publicSample",
      * tags={"public"},
      *
      * @OA\Parameter(
      *  name="id",
-     *  in="query",
+     *  in="path",
      *  description="Public sample identifier e.g. S12",
      *  required=true,
      *

diff --git a/storage/api-docs/api-docs.json b/storage/api-docs/api-docs.json
@@ -215,7 +215,7 @@
                 }
             }
         },
-        "/api/v1/dataset/?id={id}": {
+        "/api/v1/dataset/{id}": {
             "get": {
                 "tags": [
                     "public"
@@ -226,7 +226,7 @@
                 "parameters": [
                     {
                         "name": "id",
-                        "in": "query",
+                        "in": "path",
                         "description": "Public dataset identifier e.g. D12",
                         "required": true,
                         "schema": {
@@ -265,7 +265,7 @@
                 }
             }
         },
-        "/api/v1/project/?id={id}": {
+        "/api/v1/project/{id}": {
             "get": {
                 "tags": [
                     "public"
@@ -276,7 +276,7 @@
                 "parameters": [
                     {
                         "name": "id",
-                        "in": "query",
+                        "in": "path",
                         "description": "Public project identifier e.g. P12",
                         "required": true,
                         "schema": {
@@ -511,7 +511,7 @@
                 }
             }
         },
-        "/api/v1/sample/?id={id}": {
+        "/api/v1/sample/{id}": {
             "get": {
                 "tags": [
                     "public"
@@ -522,7 +522,7 @@
                 "parameters": [
                     {
                         "name": "id",
-                        "in": "query",
+                        "in": "path",
                         "description": "Public sample identifier e.g. S12",
                         "required": true,
                         "schema": {