Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

Service

API

Method

Data Models

Workflow

repositories

/git/repo/file

GET

N/A

N/A

Description

Get a file from the repository

Input

...

Code Block
Type: application/json

Input

Source

Required

Type

Description

accountId

query

Yes

string

repo

query

Yes

string

filepath

query

Yes

string

branch

query

Yes

string

Output

...

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

Expand
titleSAMPLE
Code Block
languagejson
{
  "result": true,
  "data": {
    "content": "/**\n * @license\n * Copyright SOAJS All Rights Reserved."
     "path": "config.js",
    "repository": "soajs/soajs.repositories"
  }
}

Invalid Response

Expand
titleSAMPLE
Code Block
{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

...

Code

Description

403

Repository not found.

602

Model error: + %model_error%

603

Provider not found.

604

error: + %model_error%