Skip to content

Commit 0b94a42

Browse files
committed
fix typos
1 parent dd14eb1 commit 0b94a42

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@ Use a client to connect to the service.
3535

3636
### General
3737

38-
| Method | Path | Description |
39-
|--------|----------------|---------------------------------------------|
40-
| GET | /alive | Liveness probe endpoint |
41-
| GET | /mkdocs/config | Retrieve the `mkdocsrest.yaml` configurtion |
38+
| Method | Path | Description |
39+
|--------|----------------|----------------------------------------------|
40+
| GET | /alive | Liveness probe endpoint |
41+
| GET | /mkdocs/config | Retrieve the `mkdocsrest.yaml` configuration |
4242

4343
### Sections
4444

4545
| Method | Path | Description |
4646
|--------|----------------------|-------------------------------------------------------|
4747
| GET | /section | Retrieve the whole section tree |
4848
| GET | /section/<sectionId> | Retrieve the section with the given `sectionId` |
49-
| POST | /section | Create a new secton |
49+
| POST | /section | Create a new section |
5050
| PUT | /section/<sectionId> | Update an existing section with the given `sectionId` |
5151
| DELETE | /section/<sectionId> | Delete the section with the given `sectionId` |
5252

@@ -58,7 +58,7 @@ Use a client to connect to the service.
5858
| GET | /document/<documentId>/ws | Websocket endpoint for realtime communication regarding updates of the document with the given `documentId` |
5959
| GET | /document/<documentId>/content | Retrieve the current content of the document with the given `documentId` |
6060
| POST | /document | Create a new document |
61-
| PUT | /document/<documentId> | Rename an exsiting document with the given `documentId` |
61+
| PUT | /document/<documentId> | Rename an existing document with the given `documentId` |
6262
| DELETE | /document/<documentId> | Delete the document with the given `documentId` |
6363

6464
### Resources
@@ -68,7 +68,7 @@ Use a client to connect to the service.
6868
| GET | /resource/<resourceId> | Retrieve the resource with the given `resourceId` |
6969
| GET | /resource/<resourceId>/content | Retrieve the current content of the resource with the given `resourceId` |
7070
| POST | /resource | Upload a new resource |
71-
| PUT | /resource/<resourceId> | Rename an exsiting resource with the given `resourceId` |
71+
| PUT | /resource/<resourceId> | Rename an existing resource with the given `resourceId` |
7272
| DELETE | /resource/<resourceId> | Delete the resource with the given `resourceId` |
7373

7474
# Contributing

openapi-description.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ paths:
353353

354354
/document/{documentId}/ws/:
355355
get:
356-
summary: "Documnt Websocket"
356+
summary: "Document Websocket"
357357
description: "Opens a websocket for the given document to engage in realtime editing."
358358
operationId: getDocumentWebsocket
359359
tags:

0 commit comments

Comments
 (0)