veloren-serverbrowser-api 0.4.0

the format of the veloren serverbrowser, so it can be used by other tools
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Serverbrowser_v1_servers",
  "type": "object",
  "required": [
    "servers"
  ],
  "additionalProperties": false,
  "properties": {
    "servers": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/server"
      }
    }
  },
  "$defs": {
    "server": {
      "type": "object",
      "required": [
        "name",
        "address",
        "port",
        "description",
        "official",
        "auth_server"
      ],
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of The Server"
        },
        "address": {
          "type": "string",
          "description": "Hostname or IP of Server"
        },
        "port": {
          "type": "number",
          "description": "Port of the Server"
        },
        "location": {
          "type": "string",
          "description": "country_code location of the server"
        },
        "description": {
          "type": "string",
          "description": "Description of the Server"
        },
        "auth_server": {
          "type": "string",
          "description": "FQDN of auth server used"
        },
        "query_port": {
          "type": "integer",
          "description": "Port used for server info queries"
        },
        "channel": {
          "type": "string",
          "description": "channel of the Server"
        },
        "official": {
          "type": "boolean",
          "description": "is the gameserver officially hosted by the veloren developers"
        },
        "extra": {
          "type": "object",
          "additionalProperties": true,
          "propertyNames": {
            "pattern": "^[a-z][a-z_]*$"
          },
          "patternProperties": {
            "^.*": { "$ref": "#/$defs/extra" }
          },
          "description": "extra fields for the server in various formats"
        }
      }
    },
    "extra": {
      "type": "object",
      "required": [
        "name",
        "content"
      ],
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "description": "A human-readable suggested name"
        },
        "content": {
          "$ref": "#/$defs/extra-content",
          "description": "The content of the field."
        }
      }
    },
    "extra-content": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "url": {
          "type": "string",
          "description": "This field's content should be interpreted as a URL"
        },
        "text": {
          "type": "string",
          "description": "This field's content should be interpreted as human-readable plaintext"
        }
      },
      "oneOf": [
        {
          "type": "object",
          "required": ["url"]
        },
        {
          "type": "object",
          "required": ["text"]
        }
      ]
    }
  }
}