Skip to content
GitLab
Explore
Projects
Groups
Snippets
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
David Kosztka
Pod
Commits
8767c390
Verified
Commit
8767c390
authored
4 years ago
by
Vasili Novikov
Browse files
Options
Download
Email Patches
Plain Diff
Review fixes
parent
ab81d669
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/HTTP_API.md
+6
-6
docs/HTTP_API.md
with
6 additions
and
6 deletions
+6
-6
docs/HTTP_API.md
+
6
-
6
View file @
8767c390
...
...
@@ -53,14 +53,14 @@ support properties in the future (don't rely on it yet).
# API
### GET /version
Get the version of the Pod. In future,
we'
ll also point to a specific git commit
here
.
Get the version of the Pod. In future,
it wi
ll also point to a specific git commit.
### GET /v1/items/{uid}
Get a single item by it's
`uid`
.
⚠️ UNSTABLE: currently,
we
return an empty array if an item is not found,
⚠️ UNSTABLE: currently,
the endpoint
return
s
an empty array if an item is not found,
or an array with 1 item if item exists.
In future,
we
might return an error if item was not found,
In future,
the endpoint
might return an error if item was not found,
and the object itself if the item was found.
### GET /v1/all_items/
...
...
@@ -76,8 +76,8 @@ Create a single item.
Returns
`uid`
of the created item. Returns an error if an
`uid`
did already exist.
⚠️ UNSTABLE:
We
might allow creating items without
`uid`
being explicitly set,
and just return the
`uid`
to the caller
in future
.
⚠️ UNSTABLE:
In future, the endpoint
might allow creating items without
`uid`
being explicitly set,
and just return the
`uid`
to the caller.
### PUT /v1/items/{uid}
Update a single item.
...
...
@@ -133,5 +133,5 @@ and all item-s properties that those edges point to.
⚠️ UNSTABLE: Currently, the endpoint will return
an array of 1 item (and linked data) when
`uid`
exists,
or an empty array when this
`uid`
does not exist.
In future,
we
might return the json object itself when the
`uid`
exists,
In future,
the endpoint
might return the json object itself when the
`uid`
exists,
or return an HTTP failure otherwise.
This diff is collapsed.
Click to expand it.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment
Menu
Explore
Projects
Groups
Snippets