refactor(dpc/rest-api): reorganaize directory structures

yoshinorin · Oct 20, 2024 · 86ac6cd · 86ac6cd
1 parent 433405a
commit 86ac6cd
Show file tree

Hide file tree

Showing 34 changed files with 24 additions and 24 deletions.
diff --git a/...i/components/schemas/externalResource.yml → ...nents/schemas/common/externalResource.yml b/...i/components/schemas/externalResource.yml → ...nents/schemas/common/externalResource.yml
diff --git a/docs/rest-api/components/schemas/tag.yml → ...est-api/components/schemas/common/tag.yml b/docs/rest-api/components/schemas/tag.yml → ...est-api/components/schemas/common/tag.yml
diff --git a/...s/schemas/responseSearchUnprocessable.yml → ...ts/schemas/errors/searchUnprocessable.yml b/...s/schemas/responseSearchUnprocessable.yml → ...ts/schemas/errors/searchUnprocessable.yml
diff --git a/...api/components/schemas/requestContent.yml → ...pi/components/schemas/request/content.yml b/...api/components/schemas/requestContent.yml → ...pi/components/schemas/request/content.yml
@@ -9,7 +9,7 @@ properties:
   externalResources:
     type: array
     items:
-      $ref: './externalResource.yml'
+      $ref: '../common/externalResource.yml'
   title:
     type: string
     example: "Post Title"

diff --git a/...-api/components/schemas/requestSeries.yml → ...api/components/schemas/request/series.yml b/...-api/components/schemas/requestSeries.yml → ...api/components/schemas/request/series.yml
diff --git a/...t-api/components/schemas/requestToken.yml → ...-api/components/schemas/request/token.yml b/...t-api/components/schemas/requestToken.yml → ...-api/components/schemas/request/token.yml
diff --git a/...pi/components/schemas/applicationInfo.yml → ...ents/schemas/response/applicationInfo.yml b/...pi/components/schemas/applicationInfo.yml → ...ents/schemas/response/applicationInfo.yml
diff --git a/docs/rest-api/components/schemas/article.yml → ...i/components/schemas/response/article.yml b/docs/rest-api/components/schemas/article.yml → ...i/components/schemas/response/article.yml
diff --git a/docs/rest-api/components/schemas/author.yml → ...pi/components/schemas/response/author.yml b/docs/rest-api/components/schemas/author.yml → ...pi/components/schemas/response/author.yml
diff --git a/...pi/components/schemas/responseContent.yml → ...i/components/schemas/response/content.yml b/...pi/components/schemas/responseContent.yml → ...i/components/schemas/response/content.yml
@@ -22,11 +22,11 @@ properties:
   externalResources:
     type: array
     items:
-      $ref: './externalResource.yml'
+      $ref: '../common/externalResource.yml'
   tags:
     type: array
     items:
-      $ref: './tag.yml'
+      $ref: '../common/tag.yml'
   description:
     type: string
     example: "Post description... not HTML strings"

