Read file

Read the content of a specified file.

GET /file/content

JavaScript

JavaScript

import { createCognitioClient } from "@cognitio/sdk

const client = createCognitioClient()
await client.file.read({
  ...
})

200

{
  "type": "text",
  "content": "<string>",
  "diff": "<string>",
  "patch": {
    "oldFileName": "<string>",
    "newFileName": "<string>",
    "hunks": [
      {
        "oldStart": 123,
        "oldLines": 123,
        "newStart": 123,
        "newLines": 123,
        "lines": [
          "<string>"
        ]
      }
    ],
    "oldHeader": "<string>",
    "newHeader": "<string>",
    "index": "<string>"
  },
  "encoding": "base64",
  "mimeType": "<string>"
}

Query Parameters

directory · string

workspace · string

path · string · required

Response

200 - application/json

File content

type · enum<string> · required

Available options: text, binary

content · string · required

diff · string

patch · object

Show child attributes

encoding · string

Allowed value: "base64"

mimeType · string