fix(docs): improve swagger output by setting swaggertype and enums #705
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added `swaggertype:"string"` and `enums` tags to fields in ProjectView to ensure correct type representation in Swagger docs. Affected fields: - ViewKind - Filter - BucketConfigurationMode
kolaente
reviewed
Apr 26, 2025
pkg/models/project_view.go
Outdated
|
|
||
| // The filter query to match tasks by. Check out https://vikunja.io/docs/filters for a full explanation. | ||
| Filter *TaskCollection `xorm:"json null default null" query:"filter" json:"filter"` | ||
| Filter *TaskCollection `xorm:"json null default null" query:"filter" json:"filter" swaggertype:"string"` |
There was a problem hiding this comment.
That's not a string, it's a subtype
There was a problem hiding this comment.
@kolaente Hey, It seems to be a subtype but for some reason in API it returns a string:
There was a problem hiding this comment.
This has been changed a while ago, which version are you using?
Here's ther response from the demo (which runs unstable):
There was a problem hiding this comment.
Tested on the stable (v0.24.6) version.
I removed swaggertype for this field
kolaente
approved these changes
May 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added
swaggertype:"string"andenumstags to fields in ProjectView to ensure correct type representation in Swagger docs.Affected fields: