Skip to content

Commit 1fcc349

Browse files
committed
Add basic docs
1 parent fa6ddab commit 1fcc349

File tree

2 files changed

+27
-11
lines changed

2 files changed

+27
-11
lines changed

src/api/index.ts

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,14 @@ async function init(prettyPrint: boolean = false) {
108108
version: "1.0.0",
109109
},
110110
servers: [
111-
app.runEnvironment === "prod"
112-
? {
113-
url: "https://core.acm.illinois.edu",
114-
description: "Production API server",
115-
}
116-
: {
117-
url: "https://core.aws.qa.acmuiuc.org",
118-
description: "QA API server",
119-
},
111+
{
112+
url: "https://core.acm.illinois.edu",
113+
description: "Production API server",
114+
},
115+
{
116+
url: "https://core.aws.qa.acmuiuc.org",
117+
description: "QA API server",
118+
},
120119
],
121120
tags: [
122121
{
@@ -146,6 +145,24 @@ async function init(prettyPrint: boolean = false) {
146145
name: "Membership",
147146
description: "Purchasing or checking ACM @ UIUC membership.",
148147
},
148+
{
149+
name: "Tickets/Merchandise",
150+
description: "Handling the tickets and merchandise lifecycle.",
151+
},
152+
{
153+
name: "Mobile Wallet",
154+
description: "Issuing Apple/Google Wallet passes.",
155+
},
156+
{
157+
name: "Stripe",
158+
description:
159+
"Collecting payments for ACM @ UIUC invoices and other services.",
160+
},
161+
{
162+
name: "Room Requests",
163+
description:
164+
"Creating room reservation requests for ACM @ UIUC within University buildings.",
165+
},
149166
],
150167
openapi: "3.0.3" satisfies ZodOpenApiVersion, // If this is not specified, it will default to 3.1.0
151168
},

src/api/routes/mobileWallet.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,7 @@ const mobileWalletRoute: FastifyPluginAsync = async (fastify, _options) => {
4646
message: "Email must be on the illinois.edu domain.",
4747
path: ["email"],
4848
}),
49-
summary:
50-
"Retrieve mobile wallet passes for various ACM @ UIUC-issued tickets/services.",
49+
summary: "Email mobile wallet pass for ACM membership to user.",
5150
}),
5251
},
5352
async (request, reply) => {

0 commit comments

Comments
 (0)