mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
9a5fc674f3
* 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
100 lines
2.0 KiB
Markdown
100 lines
2.0 KiB
Markdown
# Interacting with the server
|
|
|
|
## `PUT`: Creating resources for a given URL
|
|
|
|
Create a plain text file:
|
|
|
|
```shell
|
|
curl -X PUT -H "Content-Type: text/plain" \
|
|
-d "abc" \
|
|
http://localhost:3000/myfile.txt
|
|
```
|
|
|
|
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
|
|
|
|
Create a plain text file:
|
|
|
|
```shell
|
|
curl -X POST -H "Content-Type: text/plain" \
|
|
-d "abc" \
|
|
http://localhost:3000/
|
|
```
|
|
|
|
Create a turtle file:
|
|
|
|
```shell
|
|
curl -X POST -H "Content-Type: text/turtle" \
|
|
-d "<ex:s> <ex:p> <ex:o>." \
|
|
http://localhost:3000/
|
|
```
|
|
|
|
The response's `Location` header will contain the URL of the created resource.
|
|
|
|
## `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
|
|
|
|
```shell
|
|
curl -X DELETE http://localhost:3000/myfile.txt
|
|
```
|
|
|
|
## `PATCH`: Modifying resources
|
|
|
|
Modify a resource using [N3 Patch](https://solidproject.org/TR/protocol#n3-patch):
|
|
|
|
```shell
|
|
curl -X PATCH -H "Content-Type: text/n3" \
|
|
--data-raw "@prefix solid: <http://www.w3.org/ns/solid/terms#>. _:rename a solid:InsertDeletePatch; solid:inserts { <ex:s2> <ex:p2> <ex:o2>. }." \
|
|
http://localhost:3000/myfile.ttl
|
|
```
|
|
|
|
Modify a resource using [SPARQL Update](https://www.w3.org/TR/sparql11-update/):
|
|
|
|
```shell
|
|
curl -X PATCH -H "Content-Type: application/sparql-update" \
|
|
-d "INSERT DATA { <ex:s2> <ex:p2> <ex:o2> }" \
|
|
http://localhost:3000/myfile.ttl
|
|
```
|
|
|
|
## `HEAD`: Retrieve resources headers
|
|
|
|
```shell
|
|
curl -I -H "Accept: text/plain" \
|
|
http://localhost:3000/myfile.txt
|
|
```
|
|
|
|
## `OPTIONS`: Retrieve resources communication options
|
|
|
|
```shell
|
|
curl -X OPTIONS -i http://localhost:3000/myfile.txt
|
|
```
|