twitter-openapi-typescript-generated 0.0.6 → 0.0.7

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: [
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        AddParametersOnContent(
-                            split=-1, contentType="application/json"
-                        ),
-                    ]
-                    for key in ["default", "user", "user-list", "tweet"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        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: [
-                        AddSecuritySchemesOnHeader(split=-1),
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        AddParametersOnParameters(
-                            split=-1,
-                            schemaType="string",
-                        ),
-                    ]
-                    for key in ["default", "user", "user-list", "tweet"]
-                }
-                | {
-                    key: [
-                        AddSecuritySchemesOnHeader(split=-1),
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        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: [
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        AddParametersOnParameters(
-                            split=-1,
-                            schemaType="string",
-                        ),
-                    ]
-                    for key in ["default", "user", "user-list", "tweet"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        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: [
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        AddParametersOnParameters(
-                            split=-1,
-                            schemaType="string",
-                        ),
-                    ]
-                    for key in ["default", "user", "user-list", "tweet"]
-                }
-                | {
-                    key: [
-                        SetResponsesHeader(suffix=None),
-                        AddPathQueryIdOnParameters(split=-1),
-                        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),
         }

package/twitter-openapi/tools/hooks.py

@@ -169,24 +169,33 @@ class AddPathQueryIdOnParameters(RequestHookBase):
 
 class AddParametersOnParameters(RequestHookBase):
     schemaType: str | None
+    ignoreKeys: list[str]
 
-    def __init__(self, split: str = 1, schemaType: str | None = None):
+    def __init__(
+        self,
+        split: str = 1,
+        schemaType: str | None = None,
+        ignoreKeys: list[str] | None = None,
+    ):
         super().__init__(split=split)
         self.schemaType = schemaType
+        self.ignoreKeys = ignoreKeys or []
 
     def hook(self, path: str, value: dict):
         path, value = super().hook(path, value)
         data = self.PLACEHOLDER[self.path_name]
+        data = {key: data[key] for key in data.keys() if key not in self.ignoreKeys}
+
         for key in data.keys():
             if self.schemaType == "string":
-                example = json.dumps(data[key])
+                example = data[key] if type(data[key]) is str else json.dumps(data[key])
                 schema = {
                     "type": "string",
                     "default": example,
                     "example": example,
                 }
             elif self.schemaType == "object":
-                example = json.dumps(data[key])
+                example = data[key] if type(data[key]) is str else json.dumps(data[key])
                 schema = {
                     "type": "object",
                     "default": example,
@@ -211,30 +220,34 @@ class AddParametersOnParameters(RequestHookBase):
 class AddParametersOnBody(RequestHookBase):
     schemaType: str | None
     contentType: str | None
+    ignoreKeys: list[str]
 
     def __init__(
         self,
         split: str = 1,
         contentType: str = "application/json",
         schemaType: str | None = None,
+        ignoreKeys: list[str] | None = None,
     ):
         super().__init__(split)
         self.schemaType = schemaType
         self.contentType = contentType
+        self.ignoreKeys = ignoreKeys or []
 
     def hook(self, path: str, value: dict):
         path, value = super().hook(path, value)
         data = self.PLACEHOLDER[self.path_name]
+        data = {key: data[key] for key in data.keys() if key not in self.ignoreKeys}
 
         if self.schemaType == "string":
-            example = json.dumps(data)
+            example = data if type(data) is str else json.dumps(data)
             schema = {
                 "type": "string",
                 "default": example,
                 "example": example,
             }
         elif self.schemaType == "object":
-            example = json.dumps(data)
+            example = data if type(data) is str else json.dumps(data)
             schema = {
                 "type": "object",
                 "default": example,
@@ -264,14 +277,23 @@ class AddParametersOnBody(RequestHookBase):
 
 class AddParametersOnContent(RequestHookBase):
     contentType: str
+    ignoreKeys: list[str]
 
-    def __init__(self, split: str = 1, contentType: str = "application/json"):
+    def __init__(
+        self,
+        split: str = 1,
+        contentType: str = "application/json",
+        ignoreKeys: list[str] | None = None,
+    ):
         super().__init__(split=split)
         self.contentType = contentType
+        self.ignoreKeys = ignoreKeys or []
 
     def hook(self, path: str, value: dict):
         path, value = super().hook(path, value)
         data = self.PLACEHOLDER[self.path_name]
+        data = {key: data[key] for key in data.keys() if key not in self.ignoreKeys}
+
         for key in data.keys():
             value["parameters"].append(
                 {
@@ -281,7 +303,6 @@ class AddParametersOnContent(RequestHookBase):
                     "content": {
                         self.contentType: {
                             "schema": self.placeholder_to_yaml(data[key]),
-                            "required": [i for i in data[key]],
                         }
                     },
                 }

package/twitter-openapi/dist/dart/openapi-3.0.yaml

@@ -1,117 +0,0 @@
-components:
-  schemas: {}
-  securitySchemes:
-    AuthType:
-      description: OAuth2Session if you are logged in
-      in: header
-      name: x-twitter-auth-type
-      type: apiKey
-    CookieAuthToken:
-      description: HttpOnly cookie
-      in: cookie
-      name: auth_token
-      type: apiKey
-    CookieCt0:
-      description: document.cookie.split('; ').find(row => row.startsWith('ct0='));
-      in: cookie
-      name: ct0
-      type: apiKey
-    CsrfToken:
-      description: ''
-      in: header
-      name: x-csrf-token
-      type: apiKey
-    GuestToken:
-      description: document.cookie.split('; ').find(row => row.startsWith('gt='));
-      in: header
-      name: x-guest-token
-      type: apiKey
-info:
-  contact:
-    email: yuki@yuki0311.com
-  description: Twitter OpenAPI(Swagger) specification
-  license:
-    name: GNU Affero General Public License v3.
-    url: https://raw.githubusercontent.com/fa0311/twitter-openapi/main/LICENSE.txt
-  termsOfService: https://github.com/fa0311
-  title: Twitter OpenAPI
-  version: 0.0.1
-openapi: 3.0.3
-paths:
-  /1.1/friends/following/list.json:
-    $ref: ./paths/v1.1-get.yaml#/paths/~11.1~1friends~1following~1list.json
-  /1.1/friendships/create.json:
-    $ref: ./paths/v1.1-post.yaml#/paths/~11.1~1friendships~1create.json
-  /1.1/friendships/destroy.json:
-    $ref: ./paths/v1.1-post.yaml#/paths/~11.1~1friendships~1destroy.json
-  /1.1/search/typeahead.json:
-    $ref: ./paths/v1.1-get.yaml#/paths/~11.1~1search~1typeahead.json
-  /2/search/adaptive.json:
-    $ref: ./paths/v2.0-get.yaml#/paths/~12~1search~1adaptive.json
-  /graphql/{pathQueryId}/Bookmarks:
-    $ref: ./paths/bookmarks.yaml#/paths/~1graphql~1{pathQueryId}~1Bookmarks
-  /graphql/{pathQueryId}/CreateRetweet:
-    $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1CreateRetweet
-  /graphql/{pathQueryId}/CreateTweet:
-    $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1CreateTweet
-  /graphql/{pathQueryId}/DeleteRetweet:
-    $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1DeleteRetweet
-  /graphql/{pathQueryId}/DeleteTweet:
-    $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1DeleteTweet
-  /graphql/{pathQueryId}/FavoriteTweet:
-    $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1FavoriteTweet
-  /graphql/{pathQueryId}/Followers:
-    $ref: ./paths/follow.yaml#/paths/~1graphql~1{pathQueryId}~1Followers
-  /graphql/{pathQueryId}/Following:
-    $ref: ./paths/follow.yaml#/paths/~1graphql~1{pathQueryId}~1Following
-  /graphql/{pathQueryId}/HomeLatestTimeline:
-    $ref: ./paths/timeline.yaml#/paths/~1graphql~1{pathQueryId}~1HomeLatestTimeline
-  /graphql/{pathQueryId}/HomeTimeline:
-    $ref: ./paths/timeline.yaml#/paths/~1graphql~1{pathQueryId}~1HomeTimeline
-  /graphql/{pathQueryId}/Likes:
-    $ref: ./paths/usertweets.yaml#/paths/~1graphql~1{pathQueryId}~1Likes
-  /graphql/{pathQueryId}/ListLatestTweetsTimeline:
-    $ref: ./paths/timeline.yaml#/paths/~1graphql~1{pathQueryId}~1ListLatestTweetsTimeline
-  /graphql/{pathQueryId}/ProfileSpotlightsQuery:
-    $ref: ./paths/profile.yaml#/paths/~1graphql~1{pathQueryId}~1ProfileSpotlightsQuery
-  /graphql/{pathQueryId}/TweetDetail:
-    $ref: ./paths/tweet.yaml#/paths/~1graphql~1{pathQueryId}~1TweetDetail
-  /graphql/{pathQueryId}/UnfavoriteTweet:
-    $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1UnfavoriteTweet
-  /graphql/{pathQueryId}/UserByScreenName:
-    $ref: ./paths/user.yaml#/paths/~1graphql~1{pathQueryId}~1UserByScreenName
-  /graphql/{pathQueryId}/UserMedia:
-    $ref: ./paths/usertweets.yaml#/paths/~1graphql~1{pathQueryId}~1UserMedia
-  /graphql/{pathQueryId}/UserTweets:
-    $ref: ./paths/usertweets.yaml#/paths/~1graphql~1{pathQueryId}~1UserTweets
-  /graphql/{pathQueryId}/UserTweetsAndReplies:
-    $ref: ./paths/usertweets.yaml#/paths/~1graphql~1{pathQueryId}~1UserTweetsAndReplies
-  /other:
-    $ref: ./paths/other.yaml#/paths/~1other
-security:
-- CsrfToken: []
-- CookieCt0: []
-- GuestToken: []
-- CookieAuthToken: []
-- AuthType: []
-servers:
-- url: https://twitter.com/i/api
-tags:
-- description: response User
-  name: user
-- description: response User list
-  name: user-list
-- description: response tweet
-  name: tweet
-- description: post
-  name: post
-- description: legacy APIs get
-  name: v1.1-get
-- description: legacy APIs post
-  name: v1.1-post
-- description: legacy APIs get
-  name: v2.0-get
-- description: legacy APIs post
-  name: v2.0-post
-- description: other
-  name: other

package/twitter-openapi/dist/dart/paths/bookmarks.yaml

@@ -1,141 +0,0 @@
-components:
-  schemas:
-    BookmarksResponse:
-      properties:
-        data:
-          $ref: '#/components/schemas/BookmarksResponseData'
-      required:
-      - data
-    BookmarksResponseData:
-      properties:
-        bookmark_timeline_v2:
-          $ref: '#/components/schemas/BookmarksTimeline'
-      required:
-      - bookmark_timeline_v2
-    BookmarksTimeline:
-      properties:
-        timeline:
-          $ref: ./../schemas/timeline.yaml#/components/schemas/Timeline
-      required:
-      - timeline
-info:
-  title: Twitter OpenAPI
-  version: 0.0.1
-openapi: 3.0.3
-paths:
-  /graphql/{pathQueryId}/Bookmarks:
-    get:
-      description: get bookmarks
-      operationId: getBookmarks
-      parameters:
-      - in: header
-        name: user-agent
-        required: true
-        schema:
-          default: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,
-            like Gecko) Chrome/112.0.0.0 Safari/537.36
-          description: UserAgent, some APIs may be rejected if changed.
-          type: string
-      - in: header
-        name: authorization
-        required: true
-        schema:
-          default: Bearer AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D1Zv7ttfk8LF81IUq16cHjhLTvJu4FA33AGWWjCpTnA
-          description: It is a constant value and does not need to be changed.
-          type: string
-      - in: header
-        name: x-twitter-active-user
-        required: true
-        schema:
-          default: 'yes'
-          description: Unknown what this value means.
-          type: string
-      - in: header
-        name: x-twitter-client-language
-        required: true
-        schema:
-          default: en
-          description: language code.
-          type: string
-      - in: path
-        name: pathQueryId
-        required: true
-        schema:
-          default: tmd4ifV8RHltzn8ymGg1aw
-          example: tmd4ifV8RHltzn8ymGg1aw
-          type: string
-      - in: query
-        name: queryId
-        required: true
-        schema:
-          default: '"tmd4ifV8RHltzn8ymGg1aw"'
-          example: '"tmd4ifV8RHltzn8ymGg1aw"'
-          type: string
-      - in: query
-        name: variables
-        required: true
-        schema:
-          default: '{"count": 20, "includePromotedContent": true}'
-          example: '{"count": 20, "includePromotedContent": true}'
-          type: string
-      - in: query
-        name: features
-        required: true
-        schema:
-          default: '{"graphql_timeline_v2_bookmark_timeline": true, "blue_business_profile_image_shape_enabled":
-            true, "responsive_web_graphql_exclude_directive_enabled": true, "verified_phone_label_enabled":
-            false, "responsive_web_graphql_timeline_navigation_enabled": true, "responsive_web_graphql_skip_user_profile_image_extensions_enabled":
-            false, "tweetypie_unmention_optimization_enabled": true, "vibe_api_enabled":
-            true, "responsive_web_edit_tweet_api_enabled": true, "graphql_is_translatable_rweb_tweet_is_translatable_enabled":
-            true, "view_counts_everywhere_api_enabled": true, "longform_notetweets_consumption_enabled":
-            true, "tweet_awards_web_tipping_enabled": false, "freedom_of_speech_not_reach_fetch_enabled":
-            false, "standardized_nudges_misinfo": true, "tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled":
-            false, "interactive_text_enabled": true, "responsive_web_text_conversations_enabled":
-            false, "longform_notetweets_rich_text_read_enabled": true, "responsive_web_enhance_cards_enabled":
-            false}'
-          example: '{"graphql_timeline_v2_bookmark_timeline": true, "blue_business_profile_image_shape_enabled":
-            true, "responsive_web_graphql_exclude_directive_enabled": true, "verified_phone_label_enabled":
-            false, "responsive_web_graphql_timeline_navigation_enabled": true, "responsive_web_graphql_skip_user_profile_image_extensions_enabled":
-            false, "tweetypie_unmention_optimization_enabled": true, "vibe_api_enabled":
-            true, "responsive_web_edit_tweet_api_enabled": true, "graphql_is_translatable_rweb_tweet_is_translatable_enabled":
-            true, "view_counts_everywhere_api_enabled": true, "longform_notetweets_consumption_enabled":
-            true, "tweet_awards_web_tipping_enabled": false, "freedom_of_speech_not_reach_fetch_enabled":
-            false, "standardized_nudges_misinfo": true, "tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled":
-            false, "interactive_text_enabled": true, "responsive_web_text_conversations_enabled":
-            false, "longform_notetweets_rich_text_read_enabled": true, "responsive_web_enhance_cards_enabled":
-            false}'
-          type: string
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/BookmarksResponse'
-          description: Successful operation
-          headers:
-            x-connection-hash:
-              schema:
-                type: string
-            x-rate-limit-limit:
-              schema:
-                type: integer
-            x-rate-limit-remaining:
-              schema:
-                type: integer
-            x-rate-limit-reset:
-              schema:
-                type: integer
-            x-response-time:
-              schema:
-                type: integer
-            x-tfe-preserve-body:
-              schema:
-                type: boolean
-            x-transaction-id:
-              schema:
-                type: string
-            x-twitter-response-tags:
-              schema:
-                type: string
-      tags:
-      - tweet