Public

Operations related to the public endpoints

get
/public/dependencies/search

Search dependencies by organization user

Authorizations
Query parameters
namestringOptional

The name of the dependency

versionstringOptional

The version of the dependency package

Responses
200

OK

application/json
get
/public/dependencies/search
GET /api/public/dependencies/search HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "assetUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
  "isPrivate": true,
  "readme": "This is a readme",
  "_id": "63ea10b94a472e003305232b",
  "versionNumber": "1.0.0",
  "publisher": {
    "_id": "63ea10b94a472e003305232b",
    "firstName": "Buğrahan",
    "lastName": "Öztürk"
  },
  "dependency": "63ea10b94a472e003305232b",
  "checksum": "98d389976bf86ad8d898bee3db0da9e0618b969dbd87bb6ea0973b445d7e304",
  "rank": 81001623508.4455,
  "envVersionNumber": "1.0.1",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Check updates

get
/public/dependencies/check-updates/{dependencyName}

Check updates by organization user

Authorizations
Path parameters
dependencyNamestringRequired

The name of the dependency

Query parameters
versionstringOptional

The version of the dependency package

Responses
200

OK

application/json
get
/public/dependencies/check-updates/{dependencyName}
GET /api/public/dependencies/check-updates/{dependencyName} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "currentVersion": "1.1.0",
  "assetUrl": "https://mobile-statics.s3.eu-central-1.amazonaws.com/projects_statics/dependencies/test-plugin2/test-plugin2-1.0.0.tgz",
  "newVersionAssetUrl": "https://mobile-statics.s3.eu-central-1.amazonaws.com/projects_statics/dependencies/test-plugin2/test-plugin2-1.1.0.tgz",
  "isUpdateAvailable": true
}

Get dependency packages

get
/public/dependencies/{dependencyId}/packages

Get dependency packages by organization user

Authorizations
Path parameters
dependencyIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$
Query parameters
envVersionNumberstringOptional

The env version number

versionNumberstringOptional

The version number

Responses
200

OK

application/json
Responseall of
and
get
/public/dependencies/{dependencyId}/packages
GET /api/public/dependencies/{dependencyId}/packages HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "totalDocs": 100,
  "limit": 10,
  "page": 1,
  "totalPages": 10,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": 1,
  "nextPage": 3,
  "docs": [
    {
      "assetUrl": "https://akinon.com/wp-content/uploads/akinon-logo-2.svg",
      "isPrivate": true,
      "readme": "This is a readme",
      "_id": "63ea10b94a472e003305232b",
      "versionNumber": "1.0.0",
      "publisher": {
        "_id": "63ea10b94a472e003305232b",
        "firstName": "Buğrahan",
        "lastName": "Öztürk"
      },
      "dependency": "63ea10b94a472e003305232b",
      "checksum": "98d389976bf86ad8d898bee3db0da9e0618b969dbd87bb6ea0973b445d7e304",
      "rank": 81001623508.4455,
      "envVersionNumber": "1.0.1",
      "createdAt": "2020-07-23T12:00:00.000Z",
      "updatedAt": "2020-07-23T12:00:00.000Z"
    }
  ]
}

Get a dependency

get
/public/dependencies/{dependencyId}

Get a dependency by organization user

Authorizations
Path parameters
dependencyIdstringRequired

The MongoDB ID

Example: 63ea10b94a472e003305232bPattern: ^[0-9a-fA-F]{24}$
Responses
200

OK

application/json
get
/public/dependencies/{dependencyId}
GET /api/public/dependencies/{dependencyId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "isPrivate": true,
  "readme": "This is a readme",
  "isVisible": true,
  "_id": "63ea10b94a472e003305232b",
  "name": "akinon-cli",
  "organization": "6131198510b4640b303ebf1b",
  "createdAt": "2020-07-23T12:00:00.000Z",
  "updatedAt": "2020-07-23T12:00:00.000Z"
}

Get a invitation

get
/public/invitations/{token}/check

Get a invitation code status

Authorizations
Path parameters
tokenstringRequired
Responses
200

OK

application/json
Responsestring · enumPossible values:
get
/public/invitations/{token}/check
GET /api/public/invitations/{token}/check HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

registered

Last updated

Was this helpful?