openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 14.8 kB

JSON

{"openapi":"3.0.0","servers":[{"description":"Production","url":"https://api.ebay.com{basePath}","variables":{"basePath":{"default":"/developer/analytics/v1_beta"}}}],"info":{"contact":{"name":"eBay Inc.","x-twitter":"ebay"},"description":"The Analytics API retrieves call-limit data and the quotas that are set for the RESTful APIs and the legacy Trading API. Responses from calls made to getRateLimits and getUerRateLimits include a list of the applicable resources and the \"call limit\", or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the \"time window\" to which the quota applies. The getRateLimits and getUserRateLimits methods retrieve call-limit information for either an application or user, respectively, and each method must be called with an appropriate OAuth token. That is, getRateLimites requires an access token generated with a client credentials grant and getUserRateLimites requires an access token generated with an authorization code grant. For more information, see <a href=\"/api-docs/static/oauth-tokens.html\">OAuth tokens</a>. Users can analyze the response data to see whether or not a limit might be reached, and from that determine if any action needs to be taken (such as programmatically throttling their request rate). For more on call limits, see <a href=\"https://developer.ebay.com/support/app-check \" target=\"_blank\">Compatible Application Check</a>.","license":{"name":"eBay API License Agreement","url":"https://go.developer.ebay.com/api-license-agreement"},"title":"Analytics API","version":"v1_beta.0.0","x-apisguru-categories":["ecommerce"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://twitter.com/ebay/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://developer.ebay.com/api-docs/master/developer/analytics/openapi/3/developer_analytics_v1_beta_oas3.json","version":"3.0"}],"x-providerName":"ebay.com","x-serviceName":"developer-analytics"},"paths":{"/rate_limit/":{"get":{"description":"This method retrieves the call limit and utilization data for an application. The data is retrieved for all RESTful APIs and the legacy Trading API. The response from getRateLimits includes a list of the applicable resources and the \"call limit\", or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the \"time window\" to which the quota applies. By default, this method returns utilization data for all RESTful API and the legacy Trading API resources. Use the api_name and api_context query parameters to filter the response to only the desired APIs. For more on call limits, see <a href=\"https://developer.ebay.com/support/app-check \" target=\"_blank\">Compatible Application Check</a>.","operationId":"getRateLimits","parameters":[{"description":"This optional query parameter filters the result to include only the specified API context. Valid values: <ul><li><code>buy</code></li><li><code>sell</code></li> <li><code>commerce</code></li><li><code>developer</code></li><li><code>tradingapi</code></li></ul>","in":"query","name":"api_context","required":false,"schema":{"type":"string"}},{"description":"This optional query parameter filters the result to include only the APIs specified. Example values: <ul> <li><code>browse</code> for the <a href=\"/../develop/apis/restful-apis/buy-apis#buy-apis\" target=\"_blank\">Buy APIs</a></li> <li><code>inventory</code> for the <a href=\"/../develop/apis/restful-apis/sell-apis#sell-apis\" target=\"_blank\">Sell APIs</a></li> <li><code>taxonomy</code> for the <a href=\"/../develop/apis/restful-apis/commerce-apis#commerce-apis\" target=\"_blank\">Commerce APIs</a></li> <li><code>tradingapi</code> for the <a href=\"/../Devzone/XML/docs/Reference/eBay/index.html\" target=\"_blank\">Trading APIs</a></li></ul>","in":"query","name":"api_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitsResponse"}}},"description":"OK"},"204":{"description":"No Content"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"105000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_ANALYTICS"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope"]}],"tags":["rate_limit"]}},"/user_rate_limit/":{"get":{"description":"This method retrieves the call limit and utilization data for an application user. The call-limit data is returned for all RESTful APIs and the legacy Trading API that limit calls on a per-user basis. The response from getUserRateLimits includes a list of the applicable resources and the \"call limit\", or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the \"time window\" to which the quota applies. By default, this method returns utilization data for all RESTful APIs resources and the legacy Trading API calls that limit request access by user. Use the api_name and api_context query parameters to filter the response to only the desired APIs. For more on call limits, see <a href=\"https://developer.ebay.com/support/app-check \" target=\"_blank\">Compatible Application Check</a>.","operationId":"getUserRateLimits","parameters":[{"description":"This optional query parameter filters the result to include only the specified API context. Valid values: <ul><li><code>buy</code></li> <li><code>sell</code></li> <li><code>commerce</code></li> <li><code>developer</code></li> <li><code>tradingapi</code></li></ul>","in":"query","name":"api_context","required":false,"schema":{"type":"string"}},{"description":"This optional query parameter filters the result to include only the APIs specified. Example values: <ul><li><code>browse</code> for the <a href=\"/../develop/apis/restful-apis/buy-apis#buy-apis\" target=\"_blank\">Buy APIs</a></li> <li><code>inventory</code> for the <a href=\"/../develop/apis/restful-apis/sell-apis#sell-apis\" target=\"_blank\">Sell APIs</a></li> <li><code>taxonomy</code> for the <a href=\"/../develop/apis/restful-apis/commerce-apis#commerce-apis\" target=\"_blank\">Commerce APIs</a></li> <li><code>tradingapi</code> for the <a href=\"/../Devzone/XML/docs/Reference/eBay/index.html\" target=\"_blank\">Trading APIs</a></li></ul>","in":"query","name":"api_name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitsResponse"}}},"description":"OK"},"204":{"description":"No Content"},"500":{"description":"Internal Server Error","x-response-codes":{"errors":{"105000":{"category":"APPLICATION","description":"There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.","domain":"API_ANALYTICS"}}}}},"security":[{"api_auth":["https://api.ebay.com/oauth/api_scope/sell.inventory","https://api.ebay.com/oauth/api_scope/sell.inventory.readonly","https://api.ebay.com/oauth/api_scope/sell.marketplace.insights.readonly","https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly","https://api.ebay.com/oauth/api_scope/sell.marketing","https://api.ebay.com/oauth/api_scope/sell.marketing.readonly"]}],"tags":["user_rate_limit"]}}},"components":{"schemas":{"Error":{"description":"This type defines the fields that can be returned in an error.","properties":{"category":{"description":"Identifies the type of erro.","type":"string"},"domain":{"description":"Name for the primary system where the error occurred. This is relevant for application errors.","type":"string"},"errorId":{"description":"A unique number to identify the error.","format":"int32","type":"integer"},"inputRefIds":{"description":"An array of request elements most closely associated to the error.","items":{"type":"string"},"type":"array"},"longMessage":{"description":"A more detailed explanation of the error.","type":"string"},"message":{"description":"Information on how to correct the problem, in the end user's terms and language where applicable.","type":"string"},"outputRefIds":{"description":"An array of request elements most closely associated to the error.","items":{"type":"string"},"type":"array"},"parameters":{"description":"An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.","items":{"$ref":"#/components/schemas/ErrorParameter"},"type":"array"},"subdomain":{"description":"Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.","type":"string"}},"type":"object"},"ErrorParameter":{"properties":{"name":{"description":"The object of the error.","type":"string"},"value":{"description":"The value of the object.","type":"string"}},"type":"object"},"Rate":{"description":"This complex type defines a \"rate\" as the quota of calls that can be made to a resource per time window, the remaining number of calls before the threshold is met, the amount of time until the time window resets, and the length of the time window (in seconds).","properties":{"limit":{"description":"The maximum number of requests that can be made to this resource during a set time period. The length of time to which the limit is applied is defined by the associated timeWindow value. This value is often referred to as the \"call quota\" for the resource.","format":"int32","type":"integer"},"remaining":{"description":"The remaining number of requests that can be made to this resource before the associated time window resets.","format":"int32","type":"integer"},"reset":{"description":"The data and time the time window and accumulated calls for this resource reset. When the reset time is reached, the remaining value is reset to the value of limit, and this reset value is reset to the current time plus the number of seconds defined by the timeWindow value. The time stamp is formatted as an <a href=\"http://www.iso.org/iso/home/standards/iso8601.htm \" target=\"_blank\">ISO 8601</a> string, which is based on the 24-hour Universal Coordinated Time (UTC) clock. Format: <code>[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z</code> Example: <code>2018-08-04T07:09:00.000Z</code>","type":"string"},"timeWindow":{"description":"A period of time, expressed in seconds. The call quota for a resource is applied to the period of time defined by the value of this field.","format":"int32","type":"integer"}},"type":"object"},"RateLimit":{"description":"This complex types defines the resource (such as an API method) for which the rate-limit data is returned. A method is included in an API, and an API is part of an API context for the API version specified.","properties":{"apiContext":{"description":"The context of the API for which rate-limit data is returned. For example <code>buy</code>, <code>sell</code>, <code>commerce</code>, <code>developer</code> or <code>tradingapi</code>.","type":"string"},"apiName":{"description":"The name of the API for which rate-limit data is returned. For example <code>browse</code> for the Buy API, <code>inventory</code> for the Sell API, <code>taxonomy</code> for the Commerce API, or <code>tradingapi</code> for Trading API.","type":"string"},"apiVersion":{"description":"The version of the API for which rate-limit data is returned. For example <code>v1</code> or <code>v2</code>.","type":"string"},"resources":{"description":"A list of the methods for which rate-limit data is returned. For example <code>item</code> for the Feed API, <code>getOrder</code> for the Fulfillment API, <code>getProduct</code> for the Catalog API, <code>AddItems</code> for the Trading API.","items":{"$ref":"#/components/schemas/Resource"},"type":"array"}},"type":"object"},"RateLimitsResponse":{"description":"This complex type defines a list of rate-limit data as it pertains to a method within the specified version of an API.","properties":{"rateLimits":{"description":"The rate-limit data for the specified APIs. The rate-limit data is returned for all the methods in the specified APIs and data pertains to the current time window.","items":{"$ref":"#/components/schemas/RateLimit"},"type":"array"}},"type":"object"},"Resource":{"description":"This complex type defines the resource (API method) and the current rate-limit data for that resource.","properties":{"name":{"description":"The name of the resource (an API or an API method) to which the rate-limit data applies.","type":"string"},"rates":{"description":"A list of rate-limit data, where each list element represents the rate-limit data for a specific resource.","items":{"$ref":"#/components/schemas/Rate"},"type":"array"}},"type":"object"}},"securitySchemes":{"api_auth":{"description":"The security definitions for this API. Please check individual operations for applicable scopes.","flows":{"authorizationCode":{"authorizationUrl":"https://auth.ebay.com/oauth2/authorize","scopes":{"https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly":" This scope would allow signed in user to read catalog data.","https://api.ebay.com/oauth/api_scope/sell.inventory":"View and manage your inventory and offers","https://api.ebay.com/oauth/api_scope/sell.inventory.readonly":"View your inventory and offers","https://api.ebay.com/oauth/api_scope/sell.marketing":"View and manage your eBay marketing activities, such as ad campaigns and listing promotions","https://api.ebay.com/oauth/api_scope/sell.marketing.readonly":"View your eBay marketing activities, such as ad campaigns and listing promotions","https://api.ebay.com/oauth/api_scope/sell.marketplace.insights.readonly":" This scope would allow signed in users read only access to marketplace insights."},"tokenUrl":"https://api.ebay.com/identity/v1/oauth2/token"},"clientCredentials":{"scopes":{"https://api.ebay.com/oauth/api_scope":"View public data from eBay"},"tokenUrl":"https://api.ebay.com/identity/v1/oauth2/token"}},"type":"oauth2"}}}}