diff --git a/...st-api/components/schemas/contentType.yml → ...mponents/schemas/response/contentType.yml b/...st-api/components/schemas/contentType.yml → ...mponents/schemas/response/contentType.yml
diff --git a/docs/rest-api/components/schemas/feed.yml → ...-api/components/schemas/response/feed.yml b/docs/rest-api/components/schemas/feed.yml → ...-api/components/schemas/response/feed.yml
diff --git a/docs/rest-api/components/schemas/idToken.yml → ...i/components/schemas/response/idToken.yml b/docs/rest-api/components/schemas/idToken.yml → ...i/components/schemas/response/idToken.yml
diff --git a/...api/components/schemas/responseSearch.yml → ...pi/components/schemas/response/search.yml b/...api/components/schemas/responseSearch.yml → ...pi/components/schemas/response/search.yml
diff --git a/docs/rest-api/components/schemas/series.yml → ...pi/components/schemas/response/series.yml b/docs/rest-api/components/schemas/series.yml → ...pi/components/schemas/response/series.yml
diff --git a/...-api/components/schemas/simpleArticle.yml → ...onents/schemas/response/simpleArticle.yml b/...-api/components/schemas/simpleArticle.yml → ...onents/schemas/response/simpleArticle.yml
diff --git a/docs/rest-api/components/schemas/sitemap.yml → ...i/components/schemas/response/sitemap.yml b/docs/rest-api/components/schemas/sitemap.yml → ...i/components/schemas/response/sitemap.yml
diff --git a/...t-api/components/schemas/tagWithCount.yml → ...ponents/schemas/response/tagWithCount.yml b/...t-api/components/schemas/tagWithCount.yml → ...ponents/schemas/response/tagWithCount.yml
diff --git a/docs/rest-api/paths/v1/archives.yml b/docs/rest-api/paths/v1/archives.yml
@@ -10,4 +10,4 @@ get:
           schema:
             type: array
             items:
-              $ref: '../../components/schemas/simpleArticle.yml'
+              $ref: '../../components/schemas/response/simpleArticle.yml'
diff --git a/docs/rest-api/paths/v1/articles.yml b/docs/rest-api/paths/v1/articles.yml
@@ -28,7 +28,7 @@ get:
               articles:
                 type: array
                 items:
-                  $ref: '../../components/schemas/article.yml'
+                  $ref: '../../components/schemas/response/article.yml'
             required:
               - count
               - articles
diff --git a/docs/rest-api/paths/v1/author.yml b/docs/rest-api/paths/v1/author.yml
@@ -9,7 +9,7 @@ get:
         application/json:
           schema:
             type: object
-            $ref: '../../components/schemas/author.yml'
+            $ref: '../../components/schemas/response/author.yml'
     404:
       description: Author not found
       content:

diff --git a/docs/rest-api/paths/v1/authors.yml b/docs/rest-api/paths/v1/authors.yml
@@ -10,4 +10,4 @@ get:
           schema:
             type: array
             items:
-              $ref: '../../components/schemas/author.yml'
+              $ref: '../../components/schemas/response/author.yml'
diff --git a/docs/rest-api/paths/v1/contentTypes.yml b/docs/rest-api/paths/v1/contentTypes.yml
@@ -9,4 +9,4 @@ get:
         application/json:
           schema:
             items:
-              $ref: '../../components/schemas/contentType.yml'
+              $ref: '../../components/schemas/response/contentType.yml'
diff --git a/docs/rest-api/paths/v1/contents/getByPath.yml b/docs/rest-api/paths/v1/contents/getByPath.yml
@@ -8,7 +8,7 @@ get:
       content:
         application/json:
           schema:
-            $ref: '../../../components/schemas/responseContent.yml'
+            $ref: '../../../components/schemas/response/content.yml'
     404:
       description: Content not found
       content:

diff --git a/docs/rest-api/paths/v1/contents/upsert.yml b/docs/rest-api/paths/v1/contents/upsert.yml
@@ -10,14 +10,14 @@ post:
     content:
       application/json:
         schema:
-          $ref: '../../../components/schemas/requestContent.yml'
+          $ref: '../../../components/schemas/request/content.yml'
   responses:
     201:
       description: Create or Update succeeded
       content:
         application/json:
           schema:
-            $ref: '../../../components/schemas/responseContent.yml'
+            $ref: '../../../components/schemas/response/content.yml'
     400:
       description: BadRequest
       content:

diff --git a/docs/rest-api/paths/v1/feeds.yml b/docs/rest-api/paths/v1/feeds.yml
@@ -10,4 +10,4 @@ get:
           schema:
             type: array
             items:
-              $ref: '../../components/schemas/feed.yml'
+              $ref: '../../components/schemas/response/feed.yml'
diff --git a/docs/rest-api/paths/v1/metadata.yml b/docs/rest-api/paths/v1/metadata.yml
@@ -8,7 +8,7 @@ get:
       content:
         application/json:
           schema:
