twitter-openapi-typescript-generated 0.0.5 → 0.0.7

package/twitter-openapi/src/openapi/paths/follow.yaml

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/Following:
+  /graphql/{pathQueryId}/Following:
     get:
       operationId: getFollowing
       description: get user list of following
@@ -18,7 +18,7 @@ paths:
       tags:
         - "user-list"
 
-  /graphql/{{queryId}}/Followers:
+  /graphql/{pathQueryId}/Followers:
     get:
       operationId: getFollowers
       description: get user list of followers

package/twitter-openapi/src/openapi/paths/post.yaml

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/FavoriteTweet:
+  /graphql/{pathQueryId}/FavoriteTweet:
     post:
       operationId: postFavoriteTweet
       description: favorite Tweet
@@ -18,7 +18,7 @@ paths:
       tags:
         - "post"
 
-  /graphql/{{queryId}}/UnfavoriteTweet:
+  /graphql/{pathQueryId}/UnfavoriteTweet:
     post:
       operationId: postUnfavoriteTweet
       description: unfavorite Tweet
@@ -32,7 +32,7 @@ paths:
       tags:
         - "post"
 
-  /graphql/{{queryId}}/CreateRetweet:
+  /graphql/{pathQueryId}/CreateRetweet:
     post:
       operationId: postCreateRetweet
       description: create Retweet
@@ -46,7 +46,7 @@ paths:
       tags:
         - "post"
 
-  /graphql/{{queryId}}/DeleteRetweet:
+  /graphql/{pathQueryId}/DeleteRetweet:
     post:
       operationId: postDeleteRetweet
       description: delete Retweet
@@ -60,7 +60,7 @@ paths:
       tags:
         - "post"
 
-  /graphql/{{queryId}}/CreateTweet:
+  /graphql/{pathQueryId}/CreateTweet:
     post:
       operationId: postCreateTweet
       description: create Tweet
@@ -74,7 +74,7 @@ paths:
       tags:
         - "post"
 
-  /graphql/{{queryId}}/DeleteTweet:
+  /graphql/{pathQueryId}/DeleteTweet:
     post:
       operationId: postDeleteTweet
       description: delete Retweet

package/twitter-openapi/src/openapi/paths/profile.yaml

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/ProfileSpotlightsQuery:
+  /graphql/{pathQueryId}/ProfileSpotlightsQuery:
     get:
       operationId: getProfileSpotlightsQuery
       description: "get user by screen name"

package/twitter-openapi/src/openapi/paths/timeline.yaml

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/HomeTimeline:
+  /graphql/{pathQueryId}/HomeTimeline:
     get:
       operationId: getHomeTimeline
       description: get tweet list of timeline
@@ -18,7 +18,7 @@ paths:
       tags:
         - "tweet"
 
-  /graphql/{{queryId}}/HomeLatestTimeline:
+  /graphql/{pathQueryId}/HomeLatestTimeline:
     get:
       operationId: getHomeLatestTimeline
       description: get tweet list of timeline
@@ -32,7 +32,7 @@ paths:
       tags:
         - "tweet"
 
-  /graphql/{{queryId}}/ListLatestTweetsTimeline:
+  /graphql/{pathQueryId}/ListLatestTweetsTimeline:
     get:
       operationId: getListLatestTweetsTimeline
       description: get tweet list of timeline

package/twitter-openapi/src/openapi/paths/tweet.yaml

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/TweetDetail:
+  /graphql/{pathQueryId}/TweetDetail:
     get:
       operationId: getTweetDetail
       description: get TweetDetail

package/twitter-openapi/src/openapi/paths/user.yaml

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/UserByScreenName:
+  /graphql/{pathQueryId}/UserByScreenName:
     get:
       operationId: getUserByScreenName
       description: "get user by screen name"

package/twitter-openapi/src/openapi/paths/usertweets.yaml

@@ -4,7 +4,7 @@ info:
   version: 0.0.1
 
 paths:
-  /graphql/{{queryId}}/UserTweets:
+  /graphql/{pathQueryId}/UserTweets:
     get:
       operationId: getUserTweets
       description: "get user tweets"
@@ -18,7 +18,7 @@ paths:
       tags:
         - "tweet"
 
-  /graphql/{{queryId}}/UserTweetsAndReplies:
+  /graphql/{pathQueryId}/UserTweetsAndReplies:
     get:
       operationId: getUserTweetsAndReplies
       description: "get user replies tweets"
@@ -32,7 +32,7 @@ paths:
       tags:
         - "tweet"
 
-  /graphql/{{queryId}}/UserMedia:
+  /graphql/{pathQueryId}/UserMedia:
     get:
       operationId: getUserMedia
       description: "get user media tweets"
