api-docs/models/Survey.json

45 lines
1.3 KiB
JSON
Raw Permalink Normal View History

2022-10-22 18:05:01 +02:00
{
"description": "A resource survey of a waypoint, detailing a specific extraction location and the types of resources that can be found there.",
"type": "object",
"properties": {
"signature": {
"type": "string",
"description": "A unique signature for the location of this survey. This signature is verified when attempting an extraction using this survey.",
"minLength": 1
},
2022-11-23 23:45:08 +01:00
"symbol": {
"type": "string",
"description": "The symbol of the waypoint that this survey is for.",
"minLength": 1
},
2022-10-22 18:05:01 +02:00
"deposits": {
"type": "array",
"description": "A list of deposits that can be found at this location.",
"items": {
"$ref": "./SurveyDeposit.json"
}
},
"expiration": {
"type": "string",
"format": "date-time",
"description": "The date and time when the survey expires. After this date and time, the survey will no longer be available for extraction.",
"minimum": 0
2022-12-20 06:23:20 +01:00
},
"size": {
"type": "string",
"description": "The size of the deposit. This value indicates how much can be extracted from the survey before it is exhausted.",
"enum": [
"SMALL",
"MODERATE",
"LARGE"
]
2022-10-22 18:05:01 +02:00
}
},
"required": [
"signature",
2022-11-23 23:45:08 +01:00
"symbol",
2022-10-22 18:05:01 +02:00
"deposits",
2022-12-20 06:23:20 +01:00
"expiration",
"size"
2022-10-22 18:05:01 +02:00
]
}