enso-org/enso
1
1
Fork 0
mirror of https://github.com/enso-org/enso.git synced 2024-12-25 03:22:43 +03:00
Code Issues Projects Releases Wiki Activity
a6d040ecf5
enso/docs/language-server/project-manager-http-endpoints.md
Hubert Plociniczak 0ab9fe7875
Add projectsDirectory parameter to project endpoint (#10481) 
This change adds a possibility to pass an optional parameter describing full path to projects' directory, in addition to the required project id.

Enables GUI to fix #10453.
2024-07-11 10:18:43 +00:00

1.3 KiB
Raw Blame History

layout title category tags order
developer-doc Project Manager HTTP Endpoints language-server
language-server
protocol
specification
7

HTTP Endpoints

Project Manager exposes a number of HTTP endpoints on the same socket as the JSONRPC protocol.

/projects/{project_id}/enso-project?projectsDirectory={projects_path}

HTTP endpoint that returns the project structure in .enso-project format. The optional projectsDirectory parameter allows the user to specify a custom path to projects' directory (e.g. if it is in a subfolder).

GET

Returns:

  • 200 OK with the body containing the project structure as a .tar.gz archive
  • 404 Not Found when the project cannot be found by the provided id
  • 500 Internal Server Error in case of errors

Request

> GET /projects/730a66ef-4222-46f8-8a03-d766946ab2bd/enso-project HTTP/1.1
> Host: localhost:30535
> User-Agent: curl/8.1.2
> Accept: */*

Response

< HTTP/1.1 200 OK
< Server: akka-http/10.2.10
< Date: Thu, 13 Jul 2023 16:20:08 GMT
< Content-Type: application/gzip
< Content-Length: 2527
<
[2527 bytes data]