api-ranking-jogos/.scribe/endpoints/00.yaml

name: Rankings
description: ''
endpoints:
  -
    custom: []
    httpMethods:
      - GET
    uri: api/v1/rankings/weekly
    metadata:
      custom: []
      groupName: Rankings
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: 'Top semanal'
      description: 'Retorna o ranking dos jogos com melhor desempenho na última semana.'
      authenticated: true
      deprecated: false
    headers:
      Authorization: 'Bearer {YOUR_JWT_TOKEN}'
      Content-Type: application/json
      Accept: application/json
    urlParameters: []
    cleanUrlParameters: []
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters: []
    cleanBodyParameters: []
    fileParameters: []
    responses:
      -
        custom: []
        status: 401
        content: '{"message":"Invalid or expired token"}'
        headers:
          cache-control: 'no-cache, private'
          content-type: application/json
          x-ratelimit-limit: '60'
          x-ratelimit-remaining: '54'
          access-control-allow-origin: '*'
        description: null
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer 6g43cv8PD1aE5beadkZfhV6'
    controller: null
    method: null
    route: null
  -
    custom: []
    httpMethods:
      - GET
    uri: api/v1/rankings/monthly
    metadata:
      custom: []
      groupName: Rankings
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: 'Top mensal'
      description: 'Retorna o ranking dos jogos com melhor desempenho no último mês.'
      authenticated: true
      deprecated: false
    headers:
      Authorization: 'Bearer {YOUR_JWT_TOKEN}'
      Content-Type: application/json
      Accept: application/json
    urlParameters: []
    cleanUrlParameters: []
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters: []
    cleanBodyParameters: []
    fileParameters: []
    responses:
      -
        custom: []
        status: 401
        content: '{"message":"Invalid or expired token"}'
        headers:
          cache-control: 'no-cache, private'
          content-type: application/json
          x-ratelimit-limit: '60'
          x-ratelimit-remaining: '53'
          access-control-allow-origin: '*'
        description: null
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer 6g43cv8PD1aE5beadkZfhV6'
    controller: null
    method: null
    route: null
  -
    custom: []
    httpMethods:
      - GET
    uri: api/v1/rankings/yearly
    metadata:
      custom: []
      groupName: Rankings
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: 'Top anual'
      description: 'Retorna o ranking dos jogos com melhor desempenho no último ano.'
      authenticated: true
      deprecated: false
    headers:
      Authorization: 'Bearer {YOUR_JWT_TOKEN}'
      Content-Type: application/json
      Accept: application/json
    urlParameters: []
    cleanUrlParameters: []
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters: []
    cleanBodyParameters: []
    fileParameters: []
    responses:
      -
        custom: []
        status: 401
        content: '{"message":"Invalid or expired token"}'
        headers:
          cache-control: 'no-cache, private'
          content-type: application/json
          x-ratelimit-limit: '60'
          x-ratelimit-remaining: '52'
          access-control-allow-origin: '*'
        description: null
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer 6g43cv8PD1aE5beadkZfhV6'
    controller: null
    method: null
    route: null
  -
    custom: []
    httpMethods:
      - GET
    uri: 'api/v1/rankings/history/{id}'
    metadata:
      custom: []
      groupName: Rankings
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: 'Histórico de ranking'
      description: 'Retorna a evolução de um jogo específico ao longo do tempo.'
      authenticated: true
      deprecated: false
    headers:
      Authorization: 'Bearer {YOUR_JWT_TOKEN}'
      Content-Type: application/json
      Accept: application/json
    urlParameters:
      id:
        custom: []
        name: id
        description: 'O ID do jogo.'
        required: true
        example: 1
        type: integer
        enumValues: []
        exampleWasSpecified: true
        nullable: false
        deprecated: false
    cleanUrlParameters:
      id: 1
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters: []
    cleanBodyParameters: []
    fileParameters: []
    responses:
      -
        custom: []
        status: 401
        content: '{"message":"Invalid or expired token"}'
        headers:
          cache-control: 'no-cache, private'
          content-type: application/json
          x-ratelimit-limit: '60'
          x-ratelimit-remaining: '51'
          access-control-allow-origin: '*'
        description: null
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer 6g43cv8PD1aE5beadkZfhV6'
    controller: null
    method: null
    route: null
  -
    custom: []
    httpMethods:
      - GET
    uri: api/v1/games/most-played
    metadata:
      custom: []
      groupName: Rankings
      groupDescription: ''
      subgroup: ''
      subgroupDescription: ''
      title: 'Jogos mais jogados'
      description: 'Retorna o top 10 jogos com base no número de jogadores ativos.'
      authenticated: true
      deprecated: false
    headers:
      Authorization: 'Bearer {YOUR_JWT_TOKEN}'
      Content-Type: application/json
      Accept: application/json
    urlParameters: []
    cleanUrlParameters: []
    queryParameters: []
    cleanQueryParameters: []
    bodyParameters: []
    cleanBodyParameters: []
    fileParameters: []
    responses:
      -
        custom: []
        status: 401
        content: '{"message":"Invalid or expired token"}'
        headers:
          cache-control: 'no-cache, private'
          content-type: application/json
          x-ratelimit-limit: '60'
          x-ratelimit-remaining: '50'
          access-control-allow-origin: '*'
        description: null
    responseFields: []
    auth:
      - headers
      - Authorization
      - 'Bearer 6g43cv8PD1aE5beadkZfhV6'
    controller: null
    method: null
    route: null