github-starred/vikunja
2
0
Fork 0
mirror of https://github.com/go-vikunja/vikunja.git synced 2026-05-13 20:24:44 -05:00
Code Issues 690 Packages Projects Releases 11 Wiki Activity

Add note to documentation incorrect about case of filter fields in api #319

New Issue
Closed
opened 2025-11-01 20:53:46 -05:00 by GiteaMirror · 1 comment
GiteaMirror commented 2025-11-01 20:53:46 -05:00
Owner
Copy Link

Originally created by @bthornton191 on GitHub (Nov 27, 2024).

Description

The documentation at https://vikunja.io/docs/filters has everything in camel case. But the api returns everything in snake. Maybe I should have known, but a note in the docs would have saved me some time time and headache. 🙏

That section of the docs is correct for the front end, but the api ref links to it. The api ref might be the a good place to note the discrepancy.

>>> url = 'https://***************/api/v1/projects/2/tasks'
>>> response = requests.get(url, headers=headers)
>>> for k in response.json()[0]:
>>>    print(k) 
id
title
description
done
done_at
due_date
reminders
project_id
repeat_after
repeat_mode
priority
start_date
end_date
assignees
labels
hex_color
percent_done
identifier
index
related_tasks
attachments
cover_image_attachment_id
is_favorite
created
updated
bucket_id
position
reactions
created_by

Vikunja Version

0.24.4

Browser and version

No response

Can you reproduce the bug on the Vikunja demo site?

Please select

Screenshots

image

Originally created by @bthornton191 on GitHub (Nov 27, 2024). ### Description The documentation at https://vikunja.io/docs/filters has everything in camel case. But the api returns everything in snake. Maybe I should have known, but a note in the docs would have saved me some time time and headache. 🙏 That section of the docs is correct for the front end, but the api ref links to it. The api ref might be the a good place to note the discrepancy. ```python >>> url = 'https://***************/api/v1/projects/2/tasks' >>> response = requests.get(url, headers=headers) >>> for k in response.json()[0]: >>> print(k) id title description done done_at due_date reminders project_id repeat_after repeat_mode priority start_date end_date assignees labels hex_color percent_done identifier index related_tasks attachments cover_image_attachment_id is_favorite created updated bucket_id position reactions created_by ``` ### Vikunja Version 0.24.4 ### Browser and version _No response_ ### Can you reproduce the bug on the Vikunja demo site? Please select ### Screenshots ![image](https://github.com/user-attachments/assets/86192833-818d-40cb-8c52-bdb76b2af1ca)
GiteaMirror commented 2025-11-01 20:53:47 -05:00
Author
Owner
Copy Link

@kolaente commented on GitHub (Dec 4, 2024):

Thanks for the report! This is now fixed (might take a while until visible on the website).

@kolaente commented on GitHub (Dec 4, 2024): Thanks for the report! This is now fixed (might take a while until visible on the website).
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area/api
area/attachments
area/auth
area/avatars
area/backup-restore
area/caldav
area/calendar-view
area/comments
area/config
area/database
area/desktop
area/docker
area/email
area/favorites
area/filters
area/frontend
area/gantt
area/i18n
area/import-export
area/internal-code
area/kanban
area/labels
area/list-view
area/mobile
area/notifications
area/permissions
area/projects
area/pwa
area/recurring-tasks
area/reminders
area/search
area/shortcuts
area/subtasks
area/sync
area/table-view
area/task-editor
area/task-metadata
area/task-relations
area/teams
area/theming
area/time-tracking
area/typesense
area/views
area/webhooks
bug
changes requested
concern/accessibility
concern/performance
concern/regression
concern/ux
confirmed
db/mysql
dependencies
enhancement
good first issue
help wanted
integration/inbound
integration/outbound
kind/bug
kind/feature
needs reproduction
pull-request
Mirrored from GitHub Pull Request
 question
security
support
upstream issue
waiting for reply
wontfix
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/vikunja#319
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?