Notebooks 2.0 // Backend // Workspace Details API // Fetch YAML

[mohamedch7]

The workspace details flyover includes a YAML viewer for the Workspace. This issue involves implementing the backend functionality to fetch the Workspace YAML.

Details

• A new HTTP path needs to be added to fetch the Workspace YAML.
• Proposed path:
  GET /api/v1/workspaces/{namespace}/{name}/details/yaml
• Note: There will likely be other /details/ paths and possibly /actions/ paths in the future at the same depth.

Possible JSON Payloads

Two options are being considered for the response format:

Option 1:
A normal envelope (JSON with a "data" field at the root), containing a YAML string of the Workspace YAML as the data payload.
Example:

{
  "data": "apiVersion: v1\nkind: Workspace\nmetadata:\n  name: example"
}

Option 2: JSON with a Base64-encoded YAML string under yaml_b64

{
  "yaml_b64": "encoded_yaml_string_here"
}

• This avoids escape character issues.

[ederign]

/assign @mohamedch7

[ederign]

Option 3:
GET /api/v1/workspaces/{namespace}/{name}/details/yaml
Content-Type: text/yaml

[ederign]

I would go for option 1.