Dependency Management

Operations related to dependency management.

Get a organization dependency

get
/organizations/{organizationId}/dependencies/{dependencyId}

Get a organization dependency by admin

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
dependencyIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/dependencies/{dependencyId}

Update a organization dependency

patch
/organizations/{organizationId}/dependencies/{dependencyId}

Update a organization dependency by admin

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
dependencyIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
isPrivatebooleanOptional

Dependency is private

Example: <isPrivate>
imageUrlstringOptional

Dependency image URL

Responses
chevron-right
200

OK

application/json
patch
/organizations/{organizationId}/dependencies/{dependencyId}

Get organization dependencies

get
/organizations/{organizationId}/dependencies

Get organization dependencies by admin

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
limitintegerOptional

The limit of per page

Default: 10
pageintegerOptional

Current page number

Default: 1
sortstringOptional

Sort

Example: {"value":"createdAt"}
textstringOptional

Text

isPrivatebooleanOptional

The is private to filter

Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/dependencies

Create a organization dependency

post
/organizations/{organizationId}/dependencies

Create a organization dependency by admin

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
namestring · min: 3 · max: 255Required

Dependency name

Example: <name>
readmestring · max: 1000Optional

Dependency readme

Example: <readme>
isPrivatebooleanOptional

Dependency is private

Example: <isPrivate>
Responses
post
/organizations/{organizationId}/dependencies
get
/public/dependencies/search

Search dependencies by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
namestringOptional

Dependency name

versionstringOptional

Dependency package version

Responses
chevron-right
200

OK

application/json
get
/public/dependencies/search

Check updates

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

Check updates by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
dependencyNamestringRequired

Dependency name

Query parameters
versionstringOptional

Dependency package version

Responses
chevron-right
200

OK

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

Get a dependency

get
/public/dependencies/{dependencyId}

Get a dependency by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
dependencyIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/public/dependencies/{dependencyId}

Last updated

Was this helpful?