-            $ref: '../../components/schemas/applicationInfo.yml'
+            $ref: '../../components/schemas/response/applicationInfo.yml'
     404:
       description: Resource not found (If envval `QUALTET_HTTP_ENDPOINT_SYSTEM_METADATA_ENABLED` is `false` or not exists)
       content:

diff --git a/docs/rest-api/paths/v1/search.yml b/docs/rest-api/paths/v1/search.yml
@@ -23,7 +23,7 @@ get:
               contents:
                 type: array
                 items:
-                  $ref: '../../components/schemas/responseSearch.yml'
+                  $ref: '../../components/schemas/response/search.yml'
             required:
               - count
               - contents
@@ -98,7 +98,7 @@ get:
               errors:
                 type: array
                 items:
-                  $ref: '../../components/schemas/responseSearchUnprocessable.yml'
+                  $ref: '../../components/schemas/errors/searchUnprocessable.yml'
             required:
               - type
               - title

diff --git a/docs/rest-api/paths/v1/series/byName.yml b/docs/rest-api/paths/v1/series/byName.yml
@@ -10,7 +10,7 @@ get:
           schema:
             type: array
             items:
-              $ref: '../../../components/schemas/series.yml'
+              $ref: '../../../components/schemas/response/series.yml'
     404:
       description: Series not found
       content:

diff --git a/docs/rest-api/paths/v1/series/series.yml b/docs/rest-api/paths/v1/series/series.yml
@@ -10,7 +10,7 @@ get:
           schema:
             type: array
             items:
-              $ref: '../../../components/schemas/series.yml'
+              $ref: '../../../components/schemas/response/series.yml'
 post:
   summary: Create or Update a series
   tags:
@@ -23,14 +23,14 @@ post:
     content:
       application/json:
         schema:
-          $ref: '../../../components/schemas/requestSeries.yml'
+          $ref: '../../../components/schemas/request/series.yml'
   responses:
     201:
       description: Create or Update succeeded
       content:
         application/json:
           schema:
-            $ref: '../../../components/schemas/series.yml'
+            $ref: '../../../components/schemas/response/series.yml'
     400:
       description: BadRequest
       content:

diff --git a/docs/rest-api/paths/v1/sitemaps.yml b/docs/rest-api/paths/v1/sitemaps.yml
@@ -13,4 +13,4 @@ get:
           schema:
             type: array
             items:
-              $ref: '../../components/schemas/sitemap.yml'
+              $ref: '../../components/schemas/response/sitemap.yml'
diff --git a/docs/rest-api/paths/v1/tags/get.yml b/docs/rest-api/paths/v1/tags/get.yml
@@ -9,4 +9,4 @@ get:
         application/json:
           schema:
             items:
-              $ref: '../../../components/schemas/tagWithCount.yml'
+              $ref: '../../../components/schemas/response/tagWithCount.yml'
diff --git a/docs/rest-api/paths/v1/tags/getByName.yml b/docs/rest-api/paths/v1/tags/getByName.yml
@@ -9,7 +9,7 @@ get:
         application/json:
           schema:
             items:
-              $ref: '../../../components/schemas/simpleArticle.yml'
+              $ref: '../../../components/schemas/response/simpleArticle.yml'
     404:
       description: Tag not found
       content:

diff --git a/docs/rest-api/paths/v1/token.yml b/docs/rest-api/paths/v1/token.yml
@@ -10,14 +10,14 @@ post:
     content:
       application/json:
         schema:
-          $ref: '../../components/schemas/requestToken.yml'
+          $ref: '../../components/schemas/request/token.yml'
   responses:
     201:
       description: Create an IDToken succeeded
       content:
         application/json:
           schema:
-            $ref: '../../components/schemas/idToken.yml'
+            $ref: '../../components/schemas/response/idToken.yml'
     400:
       description: Payload is wrong
       content: