diff options
Diffstat (limited to 'data/deprecations/15-9-remove-offset-pagination-jobs-api.yml')
| -rw-r--r-- | data/deprecations/15-9-remove-offset-pagination-jobs-api.yml | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/data/deprecations/15-9-remove-offset-pagination-jobs-api.yml b/data/deprecations/15-9-remove-offset-pagination-jobs-api.yml new file mode 100644 index 00000000000..8c3406a34e3 --- /dev/null +++ b/data/deprecations/15-9-remove-offset-pagination-jobs-api.yml @@ -0,0 +1,23 @@ +# +# REQUIRED FIELDS +# +- title: "Remove offset pagination from Jobs API" # (required) Clearly explain the change. For example, "The `confidential` field for a `Note` is removed" or "CI/CD job names are limited to 250 characters." + announcement_milestone: "15.9" # (required) The milestone when this feature was deprecated. + announcement_date: "2023-02-22" # (required) The date of the milestone release when this feature was deprecated. This should almost always be the 22nd of a month (YYYY-MM-DD), unless you did an out of band blog post. + removal_milestone: "16.0" # (required) The milestone when this feature is being removed. + removal_date: "2023-05-22" # (required) This should almost always be the 22nd of a month (YYYY-MM-DD), the date of the milestone release when this feature will be removed. + breaking_change: true # (required) Change to false if this is not a breaking change. + reporter: jheimbuck_gl # (required) GitLab username of the person reporting the removal + stage: Verify # (required) String value of the stage that the feature was created in. e.g., Growth + issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/367537 # (required) Link to the deprecation issue in GitLab + body: | # (required) Do not modify this line, instead modify the lines below. + A request to the API for `/api/v4/projects/:id/jobs` can return a paginated list of jobs. Projects can contain hundreds or thousands of jobs, so using an offset to paginate through them is slow. Users should instead use [`keyset-based pagination`](https://docs.gitlab.com/ee/api/rest/index.html#keyset-based-pagination) when requesting consecutive pages of results. + + In milestone 16.0 we will remove offset-based pagination. +# +# OPTIONAL FIELDS +# + tiers: # (optional - may be required in the future) An array of tiers that the feature is available in currently. e.g., [Free, Silver, Gold, Core, Premium, Ultimate] + documentation_url: "https://docs.gitlab.com/ee/api/jobs.html#list-project-jobs" # (optional) This is a link to the current documentation page + image_url: # (optional) This is a link to a thumbnail image depicting the feature + video_url: # (optional) Use the youtube thumbnail URL with the structure of https://img.youtube.com/vi/UNIQUEID/hqdefault.jpg |