twitter-openapi-typescript-generated 0.0.8 → 0.0.10

package/twitter-openapi/.github/workflows/test-build.yaml

@@ -0,0 +1,87 @@
+name: build-test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      # Openapi Generator Setup
+      - name: Get OpenJDK 11
+        uses: actions/setup-java@v2
+        with:
+          distribution: "temurin"
+          java-version: 11
+
+      - name: Get Java version
+        run: java -version
+
+      - name: Get Openapi Generator cache file
+        id: openapi-generator-cache
+        run: echo "file=openapi-generator-cli.jar" >> $GITHUB_OUTPUT
+
+      - name: Openapi Generator cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.openapi-generator-cache.outputs.file }}
+          key: ${{ runner.os }}-openapi-generator-${{ hashFiles('openapi-generator-cli.jar') }}
+          restore-keys: |
+            ${{ runner.os }}-openapi-generator-
+
+      - name: Get Openapi Generator
+        run: |
+          wget https://github.com/fa0311/openapi-generator/releases/download/twitter_openapi_python_1.3.0/openapi-generator-cli.jar -O openapi-generator-cli.jar --no-verbose
+        if: steps.openapi-generator-cache.outputs.cache-hit != 'true'
+
+      # Python Setup
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          architecture: "x64"
+
+      - name: Get Python version
+        run: python -V
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+
+      - name: pip cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      # generate
+      - name: Build twitter-openapi
+        run: |
+          python tools/build.py
+
+      # clean up dependencies
+      - name: Clean up dependencies
+        run: |
+          pip uninstall -y -r requirements.txt
+
+      # generate
+      - name: Generate
+        run: |
+          java -jar openapi-generator-cli.jar generate -c test/python/openapi-generator-config.yaml -g python
+          java -jar openapi-generator-cli.jar generate -c test/dart-dio/openapi-generator-config.yaml -g dart-dio
+          java -jar openapi-generator-cli.jar generate -c test/typescript-fetch/openapi-generator-config.yaml -g typescript-fetch

package/twitter-openapi/.github/workflows/test-python.yaml

@@ -0,0 +1,100 @@
+name: test-python
+
+on:
+  pull_request_target:
+    types: [labeled]
+  workflow_dispatch:
+
+jobs:
+  build_and_preview:
+    runs-on: ubuntu-latest
+    name: Test
+    if: contains(github.event.pull_request.labels.*.name, 'safe to test')
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          ref: "${{ github.event.pull_request.merge_commit_sha }}"
+
+      # Openapi Generator Setup
+      - name: Get OpenJDK 11
+        uses: actions/setup-java@v2
+        with:
+          distribution: "temurin"
+          java-version: 11
+
+      - name: Get Java version
+        run: java -version
+
+      - name: Get Openapi Generator cache file
+        id: openapi-generator-cache
+        run: echo "file=openapi-generator-cli.jar" >> $GITHUB_OUTPUT
+
+      - name: Openapi Generator cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.openapi-generator-cache.outputs.file }}
+          key: ${{ runner.os }}-openapi-generator-${{ hashFiles('openapi-generator-cli.jar') }}
+          restore-keys: |
+            ${{ runner.os }}-openapi-generator-
+
+      - name: Get Openapi Generator
+        run: |
+          wget https://github.com/fa0311/openapi-generator/releases/download/twitter_openapi_python_1.3.0/openapi-generator-cli.jar -O openapi-generator-cli.jar --no-verbose
+        if: steps.openapi-generator-cache.outputs.cache-hit != 'true'
+
+      # Python Setup
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          architecture: "x64"
+
+      - name: Get Python version
+        run: python -V
+
+      - name: Get pip cache dir
+        id: pip-cache
+        run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT
+
+      - name: pip cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.pip-cache.outputs.dir }}
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      # generate
+      - name: Build twitter-openapi
+        run: |
+          python tools/build.py
+
+      # clean up dependencies
+      - name: Clean up dependencies
+        run: |
+          pip uninstall -y -r requirements.txt
+
+      # generate
+      - name: Generate Python client
+        run: |
+          java -jar openapi-generator-cli.jar generate -c test/python/openapi-generator-config.yaml -g python
+
+      # test
+      - name: Test Python client
+        run: |
+          pip install ./python_generated
+
+      - name: Run Python client test
+        run: |
+          python test/python/test_serialize.py
+        env:
+          TWITTER_SESSION: ${{ secrets.TWITTER_SESSION }}
+          ERROR_UNCATCHED: "False"
+          SLEEP_TIME: 2
+          CUESOR_TEST_COUNT: 5

