Skip to content

Add resource references endpoint

Enrique Alcántara requested to merge 428324-get-resource-references-endpoint into master

What does this MR do and why?

It introduces a new endpoint to obtain a collection of references to VsCode Setting resources. The endpoint's response has the following shape:

[
  {
    "url": "/vscode/settings/v1/resource/globalState/[:id]",
    "created": 1123123423
  }
]

The client can use the "url" to obtain the actual resource.

Context

The Settings Sync REST API is GiLab's implementation of the backend used by VSCode's Settings Sync feature. The Web IDE, based on VSCode, relies on settings sync to persist settings, installed extensions, and other user preferences after the user signs out of the GitLab application. You can read more about the problem that we are solving and the proposed solution in &11147.

Screenshots or screen recordings

No user-facing changes in this merge request

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #428324 (closed)

Edited by Enrique Alcántara

Merge request reports