From 86ac6cd4846d2447d1c3eaefcbc4bc9ad585a146 Mon Sep 17 00:00:00 2001 From: yoshinorin Date: Sun, 20 Oct 2024 22:08:51 +0900 Subject: [PATCH] refactor(dpc/rest-api): reorganaize directory structures --- .../components/schemas/{ => common}/externalResource.yml | 0 docs/rest-api/components/schemas/{ => common}/tag.yml | 0 .../searchUnprocessable.yml} | 0 .../schemas/{requestContent.yml => request/content.yml} | 2 +- .../schemas/{requestSeries.yml => request/series.yml} | 0 .../schemas/{requestToken.yml => request/token.yml} | 0 .../components/schemas/{ => response}/applicationInfo.yml | 0 docs/rest-api/components/schemas/{ => response}/article.yml | 0 docs/rest-api/components/schemas/{ => response}/author.yml | 0 .../schemas/{responseContent.yml => response/content.yml} | 4 ++-- .../components/schemas/{ => response}/contentType.yml | 0 docs/rest-api/components/schemas/{ => response}/feed.yml | 0 docs/rest-api/components/schemas/{ => response}/idToken.yml | 0 .../schemas/{responseSearch.yml => response/search.yml} | 0 docs/rest-api/components/schemas/{ => response}/series.yml | 0 .../components/schemas/{ => response}/simpleArticle.yml | 0 docs/rest-api/components/schemas/{ => response}/sitemap.yml | 0 .../components/schemas/{ => response}/tagWithCount.yml | 0 docs/rest-api/paths/v1/archives.yml | 2 +- docs/rest-api/paths/v1/articles.yml | 2 +- docs/rest-api/paths/v1/author.yml | 2 +- docs/rest-api/paths/v1/authors.yml | 2 +- docs/rest-api/paths/v1/contentTypes.yml | 2 +- docs/rest-api/paths/v1/contents/getByPath.yml | 2 +- docs/rest-api/paths/v1/contents/upsert.yml | 4 ++-- docs/rest-api/paths/v1/feeds.yml | 2 +- docs/rest-api/paths/v1/metadata.yml | 2 +- docs/rest-api/paths/v1/search.yml | 4 ++-- docs/rest-api/paths/v1/series/byName.yml | 2 +- docs/rest-api/paths/v1/series/series.yml | 6 +++--- docs/rest-api/paths/v1/sitemaps.yml | 2 +- docs/rest-api/paths/v1/tags/get.yml | 2 +- docs/rest-api/paths/v1/tags/getByName.yml | 2 +- docs/rest-api/paths/v1/token.yml | 4 ++-- 34 files changed, 24 insertions(+), 24 deletions(-) rename docs/rest-api/components/schemas/{ => common}/externalResource.yml (100%) rename docs/rest-api/components/schemas/{ => common}/tag.yml (100%) rename docs/rest-api/components/schemas/{responseSearchUnprocessable.yml => errors/searchUnprocessable.yml} (100%) rename docs/rest-api/components/schemas/{requestContent.yml => request/content.yml} (96%) rename docs/rest-api/components/schemas/{requestSeries.yml => request/series.yml} (100%) rename docs/rest-api/components/schemas/{requestToken.yml => request/token.yml} (100%) rename docs/rest-api/components/schemas/{ => response}/applicationInfo.yml (100%) rename docs/rest-api/components/schemas/{ => response}/article.yml (100%) rename docs/rest-api/components/schemas/{ => response}/author.yml (100%) rename docs/rest-api/components/schemas/{responseContent.yml => response/content.yml} (94%) rename docs/rest-api/components/schemas/{ => response}/contentType.yml (100%) rename docs/rest-api/components/schemas/{ => response}/feed.yml (100%) rename docs/rest-api/components/schemas/{ => response}/idToken.yml (100%) rename docs/rest-api/components/schemas/{responseSearch.yml => response/search.yml} (100%) rename docs/rest-api/components/schemas/{ => response}/series.yml (100%) rename docs/rest-api/components/schemas/{ => response}/simpleArticle.yml (100%) rename docs/rest-api/components/schemas/{ => response}/sitemap.yml (100%) rename docs/rest-api/components/schemas/{ => response}/tagWithCount.yml (100%) diff --git a/docs/rest-api/components/schemas/externalResource.yml b/docs/rest-api/components/schemas/common/externalResource.yml similarity index 100% rename from docs/rest-api/components/schemas/externalResource.yml rename to docs/rest-api/components/schemas/common/externalResource.yml diff --git a/docs/rest-api/components/schemas/tag.yml b/docs/rest-api/components/schemas/common/tag.yml similarity index 100% rename from docs/rest-api/components/schemas/tag.yml rename to docs/rest-api/components/schemas/common/tag.yml diff --git a/docs/rest-api/components/schemas/responseSearchUnprocessable.yml b/docs/rest-api/components/schemas/errors/searchUnprocessable.yml similarity index 100% rename from docs/rest-api/components/schemas/responseSearchUnprocessable.yml rename to docs/rest-api/components/schemas/errors/searchUnprocessable.yml diff --git a/docs/rest-api/components/schemas/requestContent.yml b/docs/rest-api/components/schemas/request/content.yml similarity index 96% rename from docs/rest-api/components/schemas/requestContent.yml rename to docs/rest-api/components/schemas/request/content.yml index 5d997fd4..b19e3ec3 100644 --- a/docs/rest-api/components/schemas/requestContent.yml +++ b/docs/rest-api/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/docs/rest-api/components/schemas/requestSeries.yml b/docs/rest-api/components/schemas/request/series.yml similarity index 100% rename from docs/rest-api/components/schemas/requestSeries.yml rename to docs/rest-api/components/schemas/request/series.yml diff --git a/docs/rest-api/components/schemas/requestToken.yml b/docs/rest-api/components/schemas/request/token.yml similarity index 100% rename from docs/rest-api/components/schemas/requestToken.yml rename to docs/rest-api/components/schemas/request/token.yml diff --git a/docs/rest-api/components/schemas/applicationInfo.yml b/docs/rest-api/components/schemas/response/applicationInfo.yml similarity index 100% rename from docs/rest-api/components/schemas/applicationInfo.yml rename to docs/rest-api/components/schemas/response/applicationInfo.yml diff --git a/docs/rest-api/components/schemas/article.yml b/docs/rest-api/components/schemas/response/article.yml similarity index 100% rename from docs/rest-api/components/schemas/article.yml rename to docs/rest-api/components/schemas/response/article.yml diff --git a/docs/rest-api/components/schemas/author.yml b/docs/rest-api/components/schemas/response/author.yml similarity index 100% rename from docs/rest-api/components/schemas/author.yml rename to docs/rest-api/components/schemas/response/author.yml diff --git a/docs/rest-api/components/schemas/responseContent.yml b/docs/rest-api/components/schemas/response/content.yml similarity index 94% rename from docs/rest-api/components/schemas/responseContent.yml rename to docs/rest-api/components/schemas/response/content.yml index 32259e97..52c019c3 100644 --- a/docs/rest-api/components/schemas/responseContent.yml +++ b/docs/rest-api/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/docs/rest-api/components/schemas/contentType.yml b/docs/rest-api/components/schemas/response/contentType.yml similarity index 100% rename from docs/rest-api/components/schemas/contentType.yml rename to docs/rest-api/components/schemas/response/contentType.yml diff --git a/docs/rest-api/components/schemas/feed.yml b/docs/rest-api/components/schemas/response/feed.yml similarity index 100% rename from docs/rest-api/components/schemas/feed.yml rename to docs/rest-api/components/schemas/response/feed.yml diff --git a/docs/rest-api/components/schemas/idToken.yml b/docs/rest-api/components/schemas/response/idToken.yml similarity index 100% rename from docs/rest-api/components/schemas/idToken.yml rename to docs/rest-api/components/schemas/response/idToken.yml diff --git a/docs/rest-api/components/schemas/responseSearch.yml b/docs/rest-api/components/schemas/response/search.yml similarity index 100% rename from docs/rest-api/components/schemas/responseSearch.yml rename to docs/rest-api/components/schemas/response/search.yml diff --git a/docs/rest-api/components/schemas/series.yml b/docs/rest-api/components/schemas/response/series.yml similarity index 100% rename from docs/rest-api/components/schemas/series.yml rename to docs/rest-api/components/schemas/response/series.yml diff --git a/docs/rest-api/components/schemas/simpleArticle.yml b/docs/rest-api/components/schemas/response/simpleArticle.yml similarity index 100% rename from docs/rest-api/components/schemas/simpleArticle.yml rename to docs/rest-api/components/schemas/response/simpleArticle.yml diff --git a/docs/rest-api/components/schemas/sitemap.yml b/docs/rest-api/components/schemas/response/sitemap.yml similarity index 100% rename from docs/rest-api/components/schemas/sitemap.yml rename to docs/rest-api/components/schemas/response/sitemap.yml diff --git a/docs/rest-api/components/schemas/tagWithCount.yml b/docs/rest-api/components/schemas/response/tagWithCount.yml similarity index 100% rename from docs/rest-api/components/schemas/tagWithCount.yml rename to docs/rest-api/components/schemas/response/tagWithCount.yml diff --git a/docs/rest-api/paths/v1/archives.yml b/docs/rest-api/paths/v1/archives.yml index ccabcc55..6a6854e0 100644 --- 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 index 68166e7a..a8867ca5 100644 --- 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 index d0f12c8e..0595c52e 100644 --- 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 index 591908f8..8a26ee84 100644 --- 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 index 3d466c1e..50194de5 100644 --- 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 index 1b5a3727..0a03c795 100644 --- 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 index d7332a74..6f875250 100644 --- 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 index 7a78219d..c78987cf 100644 --- 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 index 6631c4ec..59ec97fe 100644 --- 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 index a71081bf..49889d21 100644 --- 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 index 21d3eb01..6f4c9011 100644 --- 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 index ed4c0fd7..77e7e5b5 100644 --- 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 index 36976b24..ca5ae0fa 100644 --- 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 index 575a1f37..a1c191ba 100644 --- 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 index d79a70d6..252a6b7b 100644 --- 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 index 44a5d094..395f509b 100644 --- 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: