mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
style: Enforce linting rules on markdown files
* chore: add markdownlint-cli2 and config for mkdocs * style: enforce linting rules on mkdocs md files * chore: tweaks to markdownlint rules * style: linting changelog * style: linting release notes * style: linting .github md files * style: further linting of docs * style: linting readmes * chore: update linting script entries * docs: tweak release after rebase * chore: simplify root md linting config * chore: extend base config * chore: implement requested changes * chore: remove unnecessary exception * chore: fix comment type * styling: single config + list spacing * chore: implement requested changes * chore: use .cjs files for markdownlint config * chore: implement requested changes
This commit is contained in:
@@ -1,8 +1,9 @@
|
||||
## Interacting with the server
|
||||
# Interacting with the server
|
||||
|
||||
### `PUT`: Creating resources for a given URL
|
||||
## `PUT`: Creating resources for a given URL
|
||||
|
||||
Create a plain text file:
|
||||
|
||||
```shell
|
||||
curl -X PUT -H "Content-Type: text/plain" \
|
||||
-d "abc" \
|
||||
@@ -10,15 +11,17 @@ curl -X PUT -H "Content-Type: text/plain" \
|
||||
```
|
||||
|
||||
Create a turtle file:
|
||||
|
||||
```shell
|
||||
curl -X PUT -H "Content-Type: text/turtle" \
|
||||
-d "<ex:s> <ex:p> <ex:o>." \
|
||||
http://localhost:3000/myfile.ttl
|
||||
```
|
||||
|
||||
### `POST`: Creating resources at a generated URL
|
||||
## `POST`: Creating resources at a generated URL
|
||||
|
||||
Create a plain text file:
|
||||
|
||||
```shell
|
||||
curl -X POST -H "Content-Type: text/plain" \
|
||||
-d "abc" \
|
||||
@@ -26,6 +29,7 @@ curl -X POST -H "Content-Type: text/plain" \
|
||||
```
|
||||
|
||||
Create a turtle file:
|
||||
|
||||
```shell
|
||||
curl -X POST -H "Content-Type: text/turtle" \
|
||||
-d "<ex:s> <ex:p> <ex:o>." \
|
||||
@@ -34,33 +38,36 @@ curl -X POST -H "Content-Type: text/turtle" \
|
||||
|
||||
The response's `Location` header will contain the URL of the created resource.
|
||||
|
||||
### `GET`: Retrieving resources
|
||||
## `GET`: Retrieving resources
|
||||
|
||||
Retrieve a plain text file:
|
||||
|
||||
```shell
|
||||
curl -H "Accept: text/plain" \
|
||||
http://localhost:3000/myfile.txt
|
||||
```
|
||||
|
||||
Retrieve a turtle file:
|
||||
|
||||
```shell
|
||||
curl -H "Accept: text/turtle" \
|
||||
http://localhost:3000/myfile.ttl
|
||||
```
|
||||
|
||||
Retrieve a turtle file in a different serialization:
|
||||
|
||||
```shell
|
||||
curl -H "Accept: application/ld+json" \
|
||||
http://localhost:3000/myfile.ttl
|
||||
```
|
||||
|
||||
### `DELETE`: Deleting resources
|
||||
## `DELETE`: Deleting resources
|
||||
|
||||
```shell
|
||||
curl -X DELETE http://localhost:3000/myfile.txt
|
||||
```
|
||||
|
||||
### `PATCH`: Modifying resources
|
||||
## `PATCH`: Modifying resources
|
||||
|
||||
Modify a resource using [N3 Patch](https://solidproject.org/TR/protocol#n3-patch):
|
||||
|
||||
@@ -78,16 +85,15 @@ curl -X PATCH -H "Content-Type: application/sparql-update" \
|
||||
http://localhost:3000/myfile.ttl
|
||||
```
|
||||
|
||||
### `HEAD`: Retrieve resources headers
|
||||
## `HEAD`: Retrieve resources headers
|
||||
|
||||
```shell
|
||||
curl -I -H "Accept: text/plain" \
|
||||
http://localhost:3000/myfile.txt
|
||||
```
|
||||
|
||||
### `OPTIONS`: Retrieve resources communication options
|
||||
## `OPTIONS`: Retrieve resources communication options
|
||||
|
||||
```shell
|
||||
curl -X OPTIONS -i http://localhost:3000/myfile.txt
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user