@@ -46,7 +46,7 @@ paths:
       tags:
         - "tweet"
 
-  /graphql/{{queryId}}/Likes:
+  /graphql/{pathQueryId}/Likes:
     get:
       operationId: getLikes
       description: "get user likes tweets"

package/twitter-openapi/src/openapi/resources/parameters.yaml

@@ -0,0 +1,15 @@
+openapi: 3.0.3
+info:
+  title: Twitter OpenAPI
+  version: 0.0.1
+
+paths: {}
+
+components:
+  parameters:
+    queryId:
+      name: queryId
+      in: path
+      required: true
+      schema:
+        type: string

package/twitter-openapi/src/openapi/schemas/tweet.yaml

@@ -53,6 +53,45 @@ components:
           pattern: "^[0-9]+$"
         core:
           $ref: "./user.yaml#/components/schemas/UserResultCore"
+        card:
+          type: object
+          properties:
+            rest_id:
+              type: string
+            legacy:
+              type: object
+              required:
+                - "binding_values"
+                - "name"
+                - "url"
+              properties:
+                name:
+                  type: string
+                url:
+                  type: string
+                binding_values:
+                  type: array
+                  items:
+                    type: object
+                    required:
+                      - "key"
+                      - "value"
+                    properties:
+                      key:
+                        type: string
+                      value:
+                        type: object
+                        required:
+                          - "type"
+                        properties:
+                          string_value:
+                            type: string
+                          boolean_value:
+                            type: boolean
+                          scribe_key:
+                            type: string
+                          type:
+                            type: string
         unmention_data:
           type: object # todo
         edit_control:
@@ -161,6 +200,14 @@ components:
         id_str:
           type: string
           pattern: "^[0-9]+$"
+        self_thread:
+          type: object
+          required:
+            - "id_str"
+          properties:
+            id_str:
+              type: string
+              pattern: "^[0-9]+$"
         extended_entities:
           $ref: "#/components/schemas/ExtendedEntities"
 
@@ -200,7 +247,25 @@ components:
     UserMention:
       type: object # todo
     Url:
-      type: object # todo
+      type: object
+      required:
+        - "url"
+        - "indices"
+        - "expanded_url"
+        - "display_url"
+      properties:
+        display_url:
+          type: string
+        expanded_url:
+          type: string
+          format: uri
+        url:
+          type: string
+          format: uri
+        indices:
+          type: array
+          items:
+            type: integer
 
     ExtendedEntities:
       required:

package/twitter-openapi/tools/build_config.py

@@ -5,196 +5,73 @@ class Config:
     OUTPUT_DIR = "dist/{0}"
     INPUT_DIR = "src/openapi"
 
