# use this file to generate the swagger.json at https://editor.swagger.io/
# then update both this source and the necessary swagger.json file

openapi: 3.0.0
info:
  description:
    Use this documentation to navigate the available Atlas APIs
    <br>
    <h2>Recent Changes</h2>
    <h3>0.2.0</h3>
    Added `/realm/bg` endpoint<br>
    <h3>0.1.9</h3>
    Added `/relic` endpoint<br>
  version: 0.2.0
  title: AtlasAPI
  termsOfService: https://www.atlasfreeshard.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
tags:
  - name: stats
    description: Everything about server statistics
  - name: guild
    description: Everything about guilds
  - name: player
    description: Everything about players
  - name: realm
    description: Everything about keeps
  - name: relic
    description: Everything about relics
paths:
  /stats:
    get:
      tags:
        - stats
      summary: /stats
      description: Returns live population
      operationId: getStats
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/stats'
  /stats/rp:
    get:
      tags:
        - stats
      summary: /stats/rp
      description: Returns Top 10 RP holders <br><br>[cache 60 min]
      operationId: getStatsRP
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/allPlayers'
        '404':
          description: Not found
  /stats/uptime:
    get:
      tags:
        - stats
      summary: /stats/uptime
      description: Returns server uptime <br><br>[cache 30 sec]
      operationId: getUptime
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serverUptime'
  /guild/{guildName}:
    get:
      tags:
        - guild
      summary: /guild/{guildName}
      description: Returns a single guild <br><br>[cache 1 min]
      operationId: getGuildByName
      parameters:
        - name: guildName
          in: path
          description: Name of the guild to return
          required: true
          schema:
            type: string
            format: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/guild'
        '404':
          description: $guildName not found
  /guild/{guildName}/members:
    get:
      tags:
        - guild
      summary: /guild/{guildName}/members
      description: Returns all players in a guild <br><br>[cache 120 min]
      operationId: getPlayersByGuild
      parameters:
        - name: guildName
          in: path
          description: Name of the guild of which return players
          required: true
          schema:
            type: string
            format: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/allPlayers'
        '404':
          description: $guildName not found
  /guild/getAll:
    get:
      tags:
        - guild
      summary: /guild/getAll
      description: Returns all guilds<br><br>[cache 120 min]
      operationId: getAllGuilds
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/allGuilds'
  /guild/topRP:
    get:
      tags:
        - guild
      summary: /guild/topRP
      description: Returns Top 10 RP holders Guilds<br><br>[cache 120 min]
      operationId: getTopGuilds
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/allGuilds'
  /player/{playerName}:
    get:
      tags:
        - player
      summary: /player/{playerName}
      description: Returns a single player <br><br>[cache 1 min]
      operationId: getPlayerByName
      parameters:
        - name: playerName
          in: path
          description: Name of the player to return
          required: true
          schema:
            type: string
            format: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/player'
        '404':
          description: $playerName not found
  /player/getAll:
    get:
      tags:
        - player
      summary: /player/getAll
      description: Returns all players<br><br>[cache 120 min]
      operationId: getAllPlayers
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/allPlayers'
  /realm/{realmName}:
    get:
      tags:
        - realm
      summary: /realm/{realmName}
      description: Returns the Keep's status for a given Realm <br><br>[cache 1 min]
      operationId: getRealmStatus
      parameters:
        - name: realmName
          in: path
          description: Name of the Realm to return
          required: true
          schema:
            type: string
            format: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/realm'
        '404':
          description: Realm $realmName not found
  /realm/df:
    get:
      tags:
        - realm
      summary: /realm/df
      description: Returns the name of the Realm currently owning Darkness Falls access <br><br>[cache 1 min]
      operationId: getDFStatus
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/df'
        '404':
          description: Not found
  /realm/bg:
    get:
      tags:
        - realm
      summary: /realm/bg
      description: Returns the status of battle ground keeps <br><br>[cache 1 min]
      operationId: getBGStatus
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bgkeeps'
        '404':
          description: Not found
  /relic:
    get:
      tags:
        - relic
      summary: /relic
      description: Returns the status of all relics <br><br>[cache 1 min]
      operationId: getRelicStatus
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/relic'
        '404':
          description: Not found
