feat: updated doc to reflect details of server, still not done editing it
This commit is contained in:
34
documentation/openapi/src/unauthApi.yaml
Normal file
34
documentation/openapi/src/unauthApi.yaml
Normal file
@ -0,0 +1,34 @@
|
||||
|
||||
# _ _ _ _ _ _
|
||||
# | | | |_ __ __ _ _ _| |_| |__ / \ _ __ (_)
|
||||
# | | | | '_ \ / _` | | | | __| '_ \ / _ \ | '_ \| |
|
||||
# | |_| | | | | (_| | |_| | |_| | | |/ ___ \| |_) | |
|
||||
# \___/|_| |_|\__,_|\__,_|\__|_| |_/_/ \_\ .__/|_|
|
||||
# |_|
|
||||
|
||||
paths:
|
||||
/accounts/finalize: # Path renamed from /unauth/create_account
|
||||
post:
|
||||
operationId: finalizeAccountSetup # Renamed operationId
|
||||
summary: Finalize account setup using authentication token
|
||||
description: |-
|
||||
Completes the user account creation/setup process in the MyInpulse system.
|
||||
This endpoint requires the user to be authenticated via Keycloak (e.g., after initial login).
|
||||
User details (name, email, etc.) are extracted from the authenticated user's token (e.g., Keycloak JWT).
|
||||
No request body is needed. The account is marked as pending admin validation upon successful finalization.
|
||||
tags:
|
||||
- Account Management API # Changed tag
|
||||
security:
|
||||
- MyINPulse: [MyINPulse-entrepreneur] # Security requirement remains as per clarification
|
||||
# No requestBody needed as per clarification
|
||||
responses:
|
||||
"201": # Use 201 Created or 200 OK if it returns the user profile
|
||||
description: Created - Account finalized and pending admin validation. Returns the user profile.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: './main.yaml#/components/schemas/user-entrepreneur' # Return the created user profile
|
||||
"400":
|
||||
description: Bad Request - Problem processing the token or user data derived from it.
|
||||
"401":
|
||||
description: Unauthorized - Valid authentication token required.
|
Reference in New Issue
Block a user