lp.code.interfaces.webservice.IGitRepositorySet : API documentation

Method	new	Create a Git repository and return it.
Method	getByPath	Find a repository by its path.
Method	getRepositories	Get all repositories for a target.
Method	getRepositoryVisibilityInfo	Return the named repositories visible to both user and person.
Method	getDefaultRepository	Get the default repository for a target.
Method	getDefaultRepositoryForOwner	Get a person's default repository for a target.
Method	setDefaultRepository	Set the default repository for a target.
Method	setDefaultRepositoryForOwner	Set a person's default repository for a target.
Method	empty_list	Return an empty collection of repositories.
Method	preloadDefaultRepositoriesForProjects	Get preloaded default repositories for a list of projects.

def new(registrant, owner, target, name, information_type=None, date_created=None):

Create a Git repository and return it.

Parameters	registrant	The `IPerson` who registered the new repository.
	owner	The `IPerson` who owns the new repository.
	target	The `IProduct`, `IDistributionSourcePackage`, or `IPerson` that the new repository is associated with.
	name	The repository name.
	information_type	Set the repository's information type to one different from the target's default. The type must conform to the target's code sharing policy. (optional)

@call_with(REQUEST_USER)
@operation_parameters(TextLine(_('Repository path'), True))
@operation_returns_entry(IGitRepository)
@export_read_operation()
@operation_for_version('devel')
def getByPath(user, path):

Find a repository by its path.

Any of these forms may be used:

Unique names:
    ~OWNER/PROJECT/+git/NAME
    ~OWNER/DISTRO/+source/SOURCE/+git/NAME
    ~OWNER/+git/NAME
Owner-target default aliases:
    ~OWNER/PROJECT
    ~OWNER/DISTRO/+source/SOURCE
Official aliases:
    PROJECT
    DISTRO/+source/SOURCE

Return None if no match was found.

@call_with(REQUEST_USER)
@operation_parameters(Reference(_('Target'), True, IHasGitRepositories))
@operation_returns_collection_of(IGitRepository)
@export_read_operation()
@operation_for_version('devel')
def getRepositories(user, target):

Get all repositories for a target.

Parameters	user	An `IPerson`. Only repositories visible by this user will be returned.
	target	An `IHasGitRepositories`.
Returns	A collection of `IGitRepository` objects.

@call_with(REQUEST_USER)
@operation_parameters(Reference(_('The person whose repository visibility is being checked.'), IPerson), List(Text(), _('List of repository unique names'), True))
@export_read_operation()
@operation_for_version('devel')
def getRepositoryVisibilityInfo(user, person, repository_names):

Return the named repositories visible to both user and person.

Anonymous requesters don't get any information.

Return a dict with the following values: person_name: the displayname of the person. visible_repositories: a list of the unique names of the repositories which the requester and specified person can both see.

This API call is provided for use by the client Javascript. It is not designed to efficiently scale to handle requests for large numbers of repositories.

Parameters	user	The user requesting the information. If the user is None then we return an empty dict.
	person	The person whose repository visibility we wish to check.
	repository_names	The unique names of the repositories to check.

@operation_parameters(Reference(_('Target'), True, IHasGitRepositories))
@operation_returns_entry(IGitRepository)
@export_read_operation()
@operation_for_version('devel')
def getDefaultRepository(target):

Get the default repository for a target.

Parameters	target	An `IHasGitRepositories`.
Returns	An `IGitRepository`, or None.
Raises	GitTargetError	if `target` is an `IPerson`.

@operation_parameters(Reference(_('Owner'), True, IPerson), Reference(_('Target'), True, IHasGitRepositories))
@operation_returns_entry(IGitRepository)
@export_read_operation()
@operation_for_version('devel')
def getDefaultRepositoryForOwner(owner, target):

Get a person's default repository for a target.

Parameters	owner	An `IPerson`.
	target	An `IHasGitRepositories`.
Returns	An `IGitRepository`, or None.
Raises	GitTargetError	if `target` is an `IPerson`.

@operation_parameters(Reference(_('Target'), True, IHasGitRepositories), Reference(_('Git repository'), False, IGitRepository))
@export_write_operation()
@operation_for_version('devel')
def setDefaultRepository(target, repository):

Set the default repository for a target.

Parameters	target	An `IHasGitRepositories`.
	repository	An `IGitRepository`, or None to unset the default repository.
Raises	GitTargetError	if `target` is an `IPerson`.

@call_with(REQUEST_USER)
@operation_parameters(Reference(_('Owner'), True, IPerson), Reference(_('Target'), True, IHasGitRepositories), Reference(_('Git repository'), False, IGitRepository))
@export_write_operation()
@operation_for_version('devel')
def setDefaultRepositoryForOwner(owner, target, repository, user):

Set a person's default repository for a target.

Parameters	owner	An `IPerson`.
	target	An `IHasGitRepositories`.
	repository	An `IGitRepository`, or None to unset the default repository.
	user	The `IPerson` who is making the change.
Raises	GitTargetError	if `target` is an `IPerson`.

l.c.i.w.IGitRepositorySet(Interface) : interface documentation