Update token query schema definition

CCIP-App · Nov 23, 2023 · 4c38e6a · 4c38e6a
1 parent 61e66ee
commit 4c38e6a
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 10 deletions.
diff --git a/api/schema/token.ts b/api/schema/token.ts
@@ -1,4 +1,16 @@
 import { Query, Str } from '@cloudflare/itty-router-openapi'
 
-export const RequiredTokenQuery = Query(Str, { required: true })
-export const OptionalTokenQuery = Query(Str, { required: false })
+export const OptionalAttendeeTokenQuery = Query(Str, {
+  description: 'the attendee token',
+  required: false,
+})
+
+export const OptionalDelivererTokenQuery = Query(Str, {
+  description: 'the deliverer token',
+  required: false,
+})
+
+export const OptionalPublicTokenQuery = Query(Str, {
+  description: 'the attendee public token',
+  required: false,
+})
diff --git a/worker/controller/announcement.ts b/worker/controller/announcement.ts
@@ -48,7 +48,7 @@ export class ListAnnouncement extends OpenAPIRoute {
     summary: 'List announcements',
     tags: ['Announcement'],
     parameters: {
-      token: schema.OptionalTokenQuery,
+      token: schema.OptionalAttendeeTokenQuery,
     },
   }
 

diff --git a/worker/controller/landing.ts b/worker/controller/landing.ts
@@ -17,7 +17,7 @@ export class Landing extends OpenAPIRoute {
     summary: 'Get attendee display name',
     tags: ['Attendee'],
     parameters: {
-      token: schema.OptionalTokenQuery,
+      token: schema.OptionalAttendeeTokenQuery,
     },
   }
 

diff --git a/worker/controller/puzzleDeliverer.ts b/worker/controller/puzzleDeliverer.ts
@@ -36,7 +36,7 @@ export class GetPuzzleDeliverer extends OpenAPIRoute {
     summary: 'Check deliver name',
     tags: ['Puzzle'],
     parameters: {
-      token: schema.OptionalTokenQuery,
+      token: schema.OptionalDelivererTokenQuery,
     },
   }
 

diff --git a/worker/controller/puzzleDelivery.ts b/worker/controller/puzzleDelivery.ts
@@ -19,10 +19,10 @@ export class DeliverPuzzleToUser extends OpenAPIRoute {
     summary: 'Deliver puzzle to attendee',
     tags: ['Puzzle'],
     requestBody: {
-      receiver: new Str({ description: 'Attendee public token', required: false }),
+      receiver: new Str({ description: 'the attendee public token', required: false }),
     },
     parameters: {
-      token: schema.OptionalTokenQuery,
+      token: schema.OptionalDelivererTokenQuery,
     },
   }
 

diff --git a/worker/controller/puzzleStatus.ts b/worker/controller/puzzleStatus.ts
@@ -16,7 +16,7 @@ export class GetAttendeePuzzleStatus extends OpenAPIRoute {
     summary: 'Get attendee puzzle status',
     tags: ['Puzzle'],
     parameters: {
-      token: schema.OptionalTokenQuery,
+      token: schema.OptionalPublicTokenQuery,
     },
   }
 

diff --git a/worker/controller/status.ts b/worker/controller/status.ts
@@ -39,7 +39,7 @@ export class GetStatus extends OpenAPIRoute {
     tags: ['Attendee'],
     parameters: {
       StaffQuery: Query(Bool, { description: 'is query by staff', required: false }),
-      token: schema.OptionalTokenQuery,
+      token: schema.OptionalAttendeeTokenQuery,
     },
   }
 

diff --git a/worker/controller/use.ts b/worker/controller/use.ts
@@ -38,7 +38,7 @@ export class ApplyScenario extends OpenAPIRoute {
     summary: 'Use scenario',
     tags: ['Event'],
     parameters: {
-      token: schema.OptionalTokenQuery,
+      token: schema.OptionalAttendeeTokenQuery,
       scenarioId: schema.ScenarioIdPath,
     },
   }