docs: Add request and error examples (#2109)

This commit is contained in:
Shahed Nasser
2022-09-04 20:08:05 +02:00
committed by GitHub
parent c0a002b262
commit 4961aece1c
246 changed files with 8566 additions and 285 deletions
@@ -32,6 +32,27 @@ import { validator } from "../../../../utils/validator"
* type: string
* description: The User's password.
* format: password
* x-codeSamples:
* - lang: JavaScript
* label: JS Client
* source: |
* import Medusa from "@medusajs/medusa-js"
* const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
* medusa.admin.auth.createSession({
* email: 'user@example.com',
* password: 'supersecret'
* }).then((({ user }) => {
* console.log(user.id);
* });
* - lang: Shell
* label: cURL
* source: |
* curl --location --request POST 'https://medusa-url.com/admin/auth' \
* --header 'Content-Type: application/json' \
* --data-raw '{
* "email": "user@example.com",
* "password": "supersecret"
* }'
* tags:
* - Auth
* responses:
@@ -43,8 +64,18 @@ import { validator } from "../../../../utils/validator"
* properties:
* user:
* $ref: "#/components/schemas/user"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* description: The user doesn't exist or the credentials are incorrect.
* $ref: "#/components/responses/incorrect_credentials"
* "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"
*/
export default async (req, res) => {
const { projectConfig: { jwt_secret } } = req.scope.resolve('configModule')