openapi: 3.0.3
info:
  title: Mashable via News Articles Headlines API
  summary: Access Mashable headlines and articles through the News API REST service.
  description: Mashable content is accessible via the News API, a third-party REST API that provides live headlines, articles, images, and metadata from Mashable and over 150,000 other worldwide news sources. Use the source identifier "mashable" or domain "mashable.com" to retrieve content published by Mashable.
  version: '2'
  contact:
    name: News API
    url: https://newsapi.org/
servers:
- url: https://newsapi.org/v2
  description: News API production endpoint
security:
- apiKeyAuth: []
tags:
- name: Headlines
  description: Top headline retrieval.
paths:
  /top-headlines:
    get:
      tags:
      - Headlines
      summary: Top headlines for Mashable
      description: Returns breaking news headlines for Mashable by passing sources=mashable. Supports optional category, country, and search query filters. An API key is required.
      operationId: getMashableTopHeadlines
      parameters:
      - name: sources
        in: query
        description: Pass "mashable" to limit headlines to Mashable.
        schema:
          type: string
          default: mashable
      - name: q
        in: query
        description: Keywords or phrase to search within Mashable headlines.
        schema:
          type: string
      - name: pageSize
        in: query
        schema:
          type: integer
          default: 20
          maximum: 100
      - name: page
        in: query
        schema:
          type: integer
          default: 1
      responses:
        '200':
          description: Article list response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArticlesResponse'
components:
  schemas:
    ArticlesResponse:
      type: object
      properties:
        status:
          type: string
        totalResults:
          type: integer
        articles:
          type: array
          items:
            $ref: '#/components/schemas/Article'
    Article:
      type: object
      properties:
        source:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
        author:
          type: string
          nullable: true
        title:
          type: string
        description:
          type: string
          nullable: true
        url:
          type: string
          format: uri
        urlToImage:
          type: string
          format: uri
          nullable: true
        publishedAt:
          type: string
          format: date-time
        content:
          type: string
          nullable: true
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: News API key. May also be passed via apiKey query parameter.