gitea/src/f428beab-10f4-4c0d-bb9e-8c797ed7a7c9/README.md

106 lines
2.7 KiB
Markdown
Raw Normal View History

2023-04-15 15:08:07 +00:00
```
██████╗ ██████╗ ██╗ ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║ ██║██╔════╝██╔══██╗
██████╔╝██║ ██║██║ █╗ ██║█████╗ ██████╔╝
██╔═══╝ ██║ ██║██║███╗██║██╔══╝ ██╔══██╗
██║ ╚██████╔╝╚███╔███╔╝███████╗██║ ██║
╚═╝ ╚═════╝ ╚══╝╚══╝ ╚══════╝╚═╝ ╚═╝
```
# class Milestones (Details)
> namespace: **VDM\Joomla\Gitea\Issue**
2023-10-10 09:39:23 +00:00
> extends: **Api**
2023-04-15 15:08:07 +00:00
```uml
@startuml
class Milestones #Gold {
+ create(string $owner, string $repo, ...) : ?object
+ list(string $owner, string $repo, ...) : ?array
+ get(string $owner, string $repo, ...) : ?object
+ delete(string $owner, string $repo, ...) : string
+ update(string $owner, string $repo, ...) : ?object
}
note right of Milestones::create
Create a milestone.
since: 3.2.0
return: ?object
arguments:
string $owner
string $repo
string $title
?string $description = null
?string $dueOn = null
?string $state = 'open'
end note
note right of Milestones::list
Get all of a repository's opened milestones.
since: 3.2.0
return: ?array
arguments:
string $owner
string $repo
?string $state = 'open'
?string $name = null
?int $page = null
?int $limit = null
end note
note right of Milestones::get
Get a milestone.
since: 3.2.0
return: ?object
arguments:
string $owner
string $repo
string $milestoneId
end note
note right of Milestones::delete
Delete a milestone.
since: 3.2.0
return: string
arguments:
string $owner
string $repo
string $milestoneId
end note
note right of Milestones::update
Update a milestone.
since: 3.2.0
return: ?object
arguments:
string $owner
string $repo
string $milestoneId
string $title = null
string $description = null
string $dueOn = null
string $state = null
end note
@enduml
```
---
```
██╗ ██████╗██████╗
██║██╔════╝██╔══██╗
██║██║ ██████╔╝
██ ██║██║ ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
╚════╝ ╚═════╝╚═════╝
```
> Build with [Joomla Component Builder](https://git.vdm.dev/joomla/Component-Builder)