chore(docs): Updated API Reference (v2) (#9033)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-09-06 12:25:48 +00:00
parent 20545b194e
commit cf3c25addf
535 changed files with 3668 additions and 23178 deletions
@@ -4,7 +4,6 @@
 * summary: Delete Session
 * description: Delete Session
 * x-authenticated: false
- * parameters: []
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -0,0 +1,44 @@
+/**
+ * @oas [post] /auth/{actor_type}/{auth_provider}/reset-password
+ * operationId: PostActor_typeAuth_providerResetPassword
+ * summary: Add Reset Password to [actor_type]
+ * description: Add a Reset Password to a [actor_type]
+ * x-authenticated: false
+ * parameters:
+ *   - name: actor_type
+ *     in: path
+ *     description: The [actor type]'s actor type.
+ *     required: true
+ *     schema:
+ *       type: string
+ *   - name: auth_provider
+ *     in: path
+ *     description: The [actor type]'s auth provider.
+ *     required: true
+ *     schema:
+ *       type: string
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: curl -X POST '{backend_url}/auth/{actor_type}/{auth_provider}/reset-password'
+ * tags:
+ *   - "[actor_type]"
+ * responses:
+ *   "200":
+ *     description: OK
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * x-workflow: generateResetPasswordTokenWorkflow
+ * 
+*/
+
@@ -0,0 +1,43 @@
+/**
+ * @oas [post] /auth/{actor_type}/{auth_provider}/update
+ * operationId: PostActor_typeAuth_providerUpdate
+ * summary: Add Update to [actor_type]
+ * description: Add a Update to a [actor_type]
+ * x-authenticated: false
+ * parameters:
+ *   - name: actor_type
+ *     in: path
+ *     description: The [actor type]'s actor type.
+ *     required: true
+ *     schema:
+ *       type: string
+ *   - name: auth_provider
+ *     in: path
+ *     description: The [actor type]'s auth provider.
+ *     required: true
+ *     schema:
+ *       type: string
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: curl -X POST '{backend_url}/auth/{actor_type}/{auth_provider}/update'
+ * tags:
+ *   - "[actor_type]"
+ * responses:
+ *   "200":
+ *     description: OK
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * 
+*/
+
@@ -4,7 +4,6 @@
 * summary: Create Session
 * description: Create a session.
 * x-authenticated: false
- * parameters: []
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
@@ -0,0 +1,31 @@
+/**
+ * @oas [post] /auth/token/refresh
+ * operationId: PostTokenRefresh
+ * summary: Create Token
+ * description: Create a token.
+ * x-authenticated: false
+ * parameters: []
+ * x-codeSamples:
+ *   - lang: Shell
+ *     label: cURL
+ *     source: curl -X POST '{backend_url}/auth/token/refresh'
+ * tags:
+ *   - Token
+ * responses:
+ *   "200":
+ *     description: OK
+ *   "400":
+ *     $ref: "#/components/responses/400_error"
+ *   "401":
+ *     $ref: "#/components/responses/unauthorized"
+ *   "404":
+ *     $ref: "#/components/responses/not_found_error"
+ *   "409":
+ *     $ref: "#/components/responses/invalid_state_error"
+ *   "422":
+ *     $ref: "#/components/responses/invalid_request_error"
+ *   "500":
+ *     $ref: "#/components/responses/500_error"
+ * 
+*/
+