Issues API for Groups: Flag to exclude issues for archived projects within groups

Problem to solve

Querying the Issues API for Groups returns all issues regardless of the archived state of the project where the issues resides. If you are querying for a list of issues to perform an operation against you may want to exclude the issues for archived projects because it is not possible to update them

Intended users

Automations updating issues via the group API

Further details

Triage Operations:

Triage-ops issues quick action commands on many issues in one operation. It is possible to query the issues for a group. The issues returned may belong to an archived project that cannot be updated. We would like to be able to set an option to not return these archived issues.

Proposal

Something like an exclude_archived_projects flag for the Issues API and other resources. This should be disabled by default to ensure backwards compatibility and not affect existing integrations that expect archived project resources to be returned

Permissions and Security

  • It could be possible to determine which projects are archived by querying the API with and without this flag and comparing the projects associated with the returned issues

Documentation

  • Issues API docs would need to be updated to include the new flag

Testing

TBD

What does success look like, and how can we measure that?

  • Quality team's automated pipelines could be faster without targeting archived project issues that cannot be updated?

Links / references

Assignee Loading
Time tracking Loading