142 lines
3.0 KiB
YAML
142 lines
3.0 KiB
YAML
basePath: /public-api/v1
|
|
definitions:
|
|
Error:
|
|
properties:
|
|
error:
|
|
type: string
|
|
type: object
|
|
Map:
|
|
properties:
|
|
asset_version:
|
|
type: integer
|
|
created_at:
|
|
type: string
|
|
creator:
|
|
type: string
|
|
date:
|
|
type: string
|
|
display_name:
|
|
type: string
|
|
game_id:
|
|
type: integer
|
|
id:
|
|
type: integer
|
|
load_count:
|
|
type: integer
|
|
modes:
|
|
type: integer
|
|
submitter:
|
|
type: integer
|
|
thumbnail:
|
|
type: integer
|
|
updated_at:
|
|
type: string
|
|
type: object
|
|
PagedResponse-Map:
|
|
properties:
|
|
data:
|
|
description: Data contains the actual response payload
|
|
items:
|
|
$ref: '#/definitions/Map'
|
|
type: array
|
|
pagination:
|
|
allOf:
|
|
- $ref: '#/definitions/Pagination'
|
|
description: Pagination contains information about paging
|
|
type: object
|
|
Pagination:
|
|
properties:
|
|
page:
|
|
description: Current page number
|
|
type: integer
|
|
page_size:
|
|
description: Number of items per page
|
|
type: integer
|
|
type: object
|
|
Response-Map:
|
|
properties:
|
|
data:
|
|
allOf:
|
|
- $ref: '#/definitions/Map'
|
|
description: Data contains the actual response payload
|
|
type: object
|
|
info:
|
|
contact: {}
|
|
description: |-
|
|
Obtain an api key at https://dev.strafes.net
|
|
Requires Maps:Read permission
|
|
title: StrafesNET Maps API
|
|
version: "1.0"
|
|
paths:
|
|
/map:
|
|
get:
|
|
description: Get a list of maps
|
|
parameters:
|
|
- default: 10
|
|
description: Page size (max 100)
|
|
in: query
|
|
maximum: 100
|
|
minimum: 1
|
|
name: page_size
|
|
type: integer
|
|
- default: 1
|
|
description: Page number
|
|
in: query
|
|
minimum: 1
|
|
name: page_number
|
|
type: integer
|
|
- in: query
|
|
name: game_id
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/PagedResponse-Map'
|
|
default:
|
|
description: General error response
|
|
schema:
|
|
$ref: '#/definitions/Error'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: List maps
|
|
tags:
|
|
- maps
|
|
/map/{id}:
|
|
get:
|
|
description: Get a specific map by its ID
|
|
parameters:
|
|
- description: Map ID
|
|
in: path
|
|
name: id
|
|
required: true
|
|
type: integer
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/Response-Map'
|
|
"404":
|
|
description: Map not found
|
|
schema:
|
|
$ref: '#/definitions/Error'
|
|
default:
|
|
description: General error response
|
|
schema:
|
|
$ref: '#/definitions/Error'
|
|
security:
|
|
- ApiKeyAuth: []
|
|
summary: Get map by ID
|
|
tags:
|
|
- maps
|
|
securityDefinitions:
|
|
ApiKeyAuth:
|
|
in: header
|
|
name: X-API-Key
|
|
type: apiKey
|
|
swagger: "2.0"
|