Skip to content

Commit af83978

Browse files
feba66Aeolun
feba66
and
Aeolun
authored
Next into main (#103)
* feat: documentation updates for 2.3 * feat: add module endpoints and other changes * fix: response type of registration endpoint * fix: hopefully proper formatting now * fix: nope, was still broken * fixed errors that openapi generator complained about --------- Co-authored-by: Bart Riepe <[email protected]>
1 parent 0c88bf6 commit af83978

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+604
-623
lines changed

‎.spectral.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
import ruleset from "https://stoplight.io/api/v1/projects/cHJqOjE3NTU4OQ/spectral.js?branch=main&token=e4f4ffbe-f8ad-4829-b09f-cf2703afac49";
2-
export default { extends: ruleset };
2+
export default {extends: ruleset};

‎.stoplight.json

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,11 @@
33
"formats": {
44
"openapi": {
55
"rootDir": "reference",
6-
"include": [
7-
"**"
8-
]
6+
"include": ["**"]
97
},
108
"json_schema": {
119
"rootDir": "models",
12-
"include": [
13-
"**"
14-
]
10+
"include": ["**"]
1511
},
1612
"markdown": {
1713
"rootDir": "docs"
@@ -20,4 +16,4 @@
2016
"rootDir": "assets/images"
2117
}
2218
}
23-
}
19+
}

‎models/ActivityLevel.json

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
{
22
"type": "string",
33
"description": "The activity level of a trade good. If the good is an import, this represents how strong consumption is. If the good is an export, this represents how strong the production is for the good. When activity is strong, consumption or production is near maximum capacity. When activity is weak, consumption or production is near minimum capacity.",
4-
"enum": [
5-
"WEAK",
6-
"GROWING",
7-
"STRONG",
8-
"RESTRICTED"
9-
],
4+
"enum": ["WEAK", "GROWING", "STRONG", "RESTRICTED"],
105
"x-enumDescriptions": {
116
"WEAK": "Indicates very low production or consumption activity. This may suggest a surplus in supply or a lack of demand.",
127
"GROWING": "Represents increasing activity in production or consumption, suggesting a developing market.",

‎models/Agent.json

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,5 @@
3333
"description": "How many ships are owned by the agent."
3434
}
3535
},
36-
"required": [
37-
"symbol",
38-
"headquarters",
39-
"credits",
40-
"startingFaction",
41-
"shipCount"
42-
]
36+
"required": ["symbol", "headquarters", "credits", "startingFaction", "shipCount"]
4337
}

‎models/Chart.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515
"description": "The time the chart for this waypoint was submitted."
1616
}
1717
}
18-
}
18+
}

‎models/ConnectedSystem.json

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,5 @@
3131
"description": "The distance of this system to the connected Jump Gate."
3232
}
3333
},
34-
"required": [
35-
"symbol",
36-
"sectorSymbol",
37-
"type",
38-
"x",
39-
"y",
40-
"distance"
41-
]
42-
}
34+
"required": ["symbol", "sectorSymbol", "type", "x", "y", "distance"]
35+
}

‎models/Construction.json

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,5 @@
1818
"description": "Whether the waypoint has been constructed."
1919
}
2020
},
21-
"required": [
22-
"symbol",
23-
"materials",
24-
"isComplete"
25-
]
26-
}
21+
"required": ["symbol", "materials", "isComplete"]
22+
}

‎models/ConstructionMaterial.json

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,5 @@
1414
"description": "The number of units fulfilled toward the required amount."
1515
}
1616
},
17-
"required": [
18-
"tradeSymbol",
19-
"required",
20-
"fulfilled"
21-
]
22-
}
17+
"required": ["tradeSymbol", "required", "fulfilled"]
18+
}

