lfk/backend
2
0
Fork 0
Code Issues 1 Pull Requests Actions Projects Releases 40 Activity

Update and create with ids or objects #90

New Issue
Closed
opened 2021-01-12 16:04:29 +00:00 by niggl · 1 comment
niggl commented 2021-01-12 16:04:29 +00:00
Owner
Copy Link

Motivation

Right now most create and update actions that include other entities/relations require to provide the user to provide that entity's id.
To increase UX all create and update actions should accept plain numbers (or arrays of numers) and a custom class containing an id.

Examples

Example 1: Numbers only

When creating a new track scan you have to provide the card's and station's ids as plain numbers.

{
    "card": 1,
    "station": 4
}

Example 2: Class only

When updateing a user you have to provide it's groups as an array containing objects that have the groups' ids as the property "id".

{
    "id": 6,
    "enabled": true,
    "firstname": "demo_refresh",
    "middlename": "demo_refresh",
    "lastname": "demo_refresh",
    "username": "demo_refresh",
    "profilePic": "https://dev.lauf-fuer-kaya.de/lfk-logo.png",
    "groups": [{"id":1}]
}
# Motivation Right now most create and update actions that include other entities/relations require to provide the user to provide that entity's id. To increase UX all create and update actions should accept plain numbers (or arrays of numers) and a custom class containing an id. # Examples ## Example 1: Numbers only When creating a new track scan you have to provide the card's and station's ids as plain numbers. ```json { "card": 1, "station": 4 } ``` ## Example 2: Class only When updateing a user you have to provide it's groups as an array containing objects that have the groups' ids as the property "id". ``` { "id": 6, "enabled": true, "firstname": "demo_refresh", "middlename": "demo_refresh", "lastname": "demo_refresh", "username": "demo_refresh", "profilePic": "https://dev.lauf-fuer-kaya.de/lfk-logo.png", "groups": [{"id":1}] } ```
niggl added this to the Project Quality of Life/Dev milestone 2021-01-12 16:04:29 +00:00
niggl added the
priority:low
enhancement
 labels 2021-01-12 16:04:29 +00:00
niggl added a new dependency 2021-01-12 16:47:28 +00:00
#66 Donation API
niggl commented 2021-01-15 17:10:12 +00:00
Author
Owner
Copy Link

Due to limitations with jsonschema generation we'll just switch all endpoints to accepting numbers/number arrays of the relation's object's id

Due to limitations with jsonschema generation we'll just switch all endpoints to accepting numbers/number arrays of the relation's object's id
niggl added the
status:doing
 label 2021-01-15 17:10:21 +00:00
niggl referenced this issue from a commit 2021-01-15 17:10:57 +00:00
Removed todo
niggl referenced this issue from a commit 2021-01-15 17:12:58 +00:00
Clarified comments
niggl referenced this issue from a commit 2021-01-15 17:19:37 +00:00
Clarified comments
niggl referenced this issue from a commit 2021-01-15 17:22:29 +00:00
Clarified comments
niggl referenced this issue from a commit 2021-01-15 17:23:33 +00:00
Clarified comments
niggl referenced this issue from a commit 2021-01-15 17:25:50 +00:00
Clarified comments
niggl referenced this issue from a commit 2021-01-15 17:29:06 +00:00
Clarified comments
niggl referenced this issue from a commit 2021-01-15 17:32:43 +00:00
Clarified comments
niggl referenced this issue from a commit 2021-01-15 17:39:06 +00:00
Fixed old reference
niggl closed this issue 2021-01-15 17:57:47 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
Something is not working
duplicate
This issue or pull request already exists
enhancement
New feature
help wanted
Need some help
invalid
Something is wrong
priority:high
priority:low
priority:medium
question
More information is needed
status:blocked
status:doing
status:review_needed
wontfix
This won't be fixed
Complexity
Easy
The complexity is low
Complexity
Hard
The complexity is high
Complexity
Medium
The complexity is medium
Kind/Bug
Something is not working
Kind/Enhancement
Improve existing functionality
Kind/Feature
New functionality
Kind/Question
A question
Kind/Security
This is security issue
Kind/Testing
Issue or pull request related to testing
Priority
Critical
The priority is critical
Priority
High
The priority is high
Priority
Low
The priority is low
Priority
Medium
The priority is medium
Reviewed
Confirmed
Issue has been confirmed
Reviewed
Duplicate
This issue or pull request already exists
Reviewed
Invalid
Invalid issue
Reviewed
Won't Fix
This issue won't be fixed
Status
Abandoned
Somebody has started to work on this but abandoned work
Status
Blocked
Something is blocking this issue or pull request
Status/Confirmed
This is indeed a bug/issue
Status
Doing
Somebody is working on this
Status
Need More Info
Feedback is required to reproduce issue or to continue work
Status
Review needed
Needs a reveiw
No Label
enhancement
priority:low
status:doing
Milestone
No items
No Milestone Project Quality of Life/Dev
Projects
Clear projects
No project
Assignees
Clear assignees
niggl odit_bot philipp
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Depends on
#66 Donation API
lfk/backend
Reference: lfk/backend#90
No description provided.
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?