gitea/src/754d737c-3b6f-43f0-8974-2e06a3daf41e/README.md

136 lines
3.3 KiB
Markdown
Raw Normal View History

2023-04-15 15:08:07 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
# class Releases (Details)
> namespace: **VDM\Joomla\Gitea\Repository**
2023-10-10 09:39:23 +00:00
> extends: **Api**
2023-04-15 15:08:07 +00:00
```uml
@startuml
class Releases #Gold {
+ list(string $ownerName, string $repoName, ...) : ?array
+ create(string $ownerName, string $repoName, ...) : ?object
+ get(string $ownerName, string $repoName, ...) : ?object
+ delete(string $ownerName, string $repoName, ...) : string
+ update(string $ownerName, string $repoName, ...) : ?object
+ getByTag(string $ownerName, string $repoName, ...) : ?object
+ deleteByTag(string $ownerName, string $repoName, ...) : string
}
note right of Releases::list
List a repo's releases.
since: 3.2.0
return: ?array
arguments:
string $ownerName
string $repoName
?bool $draft = null
?bool $preRelease = null
int $page = 1
int $limit = 10
end note
note right of Releases::create
Create a release.
since: 3.2.0
return: ?object
arguments:
string $ownerName
string $repoName
string $tagName
string $targetCommitish
string $releaseName
string $releaseBody
bool $isDraft = false
bool $isPrerelease = false
end note
note right of Releases::get
Get a release by ID.
since: 3.2.0
return: ?object
arguments:
string $ownerName
string $repoName
int $releaseId
end note
note right of Releases::delete
Delete a release by ID.
since: 3.2.0
return: string
arguments:
string $ownerName
string $repoName
int $releaseId
end note
note right of Releases::update
Update a release.
since: 3.2.0
return: ?object
arguments:
string $ownerName
string $repoName
int $releaseId
?string $tagName = null
?string $targetCommitish = null
?string $releaseName = null
?string $description = null
?bool $isDraft = null
?bool $isPrerelease = null
end note
note right of Releases::getByTag
Get a release by tag name.
since: 3.2.0
return: ?object
arguments:
string $ownerName
string $repoName
string $tagName
end note
note right of Releases::deleteByTag
Delete a release by tag name.
since: 3.2.0
return: string
arguments:
string $ownerName
string $repoName
string $tagName
end note
@enduml
```
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)