package/twitter-openapi/.vscode/launch.json

@@ -0,0 +1,25 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "build",
+      "type": "python",
+      "request": "launch",
+      "program": "tools/build.py",
+      "console": "integratedTerminal",
+      "justMyCode": true
+    },
+    {
+      "name": "test",
+      "type": "python",
+      "request": "launch",
+      "program": "test/python/test_serialize.py",
+      "console": "integratedTerminal",
+      "justMyCode": false,
+      "preLaunchTask": "build-task",
+      "env": {
+        "ERROR_UNCATCHED": "True"
+      }
+    }
+  ]
+}

package/twitter-openapi/.vscode/settings.json

@@ -4,6 +4,6 @@
   "yaml.validate": true,
   "yaml.hover": true,
   "yaml.schemas": {
-    "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json": "twitter-openapi/**/*.yaml"
+    "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json": "src/**/*.yaml"
   }
 }

package/twitter-openapi/.vscode/tasks.json

@@ -0,0 +1,45 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "build-task",
+      "type": "shell",
+      "linux": {
+        "command": [
+          "python3 tools/build.py;",
+          "java -jar openapi-generator-cli.jar generate -c test/python/openapi-generator-config.yaml -g python;",
+          "python3 -m pip install ./python_generated;"
+        ]
+      },
+      "windows": {
+        "command": [
+          ".venv/Scripts/activate;",
+          "python tools/build.py;",
+          "java -jar openapi-generator-cli.jar generate -c test/python/openapi-generator-config.yaml -g python;",
+          "python -m pip install ./python_generated;"
+        ]
+      }
+    },
+    {
+      "label": "init-venv",
+      "type": "shell",
+      "runOptions": {
+        "runOn": "folderOpen"
+      },
+      "linux": {
+        "command": [
+          "python3 -m venv .venv;",
+          ".venv/bin/python3 -m pip install -r requirements.txt;",
+          "wget https://github.com/fa0311/openapi-generator/releases/download/twitter_openapi_python_1.3.0/openapi-generator-cli.jar -O openapi-generator-cli.jar;"
+        ]
+      },
+      "windows": {
+        "command": [
+          "python -m venv .venv;",
+          ".venv/Scripts/python -m pip install -r requirements.txt;",
+          "Invoke-WebRequest https://github.com/fa0311/openapi-generator/releases/download/twitter_openapi_python_1.3.0/openapi-generator-cli.jar -OutFile openapi-generator-cli.jar;"
+        ]
+      }
+    }
+  ]
+}

package/twitter-openapi/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# CONTRIBUTING
+
+- `src` *.yaml files should be written according to the [v3.0/schema.json](https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json)
+- `dist` Do not rewrite this file as it is an automatically generated OpenAPI file.
+- `dist` Do not include this in the pull request due to potential conflicts.
+
+Users using vscode can build and test with the GUI.
+[.vscode/launch.json](.vscode/launch.json) is a configuration file for vscode.
+
+## Good first issues
+
+- Add a new endpoint
+- Add type to `type: object # todo`

package/twitter-openapi/README.md

@@ -2,6 +2,7 @@
 
 Twitter OpenAPI(Swagger) specification
 
