unicum.gg Glossary API

openapi: 3.2.0
info:
  title: unicum.gg Glossary API
  version: 0.1.0
  description: Free World of Tanks stats for every player, clan and tank across EU, NA and Asia. WN8, WNX, winrate, tank progression, clan member rankings and history.
servers:
- url: https://unicum.gg/api
security: []
tags:
- name: Glossary
  x-displayName: Glossary
paths:
  /glossary/search:
    get:
      operationId: get-glossary-search
      summary: Search the glossary
      description: 'Search every term the site defines (minimum 3 characters), by name, by any other spelling it is known by, and failing both by its definition, so a reader who only remembers what a thing does still finds it. Ranks exact names first, then prefixes, then the rest. Region-less: a definition reads the same on every server.'
      tags:
      - Glossary
      parameters:
      - in: query
        name: q
        required: true
        schema:
          type: string
          description: Search prefix.
        description: Search prefix.
        example: uni
      - in: query
        name: language
        required: false
        schema:
          $ref: '#/components/schemas/answerLanguageField'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlossarySearchResponse'
  /glossary:
    get:
      operationId: get-glossary
      summary: Glossary
      description: 'Every World of Tanks term the site defines: game mechanics, vehicle statistics, battle formats, rating systems and community slang. Each entry carries a one-sentence definition, the other spellings it is searched by, and the section it belongs to. Alphabetical by term. Pass `category` to read one section.'
      tags:
      - Glossary
      parameters:
      - in: query
        name: category
        required: false
        schema:
          $ref: '#/components/schemas/glossaryCategoryField'
      - in: query
        name: language
        required: false
        schema:
          $ref: '#/components/schemas/answerLanguageField'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlossaryListResponse'
  /glossary/anchors:
    get:
      operationId: get-glossary-anchors
      summary: Glossary anchors
      description: 'Where each glossary term attaches to the interface: the tank specification columns and the on-screen labels it defines, with the one-sentence definition to show for them. Small by construction (only anchored terms, listed once each), so a client can hold the whole thing and explain a table without another request.'
      tags:
      - Glossary
      parameters:
      - in: query
        name: language
        required: false
        schema:
          $ref: '#/components/schemas/answerLanguageField'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlossaryAnchorsResponse'
  /glossary/{slug}:
    get:
      operationId: get-glossary-{slug}
      summary: Glossary term
      description: 'One glossary term in full: its definition, the body of the entry with every mention of another term already resolved to that term''s slug, the terms it relates to, and the pages of the site it points at.'
      tags:
      - Glossary
      parameters:
      - in: query
        name: language
        required: false
        schema:
          $ref: '#/components/schemas/answerLanguageField'
      - in: path
        name: slug
        required: true
        schema:
          type: string
          description: Term slug, e.g. `wn8`.
        description: Term slug, e.g. `wn8`.
        example: slug
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlossaryTermResponse'
components:
  schemas:
    GlossarySearchResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/GlossaryTermSummary'
      required:
      - results
    GlossaryTermSummary:
      type: object
      properties:
        slug:
          type: string
        term:
          type: string
        aliases:
          type: array
          items:
            type: string
          description: Other spellings the term is known and searched by.
        category:
          $ref: '#/components/schemas/glossaryCategoryField'
        short:
          type: string
          description: One-sentence definition, complete on its own.
      required:
      - slug
      - term
      - aliases
      - category
      - short
      description: A glossary term without its body.
    GlossaryAnchorsResponse:
      type: object
      properties:
        terms:
          type: array
          items:
            $ref: '#/components/schemas/GlossaryAnchorTerm'
        bySpecKey:
          type: object
          additionalProperties:
            type: string
          propertyNames:
            type: string
          description: Tank specification column to the slug that defines it.
        byLabel:
          type: object
          additionalProperties:
            type: string
          propertyNames:
            type: string
          description: Lowercased interface label to the slug that defines it.
      required:
      - terms
      - bySpecKey
      - byLabel
    formulaBlock:
      type: object
      properties:
        kind:
          type: string
        expression:
          type: string
        note:
          type: string
      required:
      - kind
      - expression
    glossaryCategoryField:
      type: string
      description: Section of the glossary a term belongs to.
      enum:
      - vehicles
      - gunnery
      - armor
      - mobility
      - vision
      - crew
      - progression
      - economy
      - ratings
      - statistics
      - modes
      - tactics
      - slang
    GlossaryTermResponse:
      type: object
      properties:
        slug:
          type: string
        term:
          type: string
        aliases:
          type: array
          items:
            type: string
        category:
          $ref: '#/components/schemas/glossaryCategoryField'
        short:
          type: string
        body:
          type: array
          items:
            $ref: '#/components/schemas/GlossaryBlock'
        related:
          type: array
          items:
            $ref: '#/components/schemas/GlossaryTermSummary'
        links:
          type: array
          items:
            $ref: '#/components/schemas/glossaryLink'
      required:
      - slug
      - term
      - aliases
      - category
      - short
      - body
      - related
      - links
    answerLanguageField:
      type: string
      description: Language to write the answer in (an interface locale, e.g. `fr`). Falls back to English for a language this catalogue has not been translated into; the response's `Content-Language` names the one actually served.
      examples:
      - fr
    listBlock:
      type: object
      properties:
        kind:
          type: string
        items:
          type: array
          items:
            type: array
            items:
              $ref: '#/components/schemas/glossarySegment'
      required:
      - kind
      - items
    GlossaryAnchorTerm:
      type: object
      properties:
        slug:
          type: string
        term:
          type: string
        short:
          type: string
      required:
      - slug
      - term
      - short
      description: A term as a tooltip renders it.
    GlossaryBlock:
      oneOf:
      - $ref: '#/components/schemas/paragraphBlock'
      - $ref: '#/components/schemas/listBlock'
      - $ref: '#/components/schemas/formulaBlock'
      description: 'One block of a definition: a paragraph, a list or a formula.'
    glossaryLink:
      type: object
      properties:
        target:
          type: string
          description: Which page of the site the link leads to.
          enum:
          - top-players
          - top-clans
          - tanks
          - tank-economics
          - marks-of-excellence
          - marks-of-mastery
          - tank-changes
          - maps
          - stronghold
          - advances
          - onslaught
          - rampage
          - coverage
          - docs
          - tank
          - map
        slug:
          type: string
        label:
          type: string
      required:
      - target
    paragraphBlock:
      type: object
      properties:
        kind:
          type: string
        segments:
          type: array
          items:
            $ref: '#/components/schemas/glossarySegment'
      required:
      - kind
      - segments
    glossarySegment:
      type: object
      properties:
        text:
          type: string
        slug:
          type: string
      required:
      - text
    GlossaryListResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/GlossaryTermSummary'
      required:
      - results