Remove Verbiage of "issue_type" Being the Correct Filter in List Issues#185
Open
nox7 wants to merge 1 commit intoAccelo:mainfrom
Open
Remove Verbiage of "issue_type" Being the Correct Filter in List Issues#185nox7 wants to merge 1 commit intoAccelo:mainfrom
nox7 wants to merge 1 commit intoAccelo:mainfrom
Conversation
Updated issue filtering parameters and marked some as deprecated.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
In the current Accelo docs under List Issues and Basic Filtering, it incorrectly states to use "issue_type" for filtering by the "issue_type_id" - however, this filter does not work and leads developers to incorrect and frustrating results.
The "type" filter must be used. While "type" is listed as deprecated in the actual object documentation, the docs should still be relevant and correct to what actually, currently functions. Postman example below.
First image, we see we attempt to use "issue_type" in the filter
However, we get results back that are not just of that issue_type_id.
In the second image, when using "type" we get the correct results.
Currently "issue_type" does not function as a valid or useful filter. This PR removes it from the List Issues docs and removes deprecation notice of "type" because there is currently no other way to filer by type.