+- [Python](https://github.com/fa0311/twitter_openapi_python)
 - [Dart](https://github.com/fa0311/twitter_openapi_dart)
 - [TypeScript](https://github.com/fa0311/twitter-openapi-typescript)
 - [React Documents](https://github.com/fa0311/twitter-openapi-docs)
@@ -20,8 +21,7 @@ Note that the license also inherits to the output.
 
 ## Contribute
 
-- `src` *.yaml files should be written according to the [v3.0/schema.json](https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json)
-- `dist` Do not rewrite this file as it is an automatically generated OpenAPI file.
+[CONTRIBUTING.md](./CONTRIBUTING.md)
 
 ### build
 

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

@@ -104,12 +104,16 @@ paths:
     $ref: ./paths/timeline.yaml#/paths/~1graphql~1{pathQueryId}~1SearchTimeline
   /graphql/{pathQueryId}/TweetDetail:
     $ref: ./paths/tweet.yaml#/paths/~1graphql~1{pathQueryId}~1TweetDetail
+  /graphql/{pathQueryId}/TweetResultByRestId:
+    $ref: ./paths/tweet.yaml#/paths/~1graphql~1{pathQueryId}~1TweetResultByRestId
   /graphql/{pathQueryId}/UnfavoriteTweet:
     $ref: ./paths/post.yaml#/paths/~1graphql~1{pathQueryId}~1UnfavoriteTweet
   /graphql/{pathQueryId}/UserByRestId:
     $ref: ./paths/user.yaml#/paths/~1graphql~1{pathQueryId}~1UserByRestId
   /graphql/{pathQueryId}/UserByScreenName:
     $ref: ./paths/user.yaml#/paths/~1graphql~1{pathQueryId}~1UserByScreenName
+  /graphql/{pathQueryId}/UserHighlightsTweets:
+    $ref: ./paths/usertweets.yaml#/paths/~1graphql~1{pathQueryId}~1UserHighlightsTweets
   /graphql/{pathQueryId}/UserMedia:
     $ref: ./paths/usertweets.yaml#/paths/~1graphql~1{pathQueryId}~1UserMedia
   /graphql/{pathQueryId}/UserTweets:
@@ -133,11 +137,13 @@ security:
 servers:
 - url: https://twitter.com/i/api
 tags:
-- description: response User
+- description: Responses containing User objects.
   name: user
-- description: response User list
+- description: Responses containing List[User] objects.
+  name: users
+- description: Responses containing instruction objects.
   name: user-list
-- description: response tweet
+- description: Responses containing instruction objects.
   name: tweet
 - description: post
   name: post

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

@@ -74,7 +74,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/BookmarksResponse'
+                oneOf:
+                - $ref: '#/components/schemas/BookmarksResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:

package/twitter-openapi/dist/compatible/paths/follow.yaml

@@ -91,7 +91,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FollowResponse'
+                oneOf:
+                - $ref: '#/components/schemas/FollowResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -182,7 +184,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FollowResponse'
+                oneOf:
+                - $ref: '#/components/schemas/FollowResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -264,7 +268,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FollowResponse'
+                oneOf:
+                - $ref: '#/components/schemas/FollowResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:

package/twitter-openapi/dist/compatible/paths/other.yaml

@@ -90,7 +90,8 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/OtherResponse'
+                oneOf:
+                - $ref: '#/components/schemas/OtherResponse'
           description: Successful operation
       tags:
       - other

package/twitter-openapi/dist/compatible/paths/post.yaml

@@ -181,7 +181,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CreateRetweetResponse'
+                oneOf:
+                - $ref: '#/components/schemas/CreateRetweetResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -375,7 +377,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CreateTweetResponse'
+                oneOf:
+                - $ref: '#/components/schemas/CreateTweetResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -449,7 +453,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/DeleteRetweetResponse'
+                oneOf:
+                - $ref: '#/components/schemas/DeleteRetweetResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -523,7 +529,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/DeleteTweetResponse'
+                oneOf:
+                - $ref: '#/components/schemas/DeleteTweetResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -597,7 +605,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FavoriteTweetResponseData'
+                oneOf:
+                - $ref: '#/components/schemas/FavoriteTweetResponseData'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -671,7 +681,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/UnfavoriteTweetResponseData'
+                oneOf:
+                - $ref: '#/components/schemas/UnfavoriteTweetResponseData'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:

package/twitter-openapi/dist/compatible/paths/profile.yaml

@@ -15,7 +15,7 @@ components:
     UserResultByScreenName:
       properties:
         id:
-          pattern: ^[0-9a-zA-Z]+$
+          pattern: ^([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
           type: string
         result:
           $ref: '#/components/schemas/UserResultByScreenNameResult'
@@ -48,6 +48,7 @@ components:
         legacy:
           $ref: '#/components/schemas/UserResultByScreenNameLegacy'
         profilemodules:
+          additionalProperties: true
           type: object
         rest_id:
           pattern: ^[0-9]+$
@@ -94,7 +95,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ProfileResponse'
+                oneOf:
+                - $ref: '#/components/schemas/ProfileResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:

package/twitter-openapi/dist/compatible/paths/timeline.yaml

@@ -124,7 +124,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/TimelineResponse'
+                oneOf:
+                - $ref: '#/components/schemas/TimelineResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -206,7 +208,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/TimelineResponse'
+                oneOf:
+                - $ref: '#/components/schemas/TimelineResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -286,7 +290,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ListLatestTweetsTimelineResponse'
+                oneOf:
+                - $ref: '#/components/schemas/ListLatestTweetsTimelineResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash:
@@ -377,7 +383,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/SearchTimelineResponse'
+                oneOf:
+                - $ref: '#/components/schemas/SearchTimelineResponse'
+                - $ref: ./../schemas/error.yaml#/components/schemas/Errors
           description: Successful operation
           headers:
             x-connection-hash: