openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 NewsSearch API
description: Amazon API Gateway
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: apigateway
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: NewsSearch
paths:
/news/search:
get:
tags:
- NewsSearch
summary: APIs.io Engineering Platform The News Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).
operationId: News_Search
parameters:
- name: X-BingApis-SDK
in: header
description: Activate swagger compliance
required: true
schema:
type: string
enum:
- 'true'
x-ms-enum:
modelAsString: true
name: XBingApisSDK
x-ms-parameter-location: method
x-ms-enum:
modelAsString: true
name: XBingApisSDK
x-ms-parameter-location: method
- name: Accept
in: header
description: The default media type is application/json. To specify that the response use [JSON-LD](http://json-ld.org/), set the Accept header to application/ld+json.
schema:
type: string
- name: Accept-Language
in: header
description: A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing order of preference. For additional information, including expected format, see [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter. To determine the market to return results for, Bing uses the first supported language it finds from the list and combines it with the cc parameter value. If the list does not include a supported language, Bing finds the closest language and market that supports the request or it uses an aggregated or default market for the results. To determine the market that Bing used, see the BingAPIs-Market header. Use this header and the cc query parameter only if you specify multiple languages. Otherwise, use the [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#mkt) and [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#setlang) query parameters. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Any links to Bing.com properties in the response objects apply the specified language.
schema:
type: string
x-ms-client-name: AcceptLanguage
x-ms-client-name: AcceptLanguage
- name: User-Agent
in: header
description: 'The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized experience. Although optional, you are encouraged to always specify this header. The user-agent should be the same string that any commonly used browser sends. For information about user agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The following are examples of user-agent strings. Windows Phone: Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0 (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD) AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142 iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad: Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit / 537.51.1 (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari / 9537.53'
schema:
type: string
x-ms-client-name: UserAgent
x-ms-client-name: UserAgent
- name: X-MSEdge-ClientID
in: header
description: 'Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that client ID’s search history, providing a richer experience for the user. Bing also uses this header to help improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client ID across multiple requests for the same end user and device combination enables 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better quality of results from the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the first time the user uses your app on that device. Use the client ID for each Bing API request that your app makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as mobile apps, use the device''s persistent storage to persist the ID. The next time the user uses your app on that device, get the client ID that you persisted. Bing responses may or may not include this header. If the response includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that device. If you include the X-MSEdge-ClientID, you must not include cookies in the request.'
schema:
type: string
x-ms-client-name: ClientId
x-ms-client-name: ClientId
- name: X-MSEdge-ClientIP
in: header
description: The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the location information to determine safe search behavior. Although optional, you are encouraged to always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual location, which may result in Bing serving erroneous results.
schema:
type: string
x-ms-client-name: ClientIp
x-ms-client-name: ClientIp
- name: X-Search-Location
in: header
description: 'A semicolon-delimited list of key/value pairs that describe the client''s geographical location. Bing uses the location information to determine safe search behavior and to return relevant local content. Specify the key/value pair as :. The following are the keys that you use to specify the user''s location. lat (required): The latitude of the client''s location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes. long (required): The longitude of the client''s location, in degrees. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of the coordinates. Pass the value returned by the device''s location service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1, 1970.) head (optional): The client''s relative heading or direction of travel. Specify the direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key. Although many of the keys are optional, the more information that you provide, the more accurate the location results are. Although optional, you are encouraged to always specify the user''s geographical location. Providing the location is especially important if the client''s IP address does not accurately reflect the user''s physical location (for example, if the client uses VPN). For optimal results, you should include this header and the X-MSEdge-ClientIP header, but at a minimum, you should include this header.'
schema:
type: string
x-ms-client-name: Location
x-ms-client-name: Location
- name: cc
in: query
description: A 2-character country code of the country where the results come from. This API supports only the United States market. If you specify this query parameter, it must be set to us. If you set this parameter, you must also specify the Accept-Language header. Bing uses the first supported language it finds from the languages list, and combine that language with the country code that you specify to determine the market to return results for. If the languages list does not include a supported language, Bing finds the closest language and market that supports the request, or it may use an aggregated or default market for the results instead of a specified one. You should use this query parameter and the Accept-Language query parameter only if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. This parameter and the mkt query parameter are mutually exclusive—do not specify both.
schema:
type: string
x-ms-client-name: CountryCode
x-ms-client-name: CountryCode
- name: count
in: query
description: The number of news articles to return in the response. The actual number delivered may be less than requested. The default is 10 and the maximum value is 100. The actual number delivered may be less than requested.You may use this parameter along with the offset parameter to page results. For example, if your user interface displays 20 articles per page, set count to 20 and offset to 0 to get the first page of results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to include some overlap in results.
schema:
type: integer
format: int32
x-ms-client-name: Count
x-ms-client-name: Count
- name: freshness
in: query
description: 'Filter news by the date and time that Bing discovered the news. The following are the possible filter values. Day: Return news discovered within the last 24 hours. Week: Return news discovered within the last 7 days. Month: Return news discovered within the last 30 days. Use this parameter only with the News Search API. Do not specify this parameter when calling the News Category API or the Trending Topics API.'
schema:
type: string
enum:
- Day
- Week
- Month
x-ms-client-name: Freshness
x-ms-enum:
modelAsString: true
name: Freshness
x-ms-client-name: Freshness
x-ms-enum:
modelAsString: true
name: Freshness
- name: mkt
in: query
description: 'The market where the results come from. Typically, mkt is the country where the user is making the request from. However, it could be a different country if the user is not located in a country where Bing delivers results. The market must be in the form -. For example, en-US. The string is case insensitive. For a list of possible market values, see [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes). NOTE: If known, you are encouraged to always specify the market. Specifying the market helps Bing route the request and return an appropriate and optimal response. If you specify a market that is not listed in [Market Codes](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#market-codes), Bing uses a best fit market code based on an internal mapping that is subject to change. This parameter and the [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#cc) query parameter are mutually exclusive—do not specify both.'
schema:
type: string
x-ms-client-name: Market
x-ms-client-name: Market
- name: offset
in: query
description: The zero-based offset that indicates the number of news to skip before returning news. The default is 0. The offset should be less than ([totalEstimatedMatches](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#news-totalmatches) - count). Use this parameter along with the count parameter to page results. For example, if your user interface displays 20 news per page, set count to 20 and offset to 0 to get the first page of results. For each subsequent page, increment offset by 20 (for example, 0, 20, 40). It is possible for multiple pages to include some overlap in results.
schema:
type: integer
format: int32
x-ms-client-name: Offset
x-ms-client-name: Offset
- name: originalImg
in: query
description: A Boolean value that determines whether the image's contentUrl contains a URL that points to a thumbnail of the original article's image or the image itself. If the article includes an image, and this parameter is set to true, the image's contentUrl property contains a URL that you may use to download the original image from the publisher's website. Otherwise, if this parameter is false, the image's contentUrl and thumbnailUrl URLs both point to the same thumbnail image. Use this parameter only with the News Search API. Do not specify this parameter when calling the Trending Topics API or News Category API.
schema:
type: boolean
x-ms-client-name: OriginalImage
x-ms-client-name: OriginalImage
- name: q
in: query
description: The user's search query string. The query string cannot be empty. The query string may contain [Bing Advanced Operators](http://msdn.microsoft.com/library/ff795620.aspx). For example, to limit news to a specific domain, use the [site:](http://msdn.microsoft.com/library/ff795613.aspx) operator. Use this parameter only with the News Search API. Do not specify this parameter when calling the Trending Topics API or News Category API.
required: true
schema:
type: string
x-ms-client-name: Query
x-ms-client-name: Query
- name: safeSearch
in: query
description: 'Filter news for adult content. The following are the possible filter values. Off: Return news articles with adult text, images, or videos. Moderate: Return news articles with adult text but not adult images or videos. Strict: Do not return news articles with adult text, images, or videos. If the request comes from a market that Bing''s adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value and uses Strict. If you use the site: query operator, there is the chance that the response may contain adult content regardless of what the safeSearch query parameter is set to. Use site: only if you are aware of the content on the site and your scenario supports the possibility of adult content.'
schema:
type: string
enum:
- 'false'
- Moderate
- Strict
x-ms-client-name: SafeSearch
x-ms-enum:
modelAsString: true
name: SafeSearch
x-ms-client-name: SafeSearch
x-ms-enum:
modelAsString: true
name: SafeSearch
- name: setLang
in: query
description: The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language code. For example, the language code for English is EN. The default is EN (English). Although optional, you should always specify the language. Typically, you set setLang to the same language specified by mkt unless the user wants the user interface strings displayed in a different language. This parameter and the [Accept-Language](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#acceptlanguage) header are mutually exclusive; do not specify both. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Also, any links to Bing.com properties in the response objects apply the specified language.
schema:
type: string
x-ms-client-name: SetLang
x-ms-client-name: SetLang
- name: sortBy
in: query
description: 'The order to return the news in. The following are the possible case-insensitive values. Date: If the request is through the News Search API, the response returns news articles sorted by date from the most recent to the oldest. If the request is through the News Trending Topics API, the response returns trending topics sorted by date from the most recent to the oldest.'
schema:
type: string
x-ms-client-name: SortBy
x-ms-client-name: SortBy
- name: textDecorations
in: query
description: A Boolean value that determines whether display strings contain decoration markers such as hit highlighting characters. If true, the strings may include markers. The default is false. To specify whether to use Unicode characters or HTML tags as the markers, see the [textFormat](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#textformat) query parameter. For information about hit highlighting, see [Hit Highlighting](https://docs.microsoft.com/azure/cognitive-services/bing-news-search/hit-highlighting).
schema:
type: boolean
x-ms-client-name: TextDecorations
x-ms-client-name: TextDecorations
- name: textFormat
in: query
description: The type of markers to use for text decorations (see the textDecorations query parameter). Possible values are Raw—Use Unicode characters to mark content that needs special formatting. The Unicode characters are in the range E000 through E019. For example, Bing uses E000 and E001 to mark the beginning and end of query terms for hit highlighting. HTML—Use HTML tags to mark content that needs special formatting. For example, use tags to highlight query terms in display strings. The default is Raw. For display strings that contain escapable HTML characters such as <, >, and &, if textFormat is set to HTML, Bing escapes the characters as appropriate (for example, < is escaped to <).
schema:
type: string
enum:
- Raw
- Html
x-ms-client-name: TextFormat
x-ms-enum:
modelAsString: true
name: TextFormat
x-ms-client-name: TextFormat
x-ms-enum:
modelAsString: true
name: TextFormat
responses:
'200':
description: Success.
content:
application/json:
schema:
$ref: '#/components/schemas/News'
default:
description: An error has occurred. Check the response type and/or status code for more details.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
x-ms-examples:
Successful query:
parameters:
Accept: application/json
Accept-language: en-us
Ocp-Apim-Subscription-Key: '{API key}'
User-Agent: '{User Agent}'
X-BingApis-SDK: 'true'
X-MS-EdgeClientIP: '{IP AddresS}'
X-MSEdge-ClientID: '{Client ID}'
cc: US
mkt: en-us
q: microsoft
setLang: en
responses:
'200':
body:
_type: News
totalEstimatedMatches: 46
value:
- _type: NewsArticle
category: ScienceAndTechnology
datePublished: 2017-11-16 14:15:00+00:00
description: Don't call it Surface Pro 5. The latest iteration of the Surface Pro loses the model number, keeps the kickstand, and adds mostly subtle refinements. Read More For the past five days, I've been using a Surface Book 2 in place of my everyday PC, a first ...
name: 'Surface Book 2 (15-inch): Microsoft supersizes its most powerful portable PC'
provider:
- _type: Organization
name: ZDNet
url: http://www.zdnet.com/product/microsoft-surface-book-2/
- _type: NewsArticle
category: ScienceAndTechnology
datePublished: 2017-11-17 06:13:00+00:00
description: Microsoft Surface Book 2 - 15" - Core i7 8650U - 16 GB RAM - 512 GB SSD - English - North America fux00001 $2,899.00 Microsoft Surface Book 2 - 15" - Core i7 8650U - 16 GB RAM - 256 GB SSD - English - North America hnr00001 $2,499.00 Microsoft Surface Book ...
image:
_type: ImageObject
thumbnail:
_type: ImageObject
contentUrl: https://www.bing.com/th?id=ON.4A5C3F257DA120C0D7778A4A764A0292&pid=News
height: 393
width: 700
name: 'Microsoft Surface Book 2 (15-inch) review:'
provider:
- _type: Organization
name: CNET
url: https://www.cnet.com/products/microsoft-surface-book-2/review/
video:
_type: VideoObject
allowHttpsEmbed: true
name: Microsoft Surface Book 2 (15-inch)
thumbnail:
_type: ImageObject
height: 269
width: 480
thumbnailUrl: https://www.bing.com/th?id=ON.C362047C8A293C48E4DBF9FCF1C99DD2&pid=News
- _type: NewsArticle
category: ScienceAndTechnology
datePublished: 2017-11-17 04:27:00+00:00
description: At just two years old, Edge is the new kid on the web browser block, but what it lacks in maturity, it makes up for in speed and convenience. Development has been swift. With each major Windows 10 release, Edge improves. Windows 10 Fall Creators Update ...
image:
_type: ImageObject
thumbnail:
_type: ImageObject
contentUrl: https://www.bing.com/th?id=ON.D6CC6169ECD49465AACCC1327B37283E&pid=News
height: 394
width: 700
name: 12 Reasons Microsoft's Edge Browser Rocks (No, Really)
provider:
- _type: Organization
name: PC Magazine
url: https://www.pcmag.com/feature/357262/12-reasons-microsoft-s-edge-browser-rocks-no-really
- _type: NewsArticle
category: ScienceAndTechnology
clusteredArticles:
- _type: NewsArticle
category: ScienceAndTechnology
datePublished: 2017-11-17 01:59:00+00:00
description: It may have been the company's first-ever laptop, but when I tested it last year a few months after it debuted, I immediately liked it better than any of Apple's MacBooks that I'd ever used. I now have a new favorite computer, and it's the successor to my ...
name: 'REVIEW: Microsoft's newest laptop is my new favorite computer (MSFT)'
provider:
- _type: Organization
name: Business Insider on MSN.com
url: https://www.msn.com/en-us/money/other/review-microsofts-newest-laptop-is-my-new-favorite-computer-msft/ar-BBF2svf
datePublished: 2017-11-16 23:58:00+00:00
description: Microsoft's original Surface Book was my favorite computer. It may have been the company's first-ever laptop, but when I tested it last year a few months after it debuted, I immediately liked it better than any of Apple's MacBooks that I'd ever used.
image:
_type: ImageObject
thumbnail:
_type: ImageObject
contentUrl: https://www.bing.com/th?id=ON.7CEEFC996C222EA79BC65ABFE9356D63&pid=News
height: 524
width: 700
name: 'REVIEW: Microsoft's newest laptop is a powerful alternative to any of Apple's MacBooks or iPads'
provider:
- _type: Organization
name: Business Insider
url: http://www.businessinsider.com/microsoft-surface-book-2-review-2017-11
headers: {}
components:
schemas:
MediaObject:
properties:
contentUrl:
type: string
description: Original URL to retrieve the source (file) for the media object (e.g the source URL for the image).
readOnly: true
height:
type: integer
description: The height of the source media object, in pixels.
format: int32
readOnly: true
width:
type: integer
description: The width of the source media object, in pixels.
format: int32
readOnly: true
description: Defines a media object.
allOf:
- $ref: '#/components/schemas/CreativeWork'
NewsArticle:
properties:
category:
type: string
description: The news category that the article belongs to. For example, Sports. If the news category cannot be determined, the article does not include this field.
readOnly: true
clusteredArticles:
type: array
description: A list of related news articles.
readOnly: true
items:
$ref: '#/components/schemas/NewsArticle'
headline:
type: boolean
description: A Boolean value that indicates whether the news article is a headline. If true, the article is a headline. The article includes this field only for news categories requests that do not specify the category query parameter.
readOnly: true
description: Defines a news article.
allOf:
- $ref: '#/components/schemas/Article'
ErrorResponse:
required:
- errors
properties:
errors:
type: array
description: A list of errors that describe the reasons why the request failed.
items:
$ref: '#/components/schemas/Error'
description: The top-level response that represents a failed request.
allOf:
- $ref: '#/components/schemas/Response'
ResponseBase:
required:
- _type
type: object
properties:
_type:
type: string
description: Response base
discriminator:
propertyName: _type
SearchResultsAnswer:
properties:
totalEstimatedMatches:
type: integer
description: The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results.
format: int64
readOnly: true
description: Defines a search result answer.
allOf:
- $ref: '#/components/schemas/Answer'
CreativeWork:
properties:
datePublished:
type: string
description: The date on which the CreativeWork was published.
readOnly: true
provider:
type: array
description: The source of the creative work.
readOnly: true
items:
$ref: '#/components/schemas/Thing'
thumbnailUrl:
type: string
description: The URL to a thumbnail of the item.
readOnly: true
video:
$ref: '#/components/schemas/VideoObject'
description: The most generic kind of creative work, including books, movies, photographs, software programs, etc.
allOf:
- $ref: '#/components/schemas/Thing'
ImageObject:
properties:
thumbnail:
$ref: '#/components/schemas/ImageObject'
description: Defines an image
allOf:
- $ref: '#/components/schemas/MediaObject'
Identifiable:
properties:
id:
type: string
description: A String identifier.
readOnly: true
description: Defines the identity of a resource.
allOf:
- $ref: '#/components/schemas/ResponseBase'
Thing:
properties:
alternateName:
type: string
description: An alias for the item
readOnly: true
bingId:
type: string
description: An ID that uniquely identifies this item.
readOnly: true
description:
type: string
description: A short description of the item.
readOnly: true
image:
$ref: '#/components/schemas/ImageObject'
name:
type: string
description: The name of the thing represented by this object.
readOnly: true
url:
type: string
description: The URL to get more information about the thing represented by this object.
readOnly: true
description: Defines a thing.
allOf:
- $ref: '#/components/schemas/Response'
VideoObject:
properties:
allowHttpsEmbed:
type: boolean
readOnly: true
allowMobileEmbed:
type: boolean
readOnly: true
embedHtml:
type: string
readOnly: true
isSuperfresh:
type: boolean
readOnly: true
motionThumbnailId:
type: string
readOnly: true
motionThumbnailUrl:
type: string
readOnly: true
thumbnail:
$ref: '#/components/schemas/ImageObject'
videoId:
type: string
readOnly: true
viewCount:
type: integer
format: int32
readOnly: true
description: Defines a video object that is relevant to the query.
allOf:
- $ref: '#/components/schemas/MediaObject'
Article:
properties:
wordCount:
type: integer
description: The number of words in the text of the Article.
format: int32
readOnly: true
allOf:
- $ref: '#/components/schemas/CreativeWork'
Error:
required:
- code
- message
type: object
properties:
code:
type: string
description: The error code that identifies the category of error.
default: None
enum:
- None
- ServerError
- InvalidRequest
- RateLimitExceeded
- InvalidAuthorization
- InsufficientAuthorization
x-ms-enum:
modelAsString: true
name: ErrorCode
message:
type: string
description: A description of the error.
moreDetails:
type: string
description: A description that provides additional information about the error.
readOnly: true
parameter:
type: string
description: The parameter in the request that caused the error.
readOnly: true
subCode:
type: string
description: The error code that further helps to identify the error.
readOnly: true
enum:
- UnexpectedError
- ResourceError
- NotImplemented
- ParameterMissing
- ParameterInvalidValue
- HttpNotAllowed
- Blocked
- AuthorizationMissing
- AuthorizationRedundancy
- AuthorizationDisabled
- AuthorizationExpired
x-ms-enum:
modelAsString: true
name: ErrorSubCode
value:
type: string
description: The parameter's value in the request that was not valid.
readOnly: true
description: Defines the error that occurred.
Query:
required:
- text
type: object
properties:
displayText:
type: string
description: The display version of the query term. This version of the query term may contain special characters that highlight the search term found in the query string. The string contains the highlighting characters only if the query enabled hit highlighting
readOnly: true
searchLink:
type: string
description: The URL that you use to get the results of the related search. Before using the URL, you must append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL if you're displaying the results in your own user interface. Otherwise, use the webSearchUrl URL.
readOnly: true
text:
type: string
description: The query string. Use this string as the query term in a new search request.
thumbnail:
$ref: '#/components/schemas/ImageObject'
webSearchUrl:
type: string
description: The URL that takes the user to the Bing search results page for the query.Only related search results include this field.
readOnly: true
description: Defines a search query.
News:
required:
- value
properties:
location:
type: string
description: Location of local news
readOnly: true
value:
type: array
description: An array of NewsArticle objects that contain information about news articles that are relevant to the query. If there are no results to return for the request, the array is empty.
items:
$ref: '#/components/schemas/NewsArticle'
description: Defines a news answer.
allOf:
- $ref: '#/components/schemas/SearchResultsAnswer'
Answer:
properties:
followUpQueries:
type: array
readOnly: true
items:
$ref: '#/components/schemas/Query'
description: Defines an answer.
allOf:
- $ref: '#/components/schemas/Response'
Response:
properties:
webSearchUrl:
type: string
description: The URL To Bing's search result for this item.
readOnly: true
description: Defines a response. All schemas that could be returned at the root of a response should inherit from this
allOf:
- $ref: '#/components/schemas/Identifiable'
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true