Skip to content
This repository has been archived by the owner on Aug 31, 2021. It is now read-only.

apis

Jump to bottom
Marcel Kloubert edited this page Mar 16, 2018 · 27 revisions

Home >> Settings >> APIs

[!!!IN DEVELOPMENT!!!] APIs

Endpoints

[GET] /api

Returns general information.

Request

GET /api HTTP/1.1
Host: localhost
Possible reponse
HTTP/1.1 200 OK
X-Powered-By: Express
Content-type: application/json; charset=utf-8
Content-Length: 324
Date: Fri, 16 Mar 2018 06:03:20 GMT
Connection: keep-alive

{
  "success": true,
  "code": 0,
  "host": {
    "os": "win32"
  },
  "me": {
    "address": "::ffff:127.0.0.1",
    "port": 5979
  },
  "message": "OK",
  "vscode": {
    "eol": "\r\n",
    "name": "Visual Studio Code",
    "node": {
      "v8": "5.8.283.38",
      "version": "7.9.0"
    },
    "version": "1.21.1"
  }
}

[GET] /api/editors

Returns a list of all editors.

Request

GET /api/editors HTTP/1.1
Host: localhost
Possible reponse
HTTP/1.1 200 OK
X-Powered-By: Express
Content-type: application/json; charset=utf-8
Content-Length: 233
Date: Fri, 16 Mar 2018 06:07:30 GMT
Connection: keep-alive

{
  "success": true,
  "code": 0,
  "message": "OK",
  "data": [
    {
      "index": 0,
      "isActive": true,
      "document": {
        "eol": "\n",
        "isDirty": false,
        "language": "jsonc",
        "lines": 39,
        "resources": {
          "_self": "/api/editors/0",
          "content": "/api/editors/0/content"
        },
        "version": 1
      }
    }
  ]
}

[GET] /api/editors/:index

Returns information about an editor.

Request

GET /api/editors/0 HTTP/1.1
Host: localhost
Possible reponse
HTTP/1.1 200 OK
X-Powered-By: Express
Content-type: application/json; charset=utf-8
Content-Length: 231
Date: Fri, 16 Mar 2018 06:09:23 GMT
Connection: keep-alive

{
  "success": true,
  "code": 0,
  "message": "OK",
  "data": {
    "index": 0,
    "isActive": true,
    "document": {
      "eol": "\n",
      "isDirty": false,
      "language": "jsonc",
      "lines": 39,
      "resources": {
        "_self": "/api/editors/0",
        "content": "/api/editors/0/content"
      },
      "version": 1
    }
  }
}

[GET] /api/editors/:index/content

Returns the content of an editor.

Request

GET /api/editors/0/content HTTP/1.1
Host: localhost
Possible reponse
HTTP/1.1 200 OK
X-Powered-By: Express
Content-type: text/plain; charset=utf-8
X-Vscode-Deploy-Reloaded-Lang: plaintext
Content-Length: 889
Date: Fri, 16 Mar 2018 06:18:44 GMT
Connection: keep-alive

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

[POST] /api/messages

Shows a popup in the remote editor.

Request

POST /api/messages HTTP/1.1
Host: localhost

{
    "message": "Test message",
    "type": "error"
}

Possible values for type, which is optional, are:

  • e, err, error
  • i, info, information
  • w, warn, warning

Response

HTTP/1.1 204 No Content
X-Powered-By: Express
Date: Fri, 16 Mar 2018 06:24:02 GMT
Connection: keep-alive
Clone this wiki locally