docs: Add request and error examples (#2109)

This commit is contained in:
Shahed Nasser
2022-09-04 21:08:05 +03:00
committed by GitHub
parent c0a002b262
commit 4961aece1c
246 changed files with 8566 additions and 285 deletions
@@ -28,6 +28,35 @@ import { EntityManager } from "typeorm"
* value:
* type: string
* description: The content of the Note to create.
* x-codeSamples:
* - lang: JavaScript
* label: JS Client
* source: |
* import Medusa from "@medusajs/medusa-js"
* const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
* // must be previously logged in or use api token
* medusa.admin.notes.create({
* resource_id,
* resource_type: 'order',
* value: 'We delivered this order'
* })
* .then(({ note }) => {
* console.log(note.id);
* });
* - lang: Shell
* label: cURL
* source: |
* curl --location --request POST 'https://medusa-url.com/admin/notes' \
* --header 'Authorization: Bearer {api_token}' \
* --header 'Content-Type: application/json' \
* --data-raw '{
* "resource_id": "{resource_id}",
* "resource_type": "order",
* "value": "We delivered this order"
* }'
* security:
* - api_token: []
* - cookie_auth: []
* tags:
* - Note
* responses:
@@ -39,6 +68,18 @@ import { EntityManager } from "typeorm"
* properties:
* note:
* $ref: "#/components/schemas/note"
* "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"
*
*/
export default async (req, res) => {