servers:
  - url: https://api.atlasfreeshard.com/
components:
  schemas:
    allPlayers:
      type: array
      items:
        $ref: '#/components/schemas/player'
    allGuilds:
      type: array
      items:
        $ref: '#/components/schemas/guild'
    guild:
      type: object
      required:
        - Name
      properties:
        name:
          type: string
          example: Clan Cotswold
        realmID:
          type: integer
          example: 1
        realm:
          type: string
          example: Albion
          enum: [Albion, Midgard, Hibernia]
        emblem:
          type: integer
          example: 0
        realmPoints:
          type: integer
          example: 77845992
        bountyPoints:
          type: integer
          example: 24669
        members:
          type: integer
          example: 123
    player:
      type: object
      required:
        - Name
      properties:
        name:
          type: string
          example: Player
        lastname:
          type: string
          example: Lastname
        guild:
          type: string
          example: Atlas
        realm:
          type: string
          example: Hibernia
          enum: [Albion, Midgard, Hibernia, None]
        realmID:
          type: integer
          example: '3'
          enum:
            - 1
            - 2
            - 3
            - 0
        race:
          example: Lurikeen
          type: string
        raceID:
          example: 12
          type: integer
        class:
          example: Eldritch
          type: string
        classID:
          example: 40
          type: integer
        level:
          example: 50
          type: integer
        realmPoints:
          example: 91014
          type: integer
        realmRank:
          example: 3L2
          type: string
        killsAlbionPlayers:
          example: 198
          type: integer
        killsMidgardPlayers:
          example: 245
          type: integer
        killsHiberniaPlayers:
          example: 0
          type: integer
        killsAlbionDeathBlows:
          example: 39
          type: integer
        killsMidgardDeathBlows:
          example: 38
          type: integer
        killsHiberniaDeathBlows:
          example: 0
          type: integer
        killsAlbionSolo:
          example: 1
          type: integer
        killsMidgardSolo:
          example: 1
          type: integer
        killsHiberniaSolo:
          example: 0
          type: integer
        pvpDeaths:
          example: 549
          type: integer
    keep:
      type: object
      properties:
        Name:
          type: string
          example: Arvakr Faste
        originalRealm:
          type: string
          example: Midgard
          enum: [Albion, Midgard, Hibernia]
        currentRealm:
          type: string
          example: Albion
          enum: [Albion, Midgard, Hibernia, None]
        claimingGuild:
          type: string
          example: Cotswold Clan
        Level:
          type: integer
          example: 4
        underSiege:
          type: integer
          example: 0
          enum: [0, 1]
    bgkeep:
      type: object
      properties:
        Name:
          type: string
          example: Thidranki Faste
        currentRealm:
          type: string
          example: Albion
          enum: [Albion, Midgard, Hibernia, None]
        underSiege:
          type: integer
          example: 0
          enum: [0, 1]
    relic:
      type: object
      properties:
        Name:
          type: string
          example: Scabbard of Excalibur
        Type:
          type: string
          enum: [Strength, Magic]
        originalRealm:
          type: string
          enum: [Albion, Midgard, Hibernia]
        currentRealm:
          type: string
          example: Midgard
          enum: [Albion, Midgard, Hibernia]
    df:
      type: string
      enum: [Albion, Midgard, Hibernia]
      example: Midgard
    realm:
      type: array
      items:
        $ref: '#/components/schemas/keep'
    bgkeeps:
      type: array
      items:
        $ref: '#/components/schemas/bgkeep'
    serverUptime:
      type: object
      properties:
        seconds:
          type: integer
          example: 45
        minutes:
          type: integer
          example: 32
        hours:
          type: integer
          example: 13
        days:
          type: integer
          example: 4
        uptime:
          type: string
          example: 4d 13h 32m 45s
    stats:
      type: object
      properties:
        Albion:
          type: integer
          example: 159
        Midgard:
          type: integer
          example: 156
        Hibernia:
          type: integer
          example: 163
        Total:
          type: integer
          example: 478
        Timestamp:
          type: string
          format: date-time
          example: 08-12-2021 11:18 AM