TagAPI

TagAPI

API for the Tag entities, which give extra visual information about a given entity.

Constructor

new TagAPI()

Source:

Methods

(async, static) createTag(payload) → {Promise}

Creates a new tag with the provided information.
Source:
Parameters:
Name Type Description
payload Tag An object that contains information about a tag.
Returns:
Type:
Promise
The created person.

(async, static) deleteTag(name) → {Promise}

Deletes the tag with the provided name.
Source:
Parameters:
Name Type Description
name String The name of the tag.
Returns:
Type:
Promise
Empty response.

(async, static) getTag(name) → {Promise}

Returns the tag with the provided name.
Source:
Parameters:
Name Type Description
name String The name of the tag.
Returns:
Type:
Promise
The tag requested.

(async, static) listTags(options) → {Promise}

Returns all tags in the registry.
Source:
Parameters:
Name Type Description
options Object An object of options to configure the query and its results.
Returns:
Type:
Promise
The tag result list.

(async, static) updateTag(name, payload) → {Promise}

Updates the tag with the provided information.
Source:
Parameters:
Name Type Description
name String The name of the tag.
payload Object An object that contains information about a tag.
Returns:
Type:
Promise
The updated tag.