Skip to content

Commit

Permalink
corrected API response structure/layout; fixes #16
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Kaufmann <d00p@froxlor.org>
  • Loading branch information
d00p committed Jul 6, 2023
1 parent a54fbd3 commit 2228db9
Showing 1 changed file with 0 additions and 8 deletions.
8 changes: 0 additions & 8 deletions api-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,6 @@ The result should then look somewhat like this (removed headers and actual data

```json
{
"status": 200,
"status_message": "successful",
"data": [
{
"module": "SomeModule",
Expand All @@ -127,8 +125,6 @@ A response from the API endpoint has the following structure:

```json
{
"status": 200,
"status_message": "a status message",
"data": {
...
}
Expand All @@ -146,8 +142,6 @@ Listing response:

```json
{
"status": 200,
"status_message": "success",
"data": {
"count": number-of-entries,
"list": [
Expand All @@ -161,8 +155,6 @@ Single entity response:

```json
{
"status": 200,
"status_message": "success",
"data": {...}
}
```

0 comments on commit 2228db9

Please sign in to comment.