diff --git a/docs/openapi.v2.json b/docs/openapi.v2.json index 68abb9d..5cc1028 100644 --- a/docs/openapi.v2.json +++ b/docs/openapi.v2.json @@ -2,7 +2,7 @@ "openapi" : "3.0.0", "info" : { "description" : "Twitter API v2 available endpoints", - "version" : "2.80", + "version" : "2.81", "title" : "Twitter API v2", "termsOfService" : "https://developer.twitter.com/en/developer-terms/agreement-and-policy.html", "contact" : { @@ -2734,6 +2734,458 @@ "x-twitter-streaming" : true } }, + "/2/tweets/firehose/stream/lang/en" : { + "get" : { + "security" : [ + { + "BearerToken" : [ ] + } + ], + "tags" : [ + "Tweets" + ], + "summary" : "English Language Firehose stream", + "description" : "Streams 100% of English Language public Tweets.", + "operationId" : "getTweetsFirehoseStreamLangEn", + "parameters" : [ + { + "name" : "backfill_minutes", + "in" : "query", + "description" : "The number of minutes of backfill requested.", + "required" : false, + "schema" : { + "type" : "integer", + "minimum" : 0, + "maximum" : 5, + "format" : "int32" + }, + "style" : "form" + }, + { + "name" : "partition", + "in" : "query", + "description" : "The partition number.", + "required" : true, + "schema" : { + "type" : "integer", + "minimum" : 1, + "maximum" : 20, + "format" : "int32" + }, + "style" : "form" + }, + { + "name" : "start_time", + "in" : "query", + "description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Tweets will be provided.", + "required" : false, + "example" : "2021-02-14T18:40:40.000Z", + "schema" : { + "type" : "string", + "format" : "date-time" + }, + "style" : "form" + }, + { + "name" : "end_time", + "in" : "query", + "description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Tweets will be provided.", + "required" : false, + "example" : "2021-02-14T18:40:40.000Z", + "schema" : { + "type" : "string", + "format" : "date-time" + }, + "style" : "form" + }, + { + "$ref" : "#/components/parameters/TweetFieldsParameter" + }, + { + "$ref" : "#/components/parameters/TweetExpansionsParameter" + }, + { + "$ref" : "#/components/parameters/MediaFieldsParameter" + }, + { + "$ref" : "#/components/parameters/PollFieldsParameter" + }, + { + "$ref" : "#/components/parameters/UserFieldsParameter" + }, + { + "$ref" : "#/components/parameters/PlaceFieldsParameter" + } + ], + "responses" : { + "200" : { + "description" : "The request has succeeded.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamingTweetResponse" + } + } + } + }, + "default" : { + "description" : "The request has failed.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + }, + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Problem" + } + } + } + } + }, + "x-twitter-streaming" : true + } + }, + "/2/tweets/firehose/stream/lang/ja" : { + "get" : { + "security" : [ + { + "BearerToken" : [ ] + } + ], + "tags" : [ + "Tweets" + ], + "summary" : "Japanese Language Firehose stream", + "description" : "Streams 100% of Japanese Language public Tweets.", + "operationId" : "getTweetsFirehoseStreamLangJa", + "parameters" : [ + { + "name" : "backfill_minutes", + "in" : "query", + "description" : "The number of minutes of backfill requested.", + "required" : false, + "schema" : { + "type" : "integer", + "minimum" : 0, + "maximum" : 5, + "format" : "int32" + }, + "style" : "form" + }, + { + "name" : "partition", + "in" : "query", + "description" : "The partition number.", + "required" : true, + "schema" : { + "type" : "integer", + "minimum" : 1, + "maximum" : 20, + "format" : "int32" + }, + "style" : "form" + }, + { + "name" : "start_time", + "in" : "query", + "description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Tweets will be provided.", + "required" : false, + "example" : "2021-02-14T18:40:40.000Z", + "schema" : { + "type" : "string", + "format" : "date-time" + }, + "style" : "form" + }, + { + "name" : "end_time", + "in" : "query", + "description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Tweets will be provided.", + "required" : false, + "example" : "2021-02-14T18:40:40.000Z", + "schema" : { + "type" : "string", + "format" : "date-time" + }, + "style" : "form" + }, + { + "$ref" : "#/components/parameters/TweetFieldsParameter" + }, + { + "$ref" : "#/components/parameters/TweetExpansionsParameter" + }, + { + "$ref" : "#/components/parameters/MediaFieldsParameter" + }, + { + "$ref" : "#/components/parameters/PollFieldsParameter" + }, + { + "$ref" : "#/components/parameters/UserFieldsParameter" + }, + { + "$ref" : "#/components/parameters/PlaceFieldsParameter" + } + ], + "responses" : { + "200" : { + "description" : "The request has succeeded.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamingTweetResponse" + } + } + } + }, + "default" : { + "description" : "The request has failed.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + }, + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Problem" + } + } + } + } + }, + "x-twitter-streaming" : true + } + }, + "/2/tweets/firehose/stream/lang/ko" : { + "get" : { + "security" : [ + { + "BearerToken" : [ ] + } + ], + "tags" : [ + "Tweets" + ], + "summary" : "Korean Language Firehose stream", + "description" : "Streams 100% of Korean Language public Tweets.", + "operationId" : "getTweetsFirehoseStreamLangKo", + "parameters" : [ + { + "name" : "backfill_minutes", + "in" : "query", + "description" : "The number of minutes of backfill requested.", + "required" : false, + "schema" : { + "type" : "integer", + "minimum" : 0, + "maximum" : 5, + "format" : "int32" + }, + "style" : "form" + }, + { + "name" : "partition", + "in" : "query", + "description" : "The partition number.", + "required" : true, + "schema" : { + "type" : "integer", + "minimum" : 1, + "maximum" : 20, + "format" : "int32" + }, + "style" : "form" + }, + { + "name" : "start_time", + "in" : "query", + "description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Tweets will be provided.", + "required" : false, + "example" : "2021-02-14T18:40:40.000Z", + "schema" : { + "type" : "string", + "format" : "date-time" + }, + "style" : "form" + }, + { + "name" : "end_time", + "in" : "query", + "description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Tweets will be provided.", + "required" : false, + "example" : "2021-02-14T18:40:40.000Z", + "schema" : { + "type" : "string", + "format" : "date-time" + }, + "style" : "form" + }, + { + "$ref" : "#/components/parameters/TweetFieldsParameter" + }, + { + "$ref" : "#/components/parameters/TweetExpansionsParameter" + }, + { + "$ref" : "#/components/parameters/MediaFieldsParameter" + }, + { + "$ref" : "#/components/parameters/PollFieldsParameter" + }, + { + "$ref" : "#/components/parameters/UserFieldsParameter" + }, + { + "$ref" : "#/components/parameters/PlaceFieldsParameter" + } + ], + "responses" : { + "200" : { + "description" : "The request has succeeded.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamingTweetResponse" + } + } + } + }, + "default" : { + "description" : "The request has failed.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + }, + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Problem" + } + } + } + } + }, + "x-twitter-streaming" : true + } + }, + "/2/tweets/firehose/stream/lang/pt" : { + "get" : { + "security" : [ + { + "BearerToken" : [ ] + } + ], + "tags" : [ + "Tweets" + ], + "summary" : "Portuguese Language Firehose stream", + "description" : "Streams 100% of Portuguese Language public Tweets.", + "operationId" : "getTweetsFirehoseStreamLangPt", + "parameters" : [ + { + "name" : "backfill_minutes", + "in" : "query", + "description" : "The number of minutes of backfill requested.", + "required" : false, + "schema" : { + "type" : "integer", + "minimum" : 0, + "maximum" : 5, + "format" : "int32" + }, + "style" : "form" + }, + { + "name" : "partition", + "in" : "query", + "description" : "The partition number.", + "required" : true, + "schema" : { + "type" : "integer", + "minimum" : 1, + "maximum" : 20, + "format" : "int32" + }, + "style" : "form" + }, + { + "name" : "start_time", + "in" : "query", + "description" : "YYYY-MM-DDTHH:mm:ssZ. The earliest UTC timestamp to which the Tweets will be provided.", + "required" : false, + "example" : "2021-02-14T18:40:40.000Z", + "schema" : { + "type" : "string", + "format" : "date-time" + }, + "style" : "form" + }, + { + "name" : "end_time", + "in" : "query", + "description" : "YYYY-MM-DDTHH:mm:ssZ. The latest UTC timestamp to which the Tweets will be provided.", + "required" : false, + "example" : "2021-02-14T18:40:40.000Z", + "schema" : { + "type" : "string", + "format" : "date-time" + }, + "style" : "form" + }, + { + "$ref" : "#/components/parameters/TweetFieldsParameter" + }, + { + "$ref" : "#/components/parameters/TweetExpansionsParameter" + }, + { + "$ref" : "#/components/parameters/MediaFieldsParameter" + }, + { + "$ref" : "#/components/parameters/PollFieldsParameter" + }, + { + "$ref" : "#/components/parameters/UserFieldsParameter" + }, + { + "$ref" : "#/components/parameters/PlaceFieldsParameter" + } + ], + "responses" : { + "200" : { + "description" : "The request has succeeded.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamingTweetResponse" + } + } + } + }, + "default" : { + "description" : "The request has failed.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Error" + } + }, + "application/problem+json" : { + "schema" : { + "$ref" : "#/components/schemas/Problem" + } + } + } + } + }, + "x-twitter-streaming" : true + } + }, "/2/tweets/label/stream" : { "get" : { "security" : [ @@ -9025,6 +9477,78 @@ } } }, + "Get2TweetsFirehoseStreamLangEnResponse" : { + "type" : "object", + "properties" : { + "data" : { + "$ref" : "#/components/schemas/Tweet" + }, + "errors" : { + "type" : "array", + "minItems" : 1, + "items" : { + "$ref" : "#/components/schemas/Problem" + } + }, + "includes" : { + "$ref" : "#/components/schemas/Expansions" + } + } + }, + "Get2TweetsFirehoseStreamLangJaResponse" : { + "type" : "object", + "properties" : { + "data" : { + "$ref" : "#/components/schemas/Tweet" + }, + "errors" : { + "type" : "array", + "minItems" : 1, + "items" : { + "$ref" : "#/components/schemas/Problem" + } + }, + "includes" : { + "$ref" : "#/components/schemas/Expansions" + } + } + }, + "Get2TweetsFirehoseStreamLangKoResponse" : { + "type" : "object", + "properties" : { + "data" : { + "$ref" : "#/components/schemas/Tweet" + }, + "errors" : { + "type" : "array", + "minItems" : 1, + "items" : { + "$ref" : "#/components/schemas/Problem" + } + }, + "includes" : { + "$ref" : "#/components/schemas/Expansions" + } + } + }, + "Get2TweetsFirehoseStreamLangPtResponse" : { + "type" : "object", + "properties" : { + "data" : { + "$ref" : "#/components/schemas/Tweet" + }, + "errors" : { + "type" : "array", + "minItems" : 1, + "items" : { + "$ref" : "#/components/schemas/Problem" + } + }, + "includes" : { + "$ref" : "#/components/schemas/Expansions" + } + } + }, "Get2TweetsFirehoseStreamResponse" : { "type" : "object", "properties" : {