From aa010f3e872d9a9c850cc35c3ae940e5096e68e4 Mon Sep 17 00:00:00 2001 From: Benjamin Frost Date: Sun, 19 May 2024 22:46:56 +0200 Subject: [PATCH] fix: markdown not parsed correctly --- docs/s3-api-docs.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/s3-api-docs.md b/docs/s3-api-docs.md index 302e87f..8683aab 100644 --- a/docs/s3-api-docs.md +++ b/docs/s3-api-docs.md @@ -11,16 +11,18 @@ This is the API documentation for the AEC 2024 Skill 08 Session 3 API.
More details on multipart/form-data -When sending a request with a file, the request must be sent as `multipart/form-data`. This format structures the request body as a series of key-value pairs, where the key represents the name of the field in the form, and the value is the data associated with that field. +

When sending a request with a file, the request must be sent as multipart/form-data. This format structures the request body as a series of key-value pairs, where the key represents the name of the field in the form, and the value is the data associated with that field.

-The key-value pairs require a specific format: +

The key-value pairs require a specific format:

-- Simple Key-Value Pairs: These are straightforward pairs like `caption: "My super cool post caption!"`. -- File Uploads: When uploading a file, specify the key and provide the file using its path, such as `image: "/path/to/file/image.jpg"`. -- Nested Keys: If you need to send nested data, you can use the following format: `foo[bar][baz]: "value"`. -- Arrays: When sending arrays, you additionally need to specify the index of the array element. For example, `arr[0][key]: "abc"`. + -Here is an example on how to structure a `multipart/form-data` request to create a new post using `cURL`: +

Here is an example on how to structure a multipart/form-data request to create a new post using cURL:

```bash curl --location --request POST 'http://api-url/posts' \