Merge branch 'main' into dev

Signed-off-by: ふぁ <yuki@yuki0311.com>

src/openapi/openapi-3.0.yaml

@@ -56,11 +56,13 @@ security:
   - AuthType: []
 tags:
   - name: user
-    description: response User
+    description: Responses containing User objects.
+  - name: users
+    description: Responses containing List[User] objects.
   - name: user-list
-    description: response User list
+    description: Responses containing instruction objects.
   - name: tweet
-    description: response tweet
+    description: Responses containing instruction objects.
   - name: post
     description: post
   - name: v1.1-get

src/openapi/paths/other.yaml

@@ -16,7 +16,6 @@ paths:
               schema:
                 oneOf:
                   - $ref: "#/components/schemas/OtherResponse"
-                  - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
         - "other"
 

src/openapi/paths/user.yaml

@@ -50,7 +50,7 @@ paths:
                   - $ref: "#/components/schemas/UsersResponse"
                   - $ref: "./../schemas/error.yaml#/components/schemas/Errors"
       tags:
-        - "user"
+        - "users"
 
 components:
   schemas:

src/openapi/schemas/typename.yaml

@@ -21,4 +21,5 @@ components:
           TweetUnavailable,
           Tweet,
           User,
+          UserUnavailable,
         ]

src/openapi/schemas/user.yaml

@@ -17,7 +17,17 @@ components:
         - "result"
       properties:
         result:
-          $ref: "#/components/schemas/User"
+          $ref: "#/components/schemas/UserUnion"
+
+    UserUnion:
+      oneOf:
+        - $ref: "#/components/schemas/User"
+        - $ref: "#/components/schemas/UserUnavailable"
+      discriminator:
+        propertyName: __typename
+        mapping": # deprecated
+          User: "#/components/schemas/User"
+          UserUnavailable: "#/components/schemas/UserUnavailable"
 
     User:
       required:
@@ -79,10 +89,10 @@ components:
         - "entities"
         - "fast_followers_count"
         - "favourites_count"
-        - "follow_request_sent"
-        - "followed_by"
+        # 31 # - "follow_request_sent"
+        # 31 #  - "followed_by"
         - "followers_count"
-        - "following"
+        # 31 #  - "following"
         - "friends_count"
         - "has_custom_timelines"
         - "is_translator"
@@ -92,12 +102,12 @@ components:
         - "muting"
         - "name"
         - "normal_followers_count"
-        - "notifications"
+        # 31 #  - "notifications"
         - "pinned_tweet_ids_str"
         - "possibly_sensitive"
         - "profile_image_url_https"
         - "profile_interstitial_type"
-        - "protected"
+        # 31 #  - "protected"
         - "screen_name"
         - "status"
         - "statuses_count"
@@ -211,3 +221,13 @@ components:
         want_retweets:
           type: boolean
           default: false
+
+    UserUnavailable:
+      required:
+        - "__typename"
+        - "reason"
+      properties:
+        __typename:
+          $ref: "./typename.yaml#/components/schemas/TypeName" # UserUnavailable
+        reason:
+          type: string