spacetraders/api-docs
1
0
Fork 0
mirror of https://github.com/SpaceTradersAPI/api-docs.git synced 2024-11-14 22:30:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

add enum for symbols

Browse Source
This commit is contained in:
Space Admiral 2022-12-04 08:38:00 -08:00
parent 15ae4a2ce6
commit eac54a6f69
14 changed files with 256 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
models/FactionTrait.json
View File

@ -35,7 +35,42 @@
"ESTABLISHED",
"NOTABLE",
"DOMINANT",
"INESCAPABLE"
"INESCAPABLE",
"INNOVATIVE",
"BOLD",
"VISIONARY",
"CURIOUS",
"DARING",
"EXPLORATORY",
"RESOURCEFUL",
"FLEXIBLE",
"COOPERATIVE",
"UNITED",
"STRATEGIC",
"INTELLIGENT",
"RESEARCH_FOCUSED",
"COLLABORATIVE",
"PROGRESSIVE",
"MILITARISTIC",
"TECHNOLOGICALLY_ADVANCED",
"AGGRESSIVE",
"IMPERIALISTIC",
"TREASURE_HUNTERS",
"DEXTEROUS",
"UNPREDICTABLE",
"BRUTAL",
"FLEETING",
"ADAPTABLE",
"SELF_SUFFICIENT",
"DEFENSIVE",
"PROUD",
"DIVERSE",
"INDEPENDENT",
"SELF_INTERESTED",
"FRAGMENTED",
"COMMERCIAL",
"FREE_MARKETS",
"ENTREPRENEURIAL"
]
},
"name": {

5
models/ShipCargoItem.json
View File

@ -10,6 +10,10 @@
"type": "string",
"description": "The name of the cargo item type."
},
"description": {
"type": "string",
"description": "The description of the cargo item type."
},
"units": {
"type": "integer",
"description": "The number of units of the cargo item.",
@ -19,6 +23,7 @@
"required": [
"symbol",
"name",
"description",
"units"
]
}

11
models/ShipEngine.json
View File