‎models/Contract.json

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,7 @@
1414
},
1515
"type": {
1616
"type": "string",
17-
"enum": [
18-
"PROCUREMENT",
19-
"TRANSPORT",
20-
"SHUTTLE"
21-
],
17+
"enum": ["PROCUREMENT", "TRANSPORT", "SHUTTLE"],
2218
"description": "Type of contract."
2319
},
2420
"terms": {
@@ -46,13 +42,5 @@
4642
"description": "The time at which the contract is no longer available to be accepted"
4743
}
4844
},
49-
"required": [
50-
"id",
51-
"factionSymbol",
52-
"type",
53-
"terms",
54-
"accepted",
55-
"fulfilled",
56-
"expiration"
57-
]
58-
}
45+
"required": ["id", "factionSymbol", "type", "terms", "accepted", "fulfilled", "expiration"]
46+
}

‎models/ContractDeliverGood.json

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,5 @@
2121
"description": "The number of units fulfilled on this contract."
2222
}
2323
},
24-
"required": [
25-
"tradeSymbol",
26-
"destinationSymbol",
27-
"unitsRequired",
28-
"unitsFulfilled"
29-
]
30-
}
24+
"required": ["tradeSymbol", "destinationSymbol", "unitsRequired", "unitsFulfilled"]
25+
}

‎models/ContractPayment.json

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,5 @@
1111
"description": "The amount of credits received when the contract is fulfilled."
1212
}
1313
},
14-
"required": [
15-
"onAccepted",
16-
"onFulfilled"
17-
]
18-
}
14+
"required": ["onAccepted", "onFulfilled"]
15+
}

‎models/ContractTerms.json

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,5 @@
1818
}
1919
}
2020
},
21-
"required": [
22-
"deadline",
23-
"payment"
24-
]
25-
}
21+
"required": ["deadline", "payment"]
22+
}

‎models/Cooldown.json

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,5 @@
2323
"description": "The date and time when the cooldown expires in ISO 8601 format"
2424
}
2525
},
26-
"required": [
27-
"shipSymbol",
28-
"totalSeconds",
29-
"remainingSeconds"
30-
]
31-
}
26+
"required": ["shipSymbol", "totalSeconds", "remainingSeconds"]
27+
}

‎models/Extraction.json

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,5 @@
1111
"$ref": "./ExtractionYield.json"
1212
}
1313
},
14-
"required": [
15-
"shipSymbol",
16-
"yield"
17-
]
18-
}
14+
"required": ["shipSymbol", "yield"]
15+
}

‎models/ExtractionYield.json

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,5 @@
1010
"description": "The number of units extracted that were placed into the ship's cargo hold."
1111
}
1212
},
13-
"required": [
14-
"symbol",
15-
"units"
16-
]
17-
}
13+
"required": ["symbol", "units"]
14+
}

‎models/Faction.json

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,5 @@
3232
"description": "Whether or not the faction is currently recruiting new agents."
3333
}
3434
},
35-
"required": [
36-
"symbol",
37-
"name",
38-
"description",
39-
"traits",
40-
"isRecruiting"
41-
]
42-
}
35+
"required": ["symbol", "name", "description", "traits", "isRecruiting"]
36+
}

‎models/FactionSymbol.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@
2323
"SHADOW",
2424
"ETHEREAL"
2525
]
26-
}
26+
}

‎models/FactionTrait.json

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,5 @@
1313
"description": "A description of the trait."
1414
}
1515
},
16-
"required": [
17-
"symbol",
18-
"name",
19-
"description"
20-
]
21-
}
16+
"required": ["symbol", "name", "description"]
17+
}

‎models/FactionTraitSymbol.json

