Wikimedia Offline API

openapi: 3.2.0
info:
  version: 1.0.0
  title: Wikimedia REST Offline API
  description: 'This API provides cacheable and straightforward access to Wikimedia content and data, in machine-readable formats.

    ### Global Rules

    - Limit your clients to no more than 200 requests/s to this API.

    Each API endpoint''s documentation may detail more specific usage limits.

    - Set a unique `User-Agent` or `Api-User-Agent` header that

    allows us to contact you quickly. Email addresses or URLs

    of contact pages work well.


    By using this API, you agree to Wikimedia''s Terms of Use and Privacy Policy. Unless otherwise specified in the endpoint documentation below, content accessed via this API is licensed under the CC-BY-SA 3.0 and GFDL licenses, and you irrevocably agree to release modifications or additions made through this API under these licenses. Check the Wikimedia REST API documentation for background and details.

    ### Endpoint documentation

    Please consult each endpoint''s documentation for details on:

    - Licensing information for the specific type of content

    and data served via the endpoint.

    - Stability markers to inform you about development status and

    change policy, according to

    our API version policy.

    - Endpoint specific usage limits.'
  termsOfService: https://wikimediafoundation.org/wiki/Terms_of_Use
  contact:
    name: the Wikimedia Services team
    url: http://mediawiki.org/wiki/Wikimedia_REST_API
  license:
    name: Apache2
    url: http://www.apache.org/licenses/LICENSE-2.0
servers:
- url: /api/rest_v1
tags:
- name: Offline
paths:
  /page/mobile-html-offline-resources/{title}:
    get:
      tags:
      - Offline
      summary: Get styles and scripts for offline consumption of mobile-html-formatted pages
      description: 'Provides links to scripts and styles needed for viewing mobile-html-formatted pages offline.


        Stability: experimental'
      parameters:
      - name: title
        in: path
        description: 'Page title. Use underscores instead of spaces. Use percent-encoding. Example: `Main_Page`.'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: links to scripts and styles to accompany the mobile-html of the page for offline consumption
          content:
            application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/Mobile-HTML-Offline-Resources/1.2.1":
              schema:
                type: string
        default:
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
      x-monitor: true
      x-amples:
      - title: Get offline resource links to accompany page content HTML for test page
        request:
          params:
            title: User:BSitzmann_(WMF)/MCS/Test/Frankenstein
        response:
          status: 200
          headers:
            content-type: /^application\/json.+/
      operationId: getPageMobileHtmlOfflineResourcesByTitle
      x-operation-id-source: derived
  /page/mobile-html-offline-resources/{title}/{revision}:
    get:
      tags:
      - Offline
      summary: Get styles and scripts for offline consumption of mobile-html-formatted pages
      description: 'Provides links to scripts and styles needed for viewing mobile-html-formatted pages offline.


        Stability: experimental'
      parameters:
      - name: title
        in: path
        description: 'Page title. Use underscores instead of spaces. Use percent-encoding. Example: `Main_Page`.'
        required: true
        schema:
          type: string
      - name: revision
        in: path
        description: 'Optional page revision. Note that older revisions are not stored, so request latency with the revision would be higher.

          '
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: links to scripts and styles to accompany the mobile-html of the page for offline consumption
          content:
            application/json; charset=utf-8; profile="https://www.mediawiki.org/wiki/Specs/Mobile-HTML-Offline-Resources/1.2.1":
              schema:
                type: string
        default:
          description: Error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problem'
      x-monitor: false
      x-amples:
      - title: Get offline resource links to accompany page content HTML for test page
        request:
          params:
            title: User:BSitzmann_(WMF)/MCS/Test/Frankenstein
        response:
          status: 200
          headers:
            content-type: /^application\/json.+/
      operationId: getPageMobileHtmlOfflineResourcesByTitleByRevision
      x-operation-id-source: derived
components:
  schemas:
    problem:
      required:
      - type
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        detail:
          type: string
        instance:
          type: string
x-host-basePath: /api/rest_v1
x-default-params: {}