Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
SSHOC
sshoc-marketplace
Commits
01f2d5fa
Commit
01f2d5fa
authored
Mar 25, 2021
by
Matej
Browse files
adding a stub of documentation for the practical use of the API.
parent
5dc48da9
Changes
1
Hide whitespace changes
Inline
Side-by-side
docs/api-userstories.md
0 → 100644
View file @
01f2d5fa
# Documentation of User Stories with respect to the API
This document collects various user stories (actions users need to be able to perform and what it means in terms of call to the Marketplace API.
## Managing sources
## Managing items
### Contributor suggesting a new item
**API calls:**
**Result:**
New item stored in the DB with status:
`SUGGESTED`
### Contributor suggesting a new workflow
Special provisions in case a workflow is being suggested.
**API calls:**
**Result:**
### Contributor suggesting changes to an existing item
This includes also adding a new dynamic property to an existing item.
**API calls:**
**Result:**
New version of an existing item stored in the DB with status:
`SUGGESTED`
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a 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