swagger: "2.0"
info:
  description: This is the swagger file that goes with our server code
  version: "1.0.0"
  title: Swagger REST Article
consumes:
  - "application/json"
produces:
  - "application/json"

basePath: "/"

# Paths supported by the server application
paths:
  /ffxiv/fflogsapi/getPlayer:
    get:
      operationId: "ffxiv.wrapper_for_getFFLOGSapiPlayerData"
      tags:
        - "FFXIV"
      summary: "Returns a list of all available translation files with .json file ending"
      description: ""
      parameters:
      - in: query
        name: player
        description: To reload data if you think something is missing (takes a bit)
        required: true
        type: string
      - in: query
        name: latest_raid
        required: false
        type: string
      - in: query
        name: unreal_id
        required: false
        type: string
      - in: query
        name: latest_primal
        required: false
        type: string
      responses:
        200:
          description: ""
          schema:
            type: string
            items: {}
        400:
          description: "Returns when no categorie was found"
          schema:
            type: string
            items: {}
  /ffxiv/translate/overview:
    get:
      operationId: "ffxiv.translate_overview"
      tags:
        - "Translate"
      summary: "Returns a list of all available translation files with .json file ending"
      description: ""
      parameters:
      - in: query
        name: reload
        description: To reload data if you think something is missing (takes a bit)
        required: false
        type: boolean
      responses:
        200:
          description: "Returns a list of translation files"
          schema:
            type: "array"
            items: {}
        400:
          description: "Returns when no categorie was found"
          schema:
            type: string
            items: {}
  /ffxiv/translate/categories:
    get:
      operationId: "ffxiv.translate_categories"
      tags:
        - "Translate"
      summary: "Returns a list of all available translation category names wihtout .json ending"
      description: ""
      parameters:
      - in: query
        name: reload
        description: To reload data if you think something is missing (takes a bit)
        required: false
        type: boolean
      responses:
        200:
          description: "Returns a list of translation categories"
          schema:
            type: "array"
            items: {}
        400:
          description: "Returns when no categorie was found"
          schema:
            type: string
            items: {}
  /ffxiv/translate/category:
    get:
      operationId: "ffxiv.translate_category"
      tags:
        - "Translate"
      summary: "Returns everything from a translation category name"
      description: ""
      parameters:
      - in: query
        name: name
        description: Name of the category
        required: true
        type: string
      - in: query
        name: reload
        description: To reload data if you think something is missing (takes a bit)
        required: false
        type: boolean
      responses:
        200:
          description: "Returns a list of translation categories"
          schema:
            type: "array"
            items: {}
        400:
          description: "Returns when no categorie was found"
          schema:
            type: string
            items: {}
  /ffxiv/translate/search:
    get:
      operationId: "ffxiv.translate_search"
      tags:
        - "Translate"
      summary: "Search for specific termn in the translation files"
      description: ""
      produces:
      - application/json
      parameters:
      - in: query
        name: text
        description: search text that should be found
        required: true
        type: string
      - in: query
        name: reload
        description: To reload data if you think something is missing (takes a bit)
        required: false
        type: boolean
      - in: query
        name: file_filter
        description: Limit the files that should be looked at
        required: false
        type: string
      - in: query
        name: exact
        description: If true, only acat matches are return (e.g. no Flamethrower if just searched for Flame)
        required: false
        type: boolean
      - in: query
        name: removeLanguages
        description: Removes the specified language fields from the response
        required: false
        type: string
      responses:
        200:
          description: "Description"
          schema:
            type: "array"
            items: {}
        400:
          description: "Returns when no matching instance was found"
          schema:
            type: string
            items: {}
  /ffxiv/log/instances:
    get:
      operationId: "ffxiv.getAllInstances"
      tags:
        - "Logdata"
      summary: "Returns a list of all instances"
      description: ""
      parameters:
      - in: query
        name: doesContain
        description: Filter return list by a regex, string or array
        required: false
        type: string
      - in: query
        name: reload
        description: To reload data if you think something is missing (takes a bit)
        required: false
        type: boolean
      responses:
        200:
          description: "Description"
          schema:
            type: "array"
            items:
              properties:
                files:
                  type: array
        400:
          description: "Returns when no matching instance was found"
          schema:
            type: string
            items: {}
  /ffxiv/log/instance:
    get:
      operationId: "ffxiv.getInstance"
      tags:
        - "Logdata"
      summary: "This get the content of a specified Instance (skill/status/zones)"
      description: ""
      produces:
      - application/json
      parameters:
      - in: query
        name: name
        description: Instance name of the wanted content
        required: true
        type: string
      - in: query
        name: reload
        description: To reload data if you think something is missing (takes a bit)
        required: false
        type: boolean
      responses:
        200:
          description: "Returns the content of the specified instance"
          schema:
            type: string
            items: {}
        400:
          description: "Returns when no matching instance was found"
          schema:
            type: string
            items: {}
  /ffxiv/log:
    get:
      operationId: "ffxiv.getLogData"
      tags:
        - "Logdata"
      summary: "This gets the full content of the Logdata"
      description: ""
      produces:
      - application/json
      parameters:
      - in: query
        name: reload
        description: To reload data if you think something is missing (takes a bit)
        required: false
        type: boolean
      responses:
        200:
          description: "Returns the content of the specified instance"
          schema:
            type: string
            items: {}
        400:
          description: "Returns when no matching instance was found"
          schema:
            type: string
            items: {}
  /ffxiv/versions:
    get:
      operationId: "ffxiv.getVersions"
      tags:
        - "getVersions"
      summary: "This gets the full version list"
      description: ""
      produces:
      - application/json
      responses:
        200:
          description: "Returns the content of the specified instance"
          schema:
            type: string
            items: {}
        400:
          description: "Returns when no matching instance was found"
          schema:
            type: string
            items: {}
  /ffxiv/versions/latest:
    get:
      operationId: "ffxiv.getLatestVersions"
      tags:
        - "getVersions"
      summary: "This gets the latest version returned"
      description: ""
      produces:
      - application/json
      responses:
        200:
          description: "Returns the content of the specified instance"
          schema:
            type: string
            items: {}
        400:
          description: "Returns when no matching instance was found"
          schema:
            type: string
            items: {}
  /ffxiv/versions/last:
    get:
      operationId: "ffxiv.getLastVersions"
      tags:
        - "getVersions"
      summary: "This gets the last version returned"
      description: ""
      produces:
      - application/json
      responses:
        200:
          description: "Returns the content of the specified instance"
          schema:
            type: string
            items: {}
        400:
          description: "Returns when no matching instance was found"
          schema:
            type: string
            items: {}
  /ffxiv/gear/:
    get:
      operationId: "ffxiv_gear.get"
      tags:
        - "FFXIV"
      summary: "Get the specified Gear set"
      description: ""
      produces:
      - application/json
      parameters:
      - in: query
        name: lvl_from
        description: ""
        required: true
        type: integer
      - in: query
        name: lvl_to
        description: ""
        required: true
        type: integer
      - in: query
        name: ilvl_from
        description: ""
        required: true
        type: integer
      - in: query
        name: ilvl_to
        description: ""
        required: true
        type: integer
      - in: query
        name: rarity
        description: ""
        required: true
        type: array
        items:
          type: integer
      - in: query
        name: category
        description: ""
        required: true
        type: array
        items:
          type: string
      - in: query
        name: classjob
        description: ""
        required: true
        type: string
      - in: query
        name: recreate
        description: ""
        required: false
        type: boolean
      responses:
        200:
          description: ""
          schema:
            type: string
            items: {}
        400:
          description: ""
          schema:
            type: string
            items: {}
  /ffxiv/latestJSON/:
    get:
      operationId: "ffxiv.getLatestJSON"
      tags:
        - "FFXIV"
      summary: ""
      description: ""
      produces:
      - application/json
      parameters:
      - in: query
        name: name
        description: ""
        required: true
        type: string
      - in: query
        name: fieldfilter
        description: ""
        required: false
        type: array
        items:
          type: string
      - in: query
        name: filterterm
        description: ""
        required: false
        type: string
      responses:
        200:
          description: ""
  /ffxiv/latestJSONfields/:
    get:
      operationId: "ffxiv.getLatestJSONfields"
      tags:
        - "FFXIV"
      summary: ""
      description: ""
      produces:
      - application/json
      parameters:
      - in: query
        name: name
        description: ""
        required: true
        type: string
      responses:
        200:
          description: ""
  /ffxiv/latestJSONfiles/overview:
    get:
      operationId: "ffxiv.getLatestJSONnames"
      tags:
        - "FFXIV"
      summary: "Returns a list of all available translation files"
      description: ""
      parameters:
      - in: query
        name: reload
        description: To reload data if you think something is missing (takes a bit)
        required: false
        type: boolean
      responses:
        200:
          description: "Returns a list of translation files"
          schema:
            type: "array"
            items: {}
        400:
          description: "Returns when no categorie was found"
          schema:
            type: string
            items: {}
  /ffxiv/map/pos:
    get:
      operationId: "ffxiv.api_getCoordorPixelFromMap"
      tags:
        - "FFXIV"
      summary: ""
      description: ""
      produces:
      - application/json
      parameters:
      - in: query
        name: map_id
        description: ""
        required: true
        type: string
      - in: query
        name: x
        description: ""
        required: true
        type: number
      - in: query
        name: z
        description: ""
        required: true
        type: number
      - in: query
        name: pixel
        description: ""
        required: false
        type: boolean
      - in: query
        name: reload
        description: ""
        required: false
        type: boolean
      responses:
        200:
          description: ""
          schema:
            type: string
            items: {}
        400:
          description: ""
          schema:
            type: string
            items: {}

