gitea/src/c521f8c3-4e01-4c1a-8f68-f3e...
Robot 12042ffd4d
update 2024-04-07 13:20:18
2024-04-07 13:20:22 +02:00
..
README.md update 2023-10-10 10:16:07 2023-10-10 11:39:23 +02:00
code.php first commit 2023-04-15 17:08:07 +02:00
code.power first commit 2023-04-15 17:08:07 +02:00
settings.json update 2024-04-07 13:20:18 2024-04-07 13:20:22 +02:00

README.md

██████╗  ██████╗ ██╗    ██╗███████╗██████╗
██╔══██╗██╔═══██╗██║    ██║██╔════╝██╔══██╗
██████╔╝██║   ██║██║ █╗ ██║█████╗  ██████╔╝
██╔═══╝ ██║   ██║██║███╗██║██╔══╝  ██╔══██╗
██║     ╚██████╔╝╚███╔███╔╝███████╗██║  ██║
╚═╝      ╚═════╝  ╚══╝╚══╝ ╚══════╝╚═╝  ╚═╝

class Keys (Details)

namespace: VDM\Joomla\Gitea\User extends: Api

@startuml
class Keys  #Gold {
  + create(string $title, string $key, ...) : ?object
  + list(?string $fingerprint = null, int $page = 1, ...) : ?array
  + get(int $id) : ?object
  + delete(int $id) : string
}

note right of Keys::create
  Create a public key for the authenticated user.

  since: 3.2.0
  return: ?object
  
  arguments:
    string $title
    string $key
    bool $readOnly = false
end note

note right of Keys::list
  List the authenticated user's public keys.

  since: 3.2.0
  return: ?array
  
  arguments:
    ?string $fingerprint = null
    int $page = 1
    int $limit = 10
end note

note right of Keys::get
  Get a public key for the authenticated user.

  since: 3.2.0
  return: ?object
end note

note right of Keys::delete
  Delete a public key for the authenticated user.

  since: 3.2.0
  return: string
end note
 
@enduml

     ██╗ ██████╗██████╗
     ██║██╔════╝██╔══██╗
     ██║██║     ██████╔╝
██   ██║██║     ██╔══██╗
╚█████╔╝╚██████╗██████╔╝
 ╚════╝  ╚═════╝╚═════╝

Build with Joomla Component Builder