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

GET

N/A

N/A

Description

Get repository information

Input

...

Code Block
Type: application/json

Input

Source

Required

Type

Description

id

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": {
    "_id": "5f3bbce9678313ab12886387",
    "domain": "github.com",
    "repository": "soajs/soajs.repositories",
    "name": "soajs.repositories",
    "owner": "soajs",
    "provider": "github",
    "source": [
      {
        "name": "soajs",
        "ts": 1597750520718
      }
    ],
    "ts": 1597750520718,
    "type": "repository"
  }
}

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

602

Model error: + %model_error%

405

Repository not found.