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

Normalize some schema.

Browse Source
This commit is contained in:
Keith Jackson 2023-11-05 02:27:27 -08:00
parent d19defe480
commit 7a677b5b2b
9 changed files with 147 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
models/Faction.json
View File

@ -3,7 +3,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"symbol": { "symbol": {
"$ref": "./FactionSymbols.json", "$ref": "./FactionSymbol.json",
"description": "Faction symbol." "description": "Faction symbol."
}, },
"name": { "name": {

0
models/FactionSymbols.json → models/FactionSymbol.json
View File

64
models/FactionTrait.json
View File

@ -2,69 +2,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"symbol": { "symbol": {
"type": "string", "$ref": "./FactionTraitSymbol.json"
"description": "The unique identifier of the trait.",
"enum": [
"BUREAUCRATIC",
"SECRETIVE",
"CAPITALISTIC",
"INDUSTRIOUS",
"PEACEFUL",
"DISTRUSTFUL",
"WELCOMING",
"SMUGGLERS",
"SCAVENGERS",
"REBELLIOUS",
"EXILES",
"PIRATES",
"RAIDERS",
"CLAN",
"GUILD",
"DOMINION",
"FRINGE",
"FORSAKEN",
"ISOLATED",
"LOCALIZED",
"ESTABLISHED",
"NOTABLE",
"DOMINANT",
"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": { "name": {
"type": "string", "type": "string",

65
models/FactionTraitSymbol.json Normal file
View File

@ -0,0 +1,65 @@
{
"type": "string",
"description": "The unique identifier of the trait.",
"enum": [
"BUREAUCRATIC",
"SECRETIVE",
"CAPITALISTIC",
"INDUSTRIOUS",
"PEACEFUL",
"DISTRUSTFUL",
"WELCOMING",
"SMUGGLERS",
"SCAVENGERS",
"REBELLIOUS",
"EXILES",
"PIRATES",
"RAIDERS",
"CLAN",
"GUILD",
"DOMINION",
"FRINGE",
"FORSAKEN",
"ISOLATED",
"LOCALIZED",
"ESTABLISHED",
"NOTABLE",
"DOMINANT",
"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"
]
}

2
models/SystemFaction.json
View File

@ -2,7 +2,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"symbol": { "symbol": {
"$ref": "./FactionSymbols.json" "$ref": "./FactionSymbol.json"
} }
}, },
"required": [ "required": [

2
models/WaypointFaction.json
View File

@ -3,7 +3,7 @@
"description": "The faction that controls the waypoint.", "description": "The faction that controls the waypoint.",
"properties": { "properties": {
"symbol": { "symbol": {
"$ref": "./FactionSymbols.json" "$ref": "./FactionSymbol.json"
} }
}, },
"required": [ "required": [

73
models/WaypointTrait.json
View File

@ -2,78 +2,7 @@
"type": "object", "type": "object",
"properties": { "properties": {
"symbol": { "symbol": {
"type": "string", "$ref": "./WaypointTraitSymbol.json"
"description": "The unique identifier of the trait.",
"enum": [
"UNCHARTED",
"UNDER_CONSTRUCTION",
"MARKETPLACE",
"SHIPYARD",
"OUTPOST",
"SCATTERED_SETTLEMENTS",
"SPRAWLING_CITIES",
"MEGA_STRUCTURES",
"OVERCROWDED",
"HIGH_TECH",
"CORRUPT",
"BUREAUCRATIC",
"TRADING_HUB",
"INDUSTRIAL",
"BLACK_MARKET",
"RESEARCH_FACILITY",
"MILITARY_BASE",
"SURVEILLANCE_OUTPOST",
"EXPLORATION_OUTPOST",
"MINERAL_DEPOSITS",
"COMMON_METAL_DEPOSITS",
"PRECIOUS_METAL_DEPOSITS",
"RARE_METAL_DEPOSITS",
"METHANE_POOLS",
"ICE_CRYSTALS",
"EXPLOSIVE_GASES",
"STRONG_MAGNETOSPHERE",
"VIBRANT_AURORAS",
"SALT_FLATS",
"CANYONS",
"PERPETUAL_DAYLIGHT",
"PERPETUAL_OVERCAST",
"DRY_SEABEDS",
"MAGMA_SEAS",
"SUPERVOLCANOES",
"ASH_CLOUDS",
"VAST_RUINS",
"MUTATED_FLORA",
"TERRAFORMED",
"EXTREME_TEMPERATURES",
"EXTREME_PRESSURE",
"DIVERSE_LIFE",
"SCARCE_LIFE",
"FOSSILS",
"WEAK_GRAVITY",
"STRONG_GRAVITY",
"CRUSHING_GRAVITY",
"TOXIC_ATMOSPHERE",
"CORROSIVE_ATMOSPHERE",
"BREATHABLE_ATMOSPHERE",
"THIN_ATMOSPHERE",
"JOVIAN",
"ROCKY",
"VOLCANIC",
"FROZEN",
"SWAMP",
"BARREN",
"TEMPERATE",
"JUNGLE",
"OCEAN",
"RADIOACTIVE",
"MICRO_GRAVITY_ANOMALIES",
"DEBRIS_CLUSTER",
"DEEP_CRATERS",
"SHALLOW_CRATERS",
"UNSTABLE_COMPOSITION",
"HOLLOWED_INTERIOR",
"STRIPPED"
]
}, },
"name": { "name": {
"type": "string", "type": "string",

74
models/WaypointTraitSymbol.json Normal file
View File

@ -0,0 +1,74 @@
{
"type": "string",
"description": "The unique identifier of the trait.",
"enum": [
"UNCHARTED",
"UNDER_CONSTRUCTION",
"MARKETPLACE",
"SHIPYARD",
"OUTPOST",
"SCATTERED_SETTLEMENTS",
"SPRAWLING_CITIES",
"MEGA_STRUCTURES",
"OVERCROWDED",
"HIGH_TECH",
"CORRUPT",
"BUREAUCRATIC",
"TRADING_HUB",
"INDUSTRIAL",
"BLACK_MARKET",
"RESEARCH_FACILITY",
"MILITARY_BASE",
"SURVEILLANCE_OUTPOST",
"EXPLORATION_OUTPOST",
"MINERAL_DEPOSITS",
"COMMON_METAL_DEPOSITS",
"PRECIOUS_METAL_DEPOSITS",
"RARE_METAL_DEPOSITS",
"METHANE_POOLS",
"ICE_CRYSTALS",
"EXPLOSIVE_GASES",
"STRONG_MAGNETOSPHERE",
"VIBRANT_AURORAS",
"SALT_FLATS",
"CANYONS",
"PERPETUAL_DAYLIGHT",
"PERPETUAL_OVERCAST",
"DRY_SEABEDS",
"MAGMA_SEAS",
"SUPERVOLCANOES",
"ASH_CLOUDS",
"VAST_RUINS",
"MUTATED_FLORA",
"TERRAFORMED",
"EXTREME_TEMPERATURES",
"EXTREME_PRESSURE",
"DIVERSE_LIFE",
"SCARCE_LIFE",
"FOSSILS",
"WEAK_GRAVITY",
"STRONG_GRAVITY",
"CRUSHING_GRAVITY",
"TOXIC_ATMOSPHERE",
"CORROSIVE_ATMOSPHERE",
"BREATHABLE_ATMOSPHERE",
"THIN_ATMOSPHERE",
"JOVIAN",
"ROCKY",
"VOLCANIC",
"FROZEN",
"SWAMP",
"BARREN",
"TEMPERATE",
"JUNGLE",
"OCEAN",
"RADIOACTIVE",
"MICRO_GRAVITY_ANOMALIES",
"DEBRIS_CLUSTER",
"DEEP_CRATERS",
"SHALLOW_CRATERS",
"UNSTABLE_COMPOSITION",
"HOLLOWED_INTERIOR",
"STRIPPED"
]
}

6
reference/SpaceTraders.json
View File

@ -254,7 +254,7 @@
"schema": { "schema": {
"properties": { "properties": {
"faction": { "faction": {
"$ref": "../models/FactionSymbols.json", "$ref": "../models/FactionSymbol.json",
"example": "COSMIC" "example": "COSMIC"
}, },
"symbol": { "symbol": {
@ -518,12 +518,12 @@
"schema": { "schema": {
"oneOf": [ "oneOf": [
{ {
"$ref": "../models/WaypointTrait.json#/properties/symbol" "$ref": "../models/WaypointTraitSymbol.json"
}, },
{ {
"type": "array", "type": "array",
"items": { "items": {
"$ref": "../models/WaypointTrait.json#/properties/symbol" "$ref": "../models/WaypointTraitSymbol.json"
} }
} }
] ]