Added password reset endpoint doc
MODIFY
src/assets/server/rest/v1/docs/open-api-standard.json
src/assets/server/rest/v1/docs/open-api-standard.json
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Login"
+ "$ref": "#/components/schemas/Signin"
}
}
}
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Register"
+ "$ref": "#/components/schemas/Signon"
}
}
}
}
}
}
+ },
+ "/auth/passwordreset": {
+ "post": {
+ "description": "Reset password",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PasswordReset"
+ }
+ }
+ }
+ },
+ "tags": [
+ "Auth"
+ ],
+ "responses": {
+ "200": {
+ "description": "Password reset notification sent successfully"
+ },
+ "500": {
+ "$ref": "#/components/responses/500BackendError"
+ },
+ "550": {
+ "description": "User is deleted logically"
+ }
+ }
+ }
}
},
"components": {
}
}
},
- "Login": {
+ "Signin": {
"type": "object",
"properties": {
"email": {
}
}
},
- "Register": {
+ "Signon": {
"type": "object",
"properties": {
"email": {
}
}
},
+ "PasswordReset": {
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "example": "loan.alouache@sap.com"
+ },
+ "captcha": {
+ "type": "string",
+ "example": "03AGdBq261sQ2KzqROGD8E2Xb2ljxLkmQbUumIL9m6FqtJZau9Z5Aq4Pp8K-VzbjTwuvnBvdaZBgD-6VU0IY8PMSyGmSJNH9Ctkgde4l8XoQUVLYLhspglIRSjkPS15-DZQtJ2gLG910Kq3RXE-S5M9gkuXBfEh6Y-81qC9gRb-FFwN_Ao5_NO7j6iu1kZqJHpyxHvwVqtbLK5APvTngU_8gx9tRDfXUBtLMmgZAofmkIE1qbefMNTDceJsiNKtHHykP-xFIt-lNRN1H6h_HZ8EbRjncT5k_AeqjL8ClBTZy9Pdqwy9jkpvas4l5EH7WPVT-9VPV0C0tuwKkwwwesMhzYSo2Vso_wN15G5x1Zgji8xsndjvMthTkIWe4zyRNKNr2gc4z1Sgfy-dGcRkDc7lUnet0fJfII5bXKl_njo_S8no8KGVZ2IeOTzhTKigA7A0hdtNrKnAOmU"
+ },
+ "tenant": {
+ "type": "string",
+ "example": ""
+ }
+ }
+ },
"Address": {
"type": "object",
"properties": {

Added password reset endpoint doc