Microsoft Azure NewsCategory API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector News Category API
tags:
- name: NewsCategory
paths:
  /news:
    get:
      summary: 'Microsoft Azure The News Category Api Lets You Search On Bing And Get Back A List Of Top News Articles By Category 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: microsoftAzureNewsCategory
      tags:
      - NewsCategory
      parameters:
      - $ref: '#/components/parameters/x-bingapis-sdk'
      - 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.
        required: false
        schema:
          type: string
      - name: Accept-Language
        x-ms-client-name: AcceptLanguage
        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.
        required: false
        schema:
          type: string
      - name: User-Agent
        x-ms-client-name: UserAgent
        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'
        required: false
        schema:
          type: string
      - name: X-MSEdge-ClientID
        x-ms-client-name: 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.'
        required: false
        schema:
          type: string
      - name: X-MSEdge-ClientIP
        x-ms-client-name: 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.
        required: false
        schema:
          type: string
      - name: X-Search-Location
        x-ms-client-name: 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 <key>:<value>. 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.'
        required: false
        schema:
          type: string
      - name: cc
        x-ms-client-name: CountryCode
        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.
        required: false
        schema:
          type: string
      - name: category
        x-ms-client-name: Category
        in: query
        description: 'The category of articles to return. For example, Sports articles or Entertainment articles. For a list of possible categories, see [News Categories by Market](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#categories-by-market). Use this parameter only with News Category API. If you do not specify this parameter, the response includes both: Headline articles typically published in the last 24 hours from any category and articles from each parent category (up to four articles). If the article is a headline, the article''s headline field is set to true. By default, the response includes up to 12 headline articles. To specify the number of headline articles to return, set the [headlineCount](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#headlineCount) query parameter.'
        required: false
        schema:
          type: string
      - name: count
        x-ms-client-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. If you do not specify the [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category) parameter, Bing ignores this parameter.
        required: false
        schema:
          type: integer
          format: int32
      - name: headlineCount
        x-ms-client-name: HeadlineCount
        in: query
        description: The number of headline articles to return in the response. The default is 12. Specify this parameter only if you do not specify the [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category) parameter.
        required: false
        schema:
          type: integer
          format: int32
      - name: mkt
        x-ms-client-name: Market
        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 <language code>-<country code>. 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.'
        required: false
        schema:
          type: string
      - name: offset
        x-ms-client-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. If you do not specify the [category](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-news-api-v7-reference#category) parameter, Bing ignores this parameter.
        required: false
        schema:
          type: integer
          format: int32
      - name: originalImg
        x-ms-client-name: OriginalImage
        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 or News Category API. Trending Topics API ignore this parameter.
        required: false
        schema:
          type: boolean
      - name: safeSearch
        x-ms-client-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.'
        required: false
        x-ms-enum:
          name: SafeSearch
          modelAsString: true
        schema:
          type: string
          enum:
          - 'Off'
          - Moderate
          - Strict
      - name: setLang
        x-ms-client-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.
        required: false
        schema:
          type: string
      - name: textDecorations
        x-ms-client-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).
        required: false
        schema:
          type: boolean
      - name: textFormat
        x-ms-client-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 <b> 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 &lt;).
        required: false
        x-ms-enum:
          name: TextFormat
          modelAsString: true
        schema:
          type: string
          enum:
          - Raw
          - Html
      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:
          $ref: ./examples//SuccessfulNewsCategoryRequest.json
      description: Needs a more full description created.
