Merge pull request #55 from NYCU-SDC/feat/CORE-200-add-oauth-connect-api

[CORE-200] Add Oauth Connect Qestion API

Author: YukinaMochizuki

src/forms/models.tsp

@@ -184,7 +184,7 @@ namespace CoreSystem.Forms {
 		@doc("File upload")
 		uploadFile: "UPLOAD_FILE",
 
-		@doc("Linear scale/rating (1-5, 1-10, etc.)")
+		@doc("Linear scale/rating (0-10 or 1-10, etc.)")
 		linearScale: "LINEAR_SCALE",
 
 		@doc("Rating (e.g., star rating)")
@@ -303,10 +303,10 @@ namespace CoreSystem.Forms {
 		@doc("Background icon for the linear scale option.")
 		icon?: string;
 
-		@doc("Minimum value of the linear scale.")
+		@doc("Minimum value of the linear scale, can be 0 or 1.")
 		minVal: int32;
 
-		@doc("Maximum value of the linear scale.")
+		@doc("Maximum value of the linear scale, can be between 2 and 10.")
 		maxVal: int32;
 
 		@doc("Label for the minimum value.")

src/responses/models.tsp

@@ -41,38 +41,17 @@ namespace CoreSystem.Responses {
 		value: int32;
 	}
 
-	@example(#{
-		questionId: "2b2bc4f4-71c1-478b-9e36-516eac6b36c3",
-		questionType: CoreSystem.Forms.QuestionTypes.oauthConnect,
-		provider: CoreSystem.Auth.OAuthProviders.google,
-		callback: "https://example.com/oauth/callback",
-	})
-	@doc("Request model for initiating an OAuth answer")
-	model OauthAnswerRequest {
+	@example(#{ questionId: "2b2bc4f4-71c1-478b-9e36-516eac6b36c3", questionType: CoreSystem.Forms.QuestionTypes.oauthConnect, avatarUrl: "https://example.com/avatar.jpg", username: "JohnDoe" })
+	@doc("Response model for an OAuth answer")
+	model OauthAnswerJSON {
 		@doc("The question being answered.")
 		questionId: uuid;
 
 		@doc("The type of the question being answered.")
 		questionType: CoreSystem.Forms.QuestionTypes.oauthConnect;
 
-		@doc("The OAuth provider to use.")
-		provider: CoreSystem.Auth.OAuthProviders;
-
-		@doc("The callback URL for the OAuth flow.")
-		callback: string;
-
-		@doc("The redirect URL after OAuth completion.")
-		redirect?: string;
-	}
-
-	@example(#{ questionId: "2b2bc4f4-71c1-478b-9e36-516eac6b36c3", avatar_url: "https://example.com/avatar.jpg", username: "JohnDoe" })
-	@doc("Response model for an OAuth answer")
-	model OauthAnswerJSON {
-		@doc("The question being answered.")
-		questionId: uuid;
-
 		@doc("The avatar URL from the OAuth provider.")
-		avatar_url: string;
+		avatarUrl: string;
 
 		@doc("The username from the OAuth provider.")
 		username: string;
@@ -83,17 +62,11 @@ namespace CoreSystem.Responses {
 		answers: #[
 			#{ questionId: "ee894524-4bd8-4a64-8fd2-a53b39ca94cd", questionType: CoreSystem.Forms.QuestionTypes.shortText, value: #["John Doe"] },
 			#{ questionId: "2b2bc4f4-71c1-478b-9e36-516eac6b36c3", questionType: CoreSystem.Forms.QuestionTypes.linearScale, value: 4 },
-			#{
-				questionId: "3c3cd5f5-82d2-589c-af47-627fbd7c47d4",
-				questionType: CoreSystem.Forms.QuestionTypes.oauthConnect,
-				provider: CoreSystem.Auth.OAuthProviders.google,
-				callback: "https://example.com/oauth/callback",
-			}
 		],
 	})
 	model AnswersRequest {
 		@doc("The answers to be saved. Can contain a partial subset for drafts or the full set for submission.")
-		answers: (AnswerJSON | ScaleAnswerJSON | OauthAnswerRequest)[];
+		answers: (AnswerJSON | ScaleAnswerJSON)[];
 	}
 
 	@doc("Request model for uploading files as answers to a specific question in a response.")
@@ -114,6 +87,18 @@ namespace CoreSystem.Responses {
 		id: uuid;
 	}
 
+	@doc("Response model for updating a form response")
+	model UpdateResponse {
+		@doc("The response's unique identifier.")
+		id: uuid;
+
+		@doc("The last updated timestamp of the response.")
+		updatedAt: utcDateTime;
+
+		@doc("The updated answer data.")
+		answers: (AnswerJSON | ScaleAnswerJSON | OauthAnswerJSON)[];
+	}
+
 	@doc("Response model for a single response in list view")
 	model ResponseJSON {
 		@doc("The response's unique identifier.")

src/responses/operations.tsp

@@ -31,6 +31,34 @@ namespace CoreSystem.Responses {
 	@patch(#{ implicitOptionality: true })
 	op updateFormResponse(@path id: uuid, @body req: AnswersRequest): {
 		@statusCode statusCode: 200;
+		@body response: UpdateResponse;
+	};
+
+	@summary("Connect OAuth Account")
+	@doc("Initiate OAuth flow for connecting an account to answer a question. This endpoint redirects (302) to the OAuth provider's authorization page. After authorization, the OAuth profile data (username, avatar_url) is stored as the answer and can be fetched via GET /responses/{responseId}/questions/{questionId}.")
+	@route("/oauth/questions/{provider}")
+	@get
+	op connectOauthAccount(
+		@path
+		@doc("The OAuth provider to connect with (github or google).")
+		provider: CoreSystem.Auth.OAuthProviders,
+
+		@query
+		@doc("The response ID to associate this OAuth answer with.")
+		responseId: uuid,
+
+		@query
+		@doc("The question ID being answered.")
+		questionId: uuid,
+
+		@query
+		@doc("Optional redirect URL after OAuth completion.")
+		r?: string,
+	):
+	{
+		@statusCode statusCode: 302;
+	} | {
+		@statusCode statusCode: 404;
 	};
 
 	@summary("Upload Question Files")