Versions Compared

Key

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

General Information

...

Service

API

Method

Data Models

Workflow

repositories

/git/sync/branch

PUT

N/A

N/A

Description

Sync branch and update the corresponding catalog

Input

...

Code Block
Type: application/json

Input

Source

Required

Type

Description

id

query

Yes

string

owner

query

Yes

string

provider

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": {
    "repository": "soajs/soajs.repositories",
    "status": "active",
    "name": "repositories",
    "type": "service",
    "swagger": false,
    "branch": "develop"
  }
}

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

Git Account does not exist.

405

Repository not found.

409

Repository is not active.

410

Branch is not found

415

Branch is not active

602

Model error: + %model_error%

603

Provider not found.