@ -5,15 +5,18 @@
"symbol": {
"type": "string",
"enum": [
"IMPULSE_DRIVE",
"ION_DRIVE_I",
"ION_DRIVE_II",
"HYPER_DRIVE"
"ENGINE_IMPULSE_DRIVE",
"ENGINE_ION_DRIVE_I",
"ENGINE_ION_DRIVE_II",
"ENGINE_HYPER_DRIVE"
]
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"condition": {
"$ref": "./ShipCondition.json"
},

4
models/ShipFrame.json
View File

@ -5,6 +5,7 @@
"symbol": {
"type": "string",
"enum": [
"FRAME_PROBE",
"FRAME_DRONE",
"FRAME_INTERCEPTOR",
"FRAME_RACER",
@ -23,6 +24,9 @@
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"condition": {
"$ref": "./ShipCondition.json"
},

14
models/ShipModule.json
View File

@ -5,20 +5,26 @@
"symbol": {
"type": "string",
"enum": [
"MODULE_PASSENGER_CABIN",
"MODULE_ENVOY_QUARTERS",
"MODULE_MICRO_REFINERY",
"MODULE_MINERAL_PROCESSOR",
"MODULE_CARGO_HOLD",
"MODULE_CREW_QUARTERS",
"MODULE_ENVOY_QUARTERS",
"MODULE_PASSENGER_CABIN",
"MODULE_MICRO_REFINERY",
"MODULE_SCIENCE_LAB",
"MODULE_JUMP_DRIVE_I",
"MODULE_JUMP_DRIVE_II",
"MODULE_JUMP_DRIVE_III",
"MODULE_CREW_QUARTERS"
"MODULE_SHIELD_GENERATOR_I",
"MODULE_SHIELD_GENERATOR_II"
]
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"requirements": {
"$ref": "./ShipRequirements.json"
}

8
models/ShipMount.json
View File

@ -13,12 +13,18 @@
"MOUNT_SENSOR_ARRAY_III",
"MOUNT_MINING_LASER_I",
"MOUNT_MINING_LASER_II",
"MOUNT_MINING_LASER_III"
"MOUNT_MINING_LASER_III",
"MOUNT_LASER_CANNON_I",
"MOUNT_MISSILE_LAUNCHER_I",
"MOUNT_TURRET_I"
]
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"requirements": {
"$ref": "./ShipRequirements.json"
}

13
models/ShipReactor.json
View File

@ -5,16 +5,19 @@
"symbol": {
"type": "string",
"enum": [
"SOLAR_REACTOR",
"FUSION_REACTOR",
"FISSION_REACTOR",
"CHEMICAL_REACTOR",
"DARK_MATTER_REACTOR"
"REACTOR_SOLAR_I",
"REACTOR_FUSION_I",
"REACTOR_FISSION_I",
"REACTOR_CHEMICAL_I",
"REACTOR_ANTIMATTER_I"
]
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"condition": {
"$ref": "./ShipCondition.json"
},

15
models/ShipRole.json
View File

@ -1,17 +1,4 @@
{
"type": "string",
"description": "The registered role of the ship",
"enum": [
"FABRICATOR",
"HARVESTER",
"HAULER",
"EXCAVATOR",
"TRANSPORT",
"REPAIR",
"SURVEYOR",
"COMMAND",
"CARRIER",
"PATROL",
"SATELLITE"
]
"description": "The registered role of the ship"
}

20
models/ShipyardShip.json
View File

@ -4,7 +4,23 @@
"properties": {
"symbol": {
"type": "string",
"minLength": 1
"enum": [
"SHIP_PROBE_SATELLITE",
"SHIP_MINING_DRONE",
"SHIP_INTERCEPTOR",
"SHIP_LIGHT_HAULER",
"SHIP_COMMAND_FRIGATE",
"SHIP_EXPLORER",
"SHIP_HEAVY_FREIGHTER",
"SHIP_LIGHT_SHUTTLE",
"SHIP_ORE_HOUND"
]
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"purchasePrice": {
"type": "integer"
@ -33,6 +49,8 @@
},
"required": [
"symbol",
"name",
"description",
"purchasePrice",
"frame",
"reactor",

14
models/System.json
View File

@ -11,19 +11,7 @@
"minLength": 1
},
"type": {
"type": "string",
"enum": [
"NEUTRON_STAR",
"RED_STAR",
"ORANGE_STAR",
"BLUE_STAR",
"YOUNG_STAR",
"WHITE_DWARF",
"BLACK_HOLE",
"HYPERGIANT",
"NEBULA",
"UNSTABLE"
]
"$ref": "./SystemType.json"
},
"x": {
"type": "integer"

16
models/SystemType.json Normal file
View File

@ -0,0 +1,16 @@
{
"type": "string",
"description": "The type of waypoint.",
"enum": [
"NEUTRON_STAR",
"RED_STAR",
"ORANGE_STAR",
"BLUE_STAR",
"YOUNG_STAR",
"WHITE_DWARF",
"BLACK_HOLE",
"HYPERGIANT",
"NEBULA",
"UNSTABLE"
]
}

134
models/TradeGood.json Normal file
View File

@ -0,0 +1,134 @@
{
"symbol": {
"type": "string",
"enum": [
"PRECIOUS_STONES",
"QUARTZ_SAND",
"SILICON_CRYSTALS",
"AMMONIA_ICE",
"LIQUID_HYDROGEN",
"LIQUID_NITROGEN",
"ICE_WATER",
"EXOTIC_MATTER",
"ADVANCED_CIRCUITRY",
"GRAVITON_EMITTERS",
"IRON",
"IRON_ORE",
"COPPER",
"COPPER_ORE",
"ALUMINUM",
"ALUMINUM_ORE",
"SILVER",
"SILVER_ORE",
"GOLD",
"GOLD_ORE",
"PLATINUM",
"PLATINUM_ORE",
"DIAMONDS",
"URANITE",
"URANITE_ORE",
"MERITIUM",
"MERITIUM_ORE",
"HYDROCARBON",
"ANTIMATTER",
"FERTILIZERS",
"FABRICS",
"FOOD",
"JEWELRY",
"MACHINERY",
"FIREARMS",
"ASSAULT_RIFLES",
"MILITARY_EQUIPMENT",
"EXPLOSIVES",
"LAB_INSTRUMENTS",
"AMMUNITION",
"ELECTRONICS",
"SHIP_PLATING",
"EQUIPMENT",
"FUEL",
"MEDICINE",
"DRUGS",
"CLOTHING",
"MICROPROCESSORS",
"PLASTICS",
"POLYNUCLEOTIDES",
"BIOCOMPOSITES",
"NANOBOTS",
"AI_MAINFRAMES",
"QUANTUM_DRIVES",
"ROBOTIC_DRONES",
"CYBER_IMPLANTS",
"GENE_THERAPEUTICS",
"NEURAL_CHIPS",
"MOOD_REGULATORS",
"VIRAL_AGENTS",
"MICRO_FUSION_GENERATORS",
"SUPERGRAINS",
"LASER_RIFLES",
"HOLOGRAPHICS",
"SHIP_SALVAGE",
"RELIC_TECH",
"NOVEL_LIFEFORMS",
"BOTANICAL_SPECIMENS",
"CULTURAL_ARTIFACTS",
"FRAME_PROBE",
"FRAME_DRONE",
"FRAME_INTERCEPTOR",
"FRAME_RACER",
"FRAME_FIGHTER",
"FRAME_FRIGATE",
"FRAME_SHUTTLE",
"FRAME_EXPLORER",
"FRAME_LIGHT_FREIGHTER",
"FRAME_HEAVY_FREIGHTER",
"FRAME_TRANSPORT",
"FRAME_DESTROYER",
"FRAME_CRUISER",
"FRAME_CARRIER",
"REACTOR_SOLAR_I",
"REACTOR_FUSION_I",
"REACTOR_FISSION_I",
"REACTOR_CHEMICAL_I",
"REACTOR_ANTIMATTER_I",
"ENGINE_IMPULSE_DRIVE",
"ENGINE_ION_DRIVE_I",
"ENGINE_ION_DRIVE_II",
"ENGINE_HYPER_DRIVE",
"MODULE_MINERAL_PROCESSOR",
"MODULE_CARGO_HOLD",
"MODULE_CREW_QUARTERS",
"MODULE_ENVOY_QUARTERS",
"MODULE_PASSENGER_CABIN",
"MODULE_MICRO_REFINERY",
"MODULE_SCIENCE_LAB",
"MODULE_JUMP_DRIVE_I",
"MODULE_JUMP_DRIVE_II",
"MODULE_JUMP_DRIVE_III",
"MODULE_SHIELD_GENERATOR_I",
"MODULE_SHIELD_GENERATOR_II",
"MOUNT_GAS_SIPHON_I",
"MOUNT_GAS_SIPHON_II",
"MOUNT_GAS_SIPHON_III",
"MOUNT_SENSOR_ARRAY_I",
"MOUNT_SENSOR_ARRAY_II",
"MOUNT_SENSOR_ARRAY_III",
"MOUNT_MINING_LASER_I",
"MOUNT_MINING_LASER_II",
"MOUNT_MINING_LASER_III",
"MOUNT_LASER_CANNON_I",
"MOUNT_MISSILE_LAUNCHER_I",
"MOUNT_TURRET_I"
]
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"required": [
"symbol",
"name",
"description"
]
}

7
models/WaypointTrait.json
View File

@ -6,6 +6,8 @@
"description": "The unique identifier of the trait.",
"enum": [
"UNCHARTED",
"MARKETPLACE",
"SHIPYARD",
"OUTPOST",
"SCATTERED_SETTLEMENTS",
"SPRAWLING_CITIES",
@ -28,6 +30,7 @@
"METHANE_POOLS",
"ICE_CRYSTALS",
"EXPLOSIVE_GASES",
"STRONG_MAGNETOSPHERE",
"VIBRANT_AURORAS",
"SALT_FLATS",
"CANYONS",
@ -39,6 +42,9 @@
"ASH_CLOUDS",
"VAST_RUINS",
"MUTATED_FLORA",
"TERRAFORMED",
"EXTREME_TEMPERATURES",
"EXTREME_PRESSURE",
"DIVERSE_LIFE",
"SCARCE_LIFE",
"FOSSILS",
@ -48,7 +54,6 @@
"TOXIC_ATMOSPHERE",
"CORROSIVE_ATMOSPHERE",
"BREATHABLE_ATMOSPHERE",
"COMM_RELAY_I",
"JOVIAN",
"ROCKY",
"VOLCANIC",

4
models/WaypointType.json
View File

@ -8,8 +8,8 @@
"ORBITAL_STATION",
"JUMP_GATE",
"ASTEROID_FIELD",
"NEBULA",
"DEBRIS_FIELD",
"GRAVITY_WELL",
"NEBULA"
"GRAVITY_WELL"
]
}