components:
  schemas:
    ErrorResponse:
      description: The top-level response that represents a failed request.
      allOf:
      - $ref: '#/components/schemas/Response'
      type: object
      required:
      - errors
      properties:
        errors:
          description: A list of errors that describe the reasons why the request failed.
          type: array
          items:
            $ref: '#/components/schemas/Error'
    ResponseBase:
      description: Response base
      discriminator:
        propertyName: _type
      type: object
      required:
      - _type
      properties:
        _type:
          type: string
    Error:
      description: Defines the error that occurred.
      type: object
      required:
      - code
      - message
      properties:
        code:
          description: The error code that identifies the category of error.
          type: string
          default: None
          enum:
          - None
          - ServerError
          - InvalidRequest
          - RateLimitExceeded
          - InvalidAuthorization
          - InsufficientAuthorization
          x-ms-enum:
            name: ErrorCode
            modelAsString: true
        subCode:
          description: The error code that further helps to identify the error.
          readOnly: true
          type: string
          enum:
          - UnexpectedError
          - ResourceError
          - NotImplemented
          - ParameterMissing
          - ParameterInvalidValue
          - HttpNotAllowed
          - Blocked
          - AuthorizationMissing
          - AuthorizationRedundancy
          - AuthorizationDisabled
          - AuthorizationExpired
          x-ms-enum:
            name: ErrorSubCode
            modelAsString: true
        message:
          description: A description of the error.
          type: string
        moreDetails:
          description: A description that provides additional information about the error.
          readOnly: true
          type: string
        parameter:
          description: The parameter in the request that caused the error.
          readOnly: true
          type: string
        value:
          description: The parameter's value in the request that was not valid.
          readOnly: true
          type: string
    CreativeWork:
      description: The most generic kind of creative work, including books, movies, photographs, software programs, etc.
      allOf:
      - $ref: '#/components/schemas/Thing'
      type: object
      properties:
        thumbnailUrl:
          description: The URL to a thumbnail of the item.
          readOnly: true
          type: string
        provider:
          description: The source of the creative work.
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/Thing'
        datePublished:
          description: The date on which the CreativeWork was published.
          readOnly: true
          type: string
        video:
          description: A video of the item.
          $ref: '#/components/schemas/VideoObject'
          readOnly: true
    Article:
      allOf:
      - $ref: '#/components/schemas/CreativeWork'
      type: object
      properties:
        wordCount:
          description: The number of words in the text of the Article.
          readOnly: true
          type: integer
          format: int32
    Answer:
      description: Defines an answer.
      allOf:
      - $ref: '#/components/schemas/Response'
      type: object
      properties:
        followUpQueries:
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/Query'
    Query:
      description: Defines a search query.
      type: object
      required:
      - text
      properties:
        text:
          description: The query string. Use this string as the query term in a new search request.
          type: string
        displayText:
          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
          type: string
        webSearchUrl:
          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
          type: string
        searchLink:
          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
          type: string
        thumbnail:
          description: The URL to a thumbnail of a related image.
          $ref: '#/components/schemas/ImageObject'
          readOnly: true
    News:
      description: Defines a news answer.
      allOf:
      - $ref: '#/components/schemas/SearchResultsAnswer'
      type: object
      required:
      - value
      properties:
        value:
          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.
          type: array
          items:
            $ref: '#/components/schemas/NewsArticle'
        location:
          description: Location of local news
          readOnly: true
          type: string
    NewsArticle:
      description: Defines a news article.
      allOf:
      - $ref: '#/components/schemas/Article'
      type: object
      properties:
        category:
          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
          type: string
        headline:
          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
          type: boolean
        clusteredArticles:
          description: A list of related news articles.
          readOnly: true
          type: array
          items:
            $ref: '#/components/schemas/NewsArticle'
    Response:
      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'
      type: object
      properties:
        webSearchUrl:
          description: The URL To Bing's search result for this item.
          readOnly: true
          type: string
    ImageObject:
      description: Defines an image
      allOf:
      - $ref: '#/components/schemas/MediaObject'
      type: object
      properties:
        thumbnail:
          description: The URL to a thumbnail of the image
          $ref: '#/components/schemas/ImageObject'
          readOnly: true
    VideoObject:
      description: Defines a video object that is relevant to the query.
      allOf:
      - $ref: '#/components/schemas/MediaObject'
      type: object
      properties:
        motionThumbnailUrl:
          readOnly: true
          type: string
        motionThumbnailId:
          readOnly: true
          type: string
        embedHtml:
          readOnly: true
          type: string
        allowHttpsEmbed:
          readOnly: true
          type: boolean
        viewCount:
          readOnly: true
          type: integer
          format: int32
        thumbnail:
          $ref: '#/components/schemas/ImageObject'
          readOnly: true
        videoId:
          readOnly: true
          type: string
        allowMobileEmbed:
          readOnly: true
          type: boolean
        isSuperfresh:
          readOnly: true
          type: boolean
    SearchResultsAnswer:
      description: Defines a search result answer.
      allOf:
      - $ref: '#/components/schemas/Answer'
      type: object
      properties:
        totalEstimatedMatches:
          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.
          readOnly: true
          type: integer
          format: int64
    MediaObject:
      description: Defines a media object.
      allOf:
      - $ref: '#/components/schemas/CreativeWork'
      type: object
      properties:
        contentUrl:
          description: Original URL to retrieve the source (file) for the media object (e.g the source URL for the image).
          readOnly: true
          type: string
        width:
          description: The width of the source media object, in pixels.
          readOnly: true
          type: integer
          format: int32
        height:
          description: The height of the source media object, in pixels.
          readOnly: true
          type: integer
          format: int32
    Thing:
      description: Defines a thing.
      allOf:
      - $ref: '#/components/schemas/Response'
      type: object
      properties:
        name:
          description: The name of the thing represented by this object.
          readOnly: true
          type: string
        url:
          description: The URL to get more information about the thing represented by this object.
          readOnly: true
          type: string
        image:
          description: An image of the item.
          $ref: '#/components/schemas/ImageObject'
          readOnly: true
        description:
          description: A short description of the item.
          readOnly: true
          type: string
        alternateName:
          description: An alias for the item
          readOnly: true
          type: string
        bingId:
          description: An ID that uniquely identifies this item.
          readOnly: true
          type: string
    Identifiable:
      description: Defines the identity of a resource.
      allOf:
      - $ref: '#/components/schemas/ResponseBase'
      type: object
      properties:
        id:
          description: A String identifier.
          readOnly: true
          type: string
  parameters:
    x-bingapis-sdk:
      name: X-BingApis-SDK
      description: Activate swagger compliance
      x-ms-parameter-location: method
      required: true
      in: header
      x-ms-enum:
        name: XBingApisSDK
        modelAsString: true
      schema:
        type: string
        enum:
        - 'true'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'