Lines changed: 64 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,65 @@
11
{
2-
"type": "string",
3-
"description": "The unique identifier of the trait.",
4-
"enum": [
5-
"BUREAUCRATIC",
6-
"SECRETIVE",
7-
"CAPITALISTIC",
8-
"INDUSTRIOUS",
9-
"PEACEFUL",
10-
"DISTRUSTFUL",
11-
"WELCOMING",
12-
"SMUGGLERS",
13-
"SCAVENGERS",
14-
"REBELLIOUS",
15-
"EXILES",
16-
"PIRATES",
17-
"RAIDERS",
18-
"CLAN",
19-
"GUILD",
20-
"DOMINION",
21-
"FRINGE",
22-
"FORSAKEN",
23-
"ISOLATED",
24-
"LOCALIZED",
25-
"ESTABLISHED",
26-
"NOTABLE",
27-
"DOMINANT",
28-
"INESCAPABLE",
29-
"INNOVATIVE",
30-
"BOLD",
31-
"VISIONARY",
32-
"CURIOUS",
33-
"DARING",
34-
"EXPLORATORY",
35-
"RESOURCEFUL",
36-
"FLEXIBLE",
37-
"COOPERATIVE",
38-
"UNITED",
39-
"STRATEGIC",
40-
"INTELLIGENT",
41-
"RESEARCH_FOCUSED",
42-
"COLLABORATIVE",
43-
"PROGRESSIVE",
44-
"MILITARISTIC",
45-
"TECHNOLOGICALLY_ADVANCED",
46-
"AGGRESSIVE",
47-
"IMPERIALISTIC",
48-
"TREASURE_HUNTERS",
49-
"DEXTEROUS",
50-
"UNPREDICTABLE",
51-
"BRUTAL",
52-
"FLEETING",
53-
"ADAPTABLE",
54-
"SELF_SUFFICIENT",
55-
"DEFENSIVE",
56-
"PROUD",
57-
"DIVERSE",
58-
"INDEPENDENT",
59-
"SELF_INTERESTED",
60-
"FRAGMENTED",
61-
"COMMERCIAL",
62-
"FREE_MARKETS",
63-
"ENTREPRENEURIAL"
64-
]
65-
}
2+
"type": "string",
3+
"description": "The unique identifier of the trait.",
4+
"enum": [
5+
"BUREAUCRATIC",
6+
"SECRETIVE",
7+
"CAPITALISTIC",
8+
"INDUSTRIOUS",
9+
"PEACEFUL",
10+
"DISTRUSTFUL",
11+
"WELCOMING",
12+
"SMUGGLERS",
13+
"SCAVENGERS",
14+
"REBELLIOUS",
15+
"EXILES",
16+
"PIRATES",
17+
"RAIDERS",
18+
"CLAN",
19+
"GUILD",
20+
"DOMINION",
21+
"FRINGE",
22+
"FORSAKEN",
23+
"ISOLATED",
24+
"LOCALIZED",
25+
"ESTABLISHED",
26+
"NOTABLE",
27+
"DOMINANT",
28+
"INESCAPABLE",
29+
"INNOVATIVE",
30+
"BOLD",
31+
"VISIONARY",
32+
"CURIOUS",
33+
"DARING",
34+
"EXPLORATORY",
35+
"RESOURCEFUL",
36+
"FLEXIBLE",
37+
"COOPERATIVE",
38+
"UNITED",
39+
"STRATEGIC",
40+
"INTELLIGENT",
41+
"RESEARCH_FOCUSED",
42+
"COLLABORATIVE",
43+
"PROGRESSIVE",
44+
"MILITARISTIC",
45+
"TECHNOLOGICALLY_ADVANCED",
46+
"AGGRESSIVE",
47+
"IMPERIALISTIC",
48+
"TREASURE_HUNTERS",
49+
"DEXTEROUS",
50+
"UNPREDICTABLE",
51+
"BRUTAL",
52+
"FLEETING",
53+
"ADAPTABLE",
54+
"SELF_SUFFICIENT",
55+
"DEFENSIVE",
56+
"PROUD",
57+
"DIVERSE",
58+
"INDEPENDENT",
59+
"SELF_INTERESTED",
60+
"FRAGMENTED",
61+
"COMMERCIAL",
62+
"FREE_MARKETS",
63+
"ENTREPRENEURIAL"
64+
]
65+
}

‎models/JumpGate.json

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,5 @@
1414
}
1515
}
1616
},
17-
"required": [
18-
"symbol",
19-
"connections"
20-
]
21-
}
17+
"required": ["symbol", "connections"]
18+
}

0 commit comments

Comments
 (0)