Skip to content

fix(backend): correct response schema of chat endpoints #15904

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 28, 2025

Conversation

zyoshoka
Copy link
Member

What

チャット関連の API エンドポイントで 204 を返すものが、OpenAPI ドキュメントでは 200 を返すものと書かれてしまっている問題を修正します。

Why

API ドキュメント改善

Additional info (optional)

Checklist

  • Read the contribution guide
  • Test working in a local environment
  • (If needed) Add story of storybook
  • (If needed) Update CHANGELOG.md
  • (If possible) Add tests

@github-actions github-actions bot added packages/backend Server side specific issue/PR packages/misskey-js labels Apr 28, 2025
@syuilo syuilo merged commit aaa31c9 into misskey-dev:develop Apr 28, 2025
31 checks passed
@syuilo
Copy link
Member

syuilo commented Apr 28, 2025

🙏

@github-project-automation github-project-automation bot moved this from Todo to Done in [実験中] 管理用 Apr 28, 2025
Copy link

codecov bot commented Apr 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 44.44%. Comparing base (c3b9a53) to head (480d546).
Report is 1 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #15904      +/-   ##
===========================================
+ Coverage    42.45%   44.44%   +1.98%     
===========================================
  Files         1695     1699       +4     
  Lines       172023   178232    +6209     
  Branches      4229     4265      +36     
===========================================
+ Hits         73040    79218    +6178     
+ Misses       98522    98520       -2     
- Partials       461      494      +33     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@zyoshoka zyoshoka deleted the fix-chat-endpoint-schema branch April 28, 2025 09:59
Copy link
Contributor

このPRによるapi.jsonの差分

差分はこちら
--- base
+++ head
@@ -32067,13 +32067,8 @@
           }
         },
         "responses": {
-          "200": {
-            "description": "OK (with results)",
-            "content": {
-              "application/json": {
-                "schema": {}
-              }
-            }
+          "204": {
+            "description": "OK (without any results)"
           },
           "400": {
             "description": "Client error",
@@ -32233,13 +32228,8 @@
           }
         },
         "responses": {
-          "200": {
-            "description": "OK (with results)",
-            "content": {
-              "application/json": {
-                "schema": {}
-              }
-            }
+          "204": {
+            "description": "OK (without any results)"
           },
           "400": {
             "description": "Client error",
@@ -32935,13 +32925,8 @@
           }
         },
         "responses": {
-          "200": {
-            "description": "OK (with results)",
-            "content": {
-              "application/json": {
-                "schema": {}
-              }
-            }
+          "204": {
+            "description": "OK (without any results)"
           },
           "400": {
             "description": "Client error",
@@ -33460,13 +33445,8 @@
           }
         },
         "responses": {
-          "200": {
-            "description": "OK (with results)",
-            "content": {
-              "application/json": {
-                "schema": {}
-              }
-            }
+          "204": {
+            "description": "OK (without any results)"
           },
           "400": {
             "description": "Client error",
@@ -33813,13 +33793,8 @@
           }
         },
         "responses": {
-          "200": {
-            "description": "OK (with results)",
-            "content": {
-              "application/json": {
-                "schema": {}
-              }
-            }
+          "204": {
+            "description": "OK (without any results)"
           },
           "400": {
             "description": "Client error",
@@ -34323,13 +34298,8 @@
           }
         },
         "responses": {
-          "200": {
-            "description": "OK (with results)",
-            "content": {
-              "application/json": {
-                "schema": {}
-              }
-            }
+          "204": {
+            "description": "OK (without any results)"
           },
           "400": {
             "description": "Client error",
@@ -34651,13 +34621,8 @@
           }
         },
         "responses": {
-          "200": {
-            "description": "OK (with results)",
-            "content": {
-              "application/json": {
-                "schema": {}
-              }
-            }
+          "204": {
+            "description": "OK (without any results)"
           },
           "400": {
             "description": "Client error",
@@ -34999,13 +34964,8 @@
           }
         },
         "responses": {
-          "200": {
-            "description": "OK (with results)",
-            "content": {
-              "application/json": {
-                "schema": {}
-              }
-            }
+          "204": {
+            "description": "OK (without any results)"
           },
           "400": {
             "description": "Client error",

Get diff files from Workflow Page

ruruke pushed a commit to ruruke/rukey that referenced this pull request May 1, 2025
DA-TENSHI pushed a commit to SHINANOSKEY-Projekt/misskey that referenced this pull request May 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
packages/backend Server side specific issue/PR packages/misskey-js
Projects
Development

Successfully merging this pull request may close these issues.

2 participants