API Deprecation and Removal Planning for %15.9
Removing unused or duplicate values within a sensible time limit ensures that GitLab's APIs maintain a high level of quality and usability.
The deprecation cycle for our APIs requires a minimum of 6 months of deprecation before removal in a major version release.
This means that any fields we want to change or remove need to be deprecated in or before the %15.6 release.
This issue is a collection point for API items that can be deprecated within this time-frame.
How to take part
Check our REST and GraphQL APIs. If you see a field or object that can be removed, add it directly to the list(s) below (along with any blockers). If you have one you're not sure about, open a discussion.
%15.9
Deprecation in-
confidential
field when creating a note by REST (https://docs.gitlab.com/ee/api/notes.html#create-new-issue-note) (BLOCKER: Must be aliased asinternal
first) -
confidential
field when creating a note by GraphQL (https://docs.gitlab.com/ee/api/graphql/reference/#mutationcreatenote) (BLOCKER: Must be aliased asinternal
first)
%16.0 (See #367923 (closed))
Removal in- Updating note confidentiality by GraphQL (https://docs.gitlab.com/ee/api/graphql/reference/#mutationupdatenote) (deprecated in %14.10)
- Updating note confidentiality by REST (https://docs.gitlab.com/ee/api/notes.html#modify-existing-issue-note) (deprecated in %14.10)
-
confidential
field when creating a note by REST (https://docs.gitlab.com/ee/api/notes.html#create-new-issue-note) -
end_date
in all Epics REST API calls (https://docs.gitlab.com/ee/api/epics.html) (deprecated in 11.3) -
start_date_from_milestones
in all Epics REST API calls (https://docs.gitlab.com/ee/api/epics.html) (deprecated in 11.3) -
due_date_from_milestones
in all Epics REST API calls (https://docs.gitlab.com/ee/api/epics.html) (deprecated in 11.3) -
assignee_username
in app/graphql/resolvers/issues/base_resolver.rb (deprecated in 13.11) -
start_date_*
/end_date_*
sort enums in https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/graphql/types/epic_sort_enum.rb#L10-13 (deprecated in 13.11) -
epics_count
in ee/app/graphql/types/boards/epic_list_type.rb (deprecated in 14.9)
Edited by Jan Provaznik