+    def hooks_generator(self, queryParameterJson=True):
+        # https://stackoverflow.com/questions/34820064/defining-an-api-with-swagger-get-call-that-uses-json-in-parameters/45223964
+        if queryParameterJson:
+            getParamHook = AddParametersOnContent(
+                split=-1,
+                contentType="application/json",
+                ignoreKeys=["queryId"],
+            )
+            postParamHook = AddParametersOnParameters(
+                split=-1,
+                schemaType=None,
+            )
+        else:
+            getParamHook = AddParametersOnParameters(
+                split=-1,
+                schemaType="string",
+                ignoreKeys=["queryId"],
+            )
+            postParamHook = AddParametersOnBody(
+                split=-1,
+                schemaType=None,
+                contentType="application/json",
+            )
+
+        return {
+            "openapi": [AddSecuritySchemesOnSecuritySchemes()],
+            "schemas": [],
+            "other": [],
+            "request": {
+                key: [
+                    SetResponsesHeader(suffix=None),
+                    AddPathQueryIdOnParameters(split=-1),
+                    getParamHook,
+                ]
+                for key in ["default", "user", "user-list", "tweet"]
+            }
+            | {
+                key: [
+                    SetResponsesHeader(suffix=None),
+                    AddPathQueryIdOnParameters(split=-1),
+                    postParamHook,
+                ]
+                for key in ["post"]
+            }
+            | {
+                key: [
+                    SetResponsesHeader(suffix="legacy"),
+                    AddParametersOnParameters(split=2, schemaType=None),
+                ]
+                for key in ["v1.1-get", "v2.0-get"]
+            }
+            | {
+                key: [
+                    SetResponsesHeader(suffix="legacy"),
+                    AddParametersOnBody(
+                        split=2,
+                        schemaType=None,
+                        contentType="application/x-www-form-urlencoded",
+                    ),
+                ]
+                for key in ["v1.1-post", "v2.0-post"]
+            }
+            | {"other": []},
+        }
+
     def main(self):
         return {
-            "docs": {
-                "openapi": [AddSecuritySchemesOnSecuritySchemes()],
-                "schemas": [],
-                "other":[],
-                "request": {
-                    key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
-                        SetResponsesHeader(suffix=None),
-                        AddParametersOnContent(
-                            split=-1, contentType="application/json"
-                        ),
-                    ]
-                    for key in ["default", "user", "user-list", "tweet"]
-                }
-                | {
-                    key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
-                        SetResponsesHeader(suffix=None),
-                        AddParametersOnParameters(
-                            split=-1,
-                            schemaType=None,
-                        ),
-                    ]
-                    for key in ["post"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix="legacy"),
-                        AddParametersOnParameters(
-                            split=2,
-                            schemaType=None,
-                        ),
-                    ]
-                    for key in ["v1.1-get", "v2.0-get"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix="legacy"),
-                        AddParametersOnBody(
-                            split=2,
-                            schemaType=None,
-                            contentType="application/x-www-form-urlencoded",
-                        ),
-                    ]
-                    for key in ["v1.1-post", "v2.0-post"]
-                }
-                | {"other": []},
-            },
-            "dart": {
-                "openapi": [],
-                "schemas": [],
-                "other":[],
-                "request": {
-                    key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
-                        AddSecuritySchemesOnHeader(split=-1),
-                        SetResponsesHeader(suffix=None),
-                        AddParametersOnParameters(
-                            split=-1,
-                            schemaType="string",
-                        ),
-                    ]
-                    for key in ["default", "user", "user-list", "tweet"]
-                }
-                | {
-                    key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
-                        AddSecuritySchemesOnHeader(split=-1),
-                        SetResponsesHeader(suffix=None),
-                        AddParametersOnBody(
-                            split=-1,
-                            schemaType=None,
-                            contentType="application/json",
-                        ),
-                    ]
-                    for key in ["post"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix="legacy"),
-                        AddSecuritySchemesOnHeader(split=-1),
-                        AddParametersOnParameters(
-                            split=2,
-                            schemaType=None,
-                        ),
-                    ]
-                    for key in ["v1.1-get", "v2.0-get"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix="legacy"),
-                        AddSecuritySchemesOnHeader(split=-1),
-                        AddParametersOnBody(
-                            split=2,
-                            schemaType=None,
-                            contentType="application/x-www-form-urlencoded",
-                        ),
-                    ]
-                    for key in ["v1.1-post", "v2.0-post"]
-                }
-                | {"other": []},
-            },
-            "typescript": {
-                "openapi": [AddSecuritySchemesOnSecuritySchemes()],
-                "schemas": [],
-                "other":[],
-                "request": {
-                    key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
-                        SetResponsesHeader(suffix=None),
-                        AddParametersOnParameters(
-                            split=-1,
-                            schemaType="string",
-                        ),
-                    ]
-                    for key in ["default", "user", "user-list", "tweet"]
-                }
-                | {
-                    key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
-                        SetResponsesHeader(suffix=None),
-                        AddParametersOnBody(
-                            split=-1,
-                            schemaType=None,
-                            contentType="application/json",
-                        ),
-                    ]
-                    for key in ["post"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix="legacy"),
-                        AddParametersOnParameters(
-                            split=2,
-                            schemaType=None,
-                        ),
-                    ]
-                    for key in ["v1.1-get", "v2.0-get"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix="legacy"),
-                        AddParametersOnBody(
-                            split=2,
-                            schemaType=None,
-                            contentType="application/x-www-form-urlencoded",
-                        ),
-                    ]
-                    for key in ["v1.1-post", "v2.0-post"]
-                }
-                | {"other": []},
-            },
-            "test": {
-                "openapi": [AddSecuritySchemesOnSecuritySchemes()],
-                "schemas": [],
-                "other":[],
-                "request": {
-                    key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
-                        SetResponsesHeader(suffix=None),
-                        AddParametersOnParameters(
-                            split=-1,
-                            schemaType="string",
-                        ),
-                    ]
-                    for key in ["default", "user", "user-list", "tweet"]
-                }
-                | {
-                    key: [
-                        ReplaceQueryIdPlaceholder(split=-1),
-                        SetResponsesHeader(suffix=None),
-                        AddParametersOnParameters(
-                            split=-1,
-                            schemaType="string",
-                        ),
-                    ]
-                    for key in ["post"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix="legacy"),
-                        AddParametersOnParameters(
-                            split=2,
-                            schemaType="object",
-                        ),
-                    ]
-                    for key in ["v1.1-get", "v1.1-post", "v2.0-get", "v2.0-post"]
-                }
-                | {"other": []},
-            },
+            "docs": self.hooks_generator(),
+            "compatible": self.hooks_generator(queryParameterJson=False),
         }