mirror of
https://github.com/YunoHost/yunohost.git
synced 2024-09-03 20:06:10 +02:00
Uniformize API routes
This commit is contained in:
parent
f0827451ca
commit
82d5be6802
1 changed files with 48 additions and 75 deletions
|
@ -482,7 +482,7 @@ domain:
|
|||
- maindomain
|
||||
api:
|
||||
- GET /domains/main
|
||||
- PUT /domains/main
|
||||
- PUT /domains/<new_main_domain>/main
|
||||
arguments:
|
||||
-n:
|
||||
full: --new-main-domain
|
||||
|
@ -493,7 +493,7 @@ domain:
|
|||
### certificate_status()
|
||||
cert-status:
|
||||
action_help: List status of current certificates (all by default).
|
||||
api: GET /domains/cert-status/<domain_list>
|
||||
api: GET /domains/<domain_list>/cert
|
||||
arguments:
|
||||
domain_list:
|
||||
help: Domains to check
|
||||
|
@ -505,7 +505,7 @@ domain:
|
|||
### certificate_install()
|
||||
cert-install:
|
||||
action_help: Install Let's Encrypt certificates for given domains (all by default).
|
||||
api: POST /domains/cert-install/<domain_list>
|
||||
api: POST /domains/<domain_list>/cert
|
||||
arguments:
|
||||
domain_list:
|
||||
help: Domains for which to install the certificates
|
||||
|
@ -526,7 +526,7 @@ domain:
|
|||
### certificate_renew()
|
||||
cert-renew:
|
||||
action_help: Renew the Let's Encrypt certificates for given domains (all by default).
|
||||
api: POST /domains/cert-renew/<domain_list>
|
||||
api: PUT /domains/<domain_list>/cert/renew
|
||||
arguments:
|
||||
domain_list:
|
||||
help: Domains for which to renew the certificates
|
||||
|
@ -547,7 +547,7 @@ domain:
|
|||
### domain_url_available()
|
||||
url-available:
|
||||
action_help: Check availability of a web path
|
||||
api: GET /domain/urlavailable
|
||||
api: GET /domain/<domain>/urlavailable
|
||||
arguments:
|
||||
domain:
|
||||
help: The domain for the web path (e.g. your.domain.tld)
|
||||
|
@ -556,20 +556,6 @@ domain:
|
|||
path:
|
||||
help: The path to check (e.g. /coffee)
|
||||
|
||||
|
||||
### domain_info()
|
||||
# info:
|
||||
# action_help: Get domain informations
|
||||
# api: GET /domains/<domain>
|
||||
# arguments:
|
||||
# domain:
|
||||
# help: ""
|
||||
# extra:
|
||||
# pattern:
|
||||
# - '^([a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)(\.[a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)*(\.[a-zA-Z]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)$'
|
||||
# - "Must be a valid domain name (e.g. my-domain.org)"
|
||||
|
||||
|
||||
#############################
|
||||
# App #
|
||||
#############################
|
||||
|
@ -631,7 +617,7 @@ app:
|
|||
### app_map()
|
||||
map:
|
||||
action_help: Show the mapping between urls and apps
|
||||
api: GET /appsmap
|
||||
api: GET /apps/map
|
||||
arguments:
|
||||
-a:
|
||||
full: --app
|
||||
|
@ -679,7 +665,7 @@ app:
|
|||
### app_upgrade()
|
||||
upgrade:
|
||||
action_help: Upgrade app
|
||||
api: PUT /upgrade/apps
|
||||
api: PUT /apps/<app>/upgrade
|
||||
arguments:
|
||||
app:
|
||||
help: App(s) to upgrade (default all)
|
||||
|
@ -737,7 +723,6 @@ app:
|
|||
### app_register_url()
|
||||
register-url:
|
||||
action_help: Book/register a web path for a given app
|
||||
api: PUT /tools/registerurl
|
||||
arguments:
|
||||
app:
|
||||
help: App which will use the web path
|
||||
|
@ -761,7 +746,6 @@ app:
|
|||
### app_ssowatconf()
|
||||
ssowatconf:
|
||||
action_help: Regenerate SSOwat configuration file
|
||||
api: PUT /ssowatconf
|
||||
|
||||
### app_change_label()
|
||||
change-label:
|
||||
|
@ -776,7 +760,6 @@ app:
|
|||
### app_addaccess() TODO: Write help
|
||||
addaccess:
|
||||
action_help: Grant access right to users (everyone by default)
|
||||
api: PUT /access
|
||||
deprecated: true
|
||||
arguments:
|
||||
apps:
|
||||
|
@ -788,7 +771,6 @@ app:
|
|||
### app_removeaccess() TODO: Write help
|
||||
removeaccess:
|
||||
action_help: Revoke access right to users (everyone by default)
|
||||
api: DELETE /access
|
||||
deprecated: true
|
||||
arguments:
|
||||
apps:
|
||||
|
@ -800,7 +782,6 @@ app:
|
|||
### app_clearaccess()
|
||||
clearaccess:
|
||||
action_help: Reset access rights for the app
|
||||
api: POST /access
|
||||
deprecated: true
|
||||
arguments:
|
||||
apps:
|
||||
|
@ -866,7 +847,7 @@ backup:
|
|||
### backup_create()
|
||||
create:
|
||||
action_help: Create a backup local archive. If neither --apps or --system are given, this will backup all apps and all system parts. If only --apps if given, this will only backup apps and no system parts. Similarly, if only --system is given, this will only backup system parts and no apps.
|
||||
api: POST /backup
|
||||
api: POST /backups
|
||||
arguments:
|
||||
-n:
|
||||
full: --name
|
||||
|
@ -894,7 +875,7 @@ backup:
|
|||
### backup_restore()
|
||||
restore:
|
||||
action_help: Restore from a local backup archive. If neither --apps or --system are given, this will restore all apps and all system parts in the archive. If only --apps if given, this will only restore apps and no system parts. Similarly, if only --system is given, this will only restore system parts and no apps.
|
||||
api: POST /backup/restore/<name>
|
||||
api: PUT /backups/<name>/restore
|
||||
arguments:
|
||||
name:
|
||||
help: Name of the local backup archive
|
||||
|
@ -911,7 +892,7 @@ backup:
|
|||
### backup_list()
|
||||
list:
|
||||
action_help: List available local backup archives
|
||||
api: GET /backup/archives
|
||||
api: GET /backups
|
||||
arguments:
|
||||
-i:
|
||||
full: --with-info
|
||||
|
@ -925,7 +906,7 @@ backup:
|
|||
### backup_info()
|
||||
info:
|
||||
action_help: Show info about a local backup archive
|
||||
api: GET /backup/archives/<name>
|
||||
api: GET /backups/<name>
|
||||
arguments:
|
||||
name:
|
||||
help: Name of the local backup archive
|
||||
|
@ -941,7 +922,7 @@ backup:
|
|||
### backup_download()
|
||||
download:
|
||||
action_help: (API only) Request to download the file
|
||||
api: GET /backup/download/<name>
|
||||
api: GET /backups/<name>/download
|
||||
arguments:
|
||||
name:
|
||||
help: Name of the local backup archive
|
||||
|
@ -949,7 +930,7 @@ backup:
|
|||
### backup_delete()
|
||||
delete:
|
||||
action_help: Delete a backup archive
|
||||
api: DELETE /backup/archives/<name>
|
||||
api: DELETE /backups/<name>
|
||||
arguments:
|
||||
name:
|
||||
help: Name of the archive to delete
|
||||
|
@ -1016,7 +997,6 @@ service:
|
|||
### service_add()
|
||||
add:
|
||||
action_help: Add a service
|
||||
# api: POST /services
|
||||
arguments:
|
||||
name:
|
||||
help: Service name to add
|
||||
|
@ -1054,7 +1034,6 @@ service:
|
|||
### service_remove()
|
||||
remove:
|
||||
action_help: Remove a service
|
||||
# api: DELETE /services
|
||||
arguments:
|
||||
name:
|
||||
help: Service name to remove
|
||||
|
@ -1062,7 +1041,7 @@ service:
|
|||
### service_start()
|
||||
start:
|
||||
action_help: Start one or more services
|
||||
api: PUT /services/<names>
|
||||
api: PUT /services/<names>/start
|
||||
arguments:
|
||||
names:
|
||||
help: Service name to start
|
||||
|
@ -1072,7 +1051,7 @@ service:
|
|||
### service_stop()
|
||||
stop:
|
||||
action_help: Stop one or more services
|
||||
api: DELETE /services/<names>
|
||||
api: PUT /services/<names>/stop
|
||||
arguments:
|
||||
names:
|
||||
help: Service name to stop
|
||||
|
@ -1120,7 +1099,7 @@ service:
|
|||
### service_disable()
|
||||
disable:
|
||||
action_help: Disable one or more services
|
||||
api: DELETE /services/<names>/enable
|
||||
api: PUT /services/<names>/disable
|
||||
arguments:
|
||||
names:
|
||||
help: Service name to disable
|
||||
|
@ -1155,7 +1134,6 @@ service:
|
|||
### service_regen_conf()
|
||||
regen-conf:
|
||||
action_help: Regenerate the configuration file(s) for a service
|
||||
api: PUT /services/regenconf
|
||||
deprecated_alias:
|
||||
- regenconf
|
||||
arguments:
|
||||
|
@ -1207,19 +1185,10 @@ firewall:
|
|||
help: List forwarded ports with UPnP
|
||||
action: store_true
|
||||
|
||||
### firewall_reload()
|
||||
reload:
|
||||
action_help: Reload all firewall rules
|
||||
api: PUT /firewall
|
||||
arguments:
|
||||
--skip-upnp:
|
||||
help: Do not refresh port forwarding using UPnP
|
||||
action: store_true
|
||||
|
||||
### firewall_allow()
|
||||
allow:
|
||||
action_help: Allow connections on a port
|
||||
api: POST /firewall/port
|
||||
api: POST /firewall/<port>
|
||||
arguments:
|
||||
protocol:
|
||||
help: "Protocol type to allow (TCP/UDP/Both)"
|
||||
|
@ -1249,11 +1218,10 @@ firewall:
|
|||
help: Do not reload firewall rules
|
||||
action: store_true
|
||||
|
||||
|
||||
### firewall_disallow()
|
||||
disallow:
|
||||
action_help: Disallow connections on a port
|
||||
api: DELETE /firewall/port
|
||||
api: DELETE /firewall/<port>
|
||||
arguments:
|
||||
protocol:
|
||||
help: "Protocol type to allow (TCP/UDP/Both)"
|
||||
|
@ -1281,11 +1249,10 @@ firewall:
|
|||
help: Do not reload firewall rules
|
||||
action: store_true
|
||||
|
||||
|
||||
### firewall_upnp()
|
||||
upnp:
|
||||
action_help: Manage port forwarding using UPnP
|
||||
api: GET /firewall/upnp
|
||||
api: PUT /firewall/upnp/<action>
|
||||
arguments:
|
||||
action:
|
||||
choices:
|
||||
|
@ -1299,10 +1266,19 @@ firewall:
|
|||
help: Do not refresh port forwarding
|
||||
action: store_true
|
||||
|
||||
|
||||
### firewall_reload()
|
||||
reload:
|
||||
action_help: Reload all firewall rules
|
||||
arguments:
|
||||
--skip-upnp:
|
||||
help: Do not refresh port forwarding using UPnP
|
||||
action: store_true
|
||||
|
||||
### firewall_stop()
|
||||
stop:
|
||||
action_help: Stop iptables and ip6tables
|
||||
api: DELETE /firewall
|
||||
|
||||
|
||||
|
||||
|
||||
|
@ -1316,7 +1292,6 @@ dyndns:
|
|||
### dyndns_subscribe()
|
||||
subscribe:
|
||||
action_help: Subscribe to a DynDNS service
|
||||
api: POST /dyndns
|
||||
arguments:
|
||||
--subscribe-host:
|
||||
help: Dynette HTTP API to subscribe to
|
||||
|
@ -1333,7 +1308,6 @@ dyndns:
|
|||
### dyndns_update()
|
||||
update:
|
||||
action_help: Update IP on DynDNS platform
|
||||
api: PUT /dyndns
|
||||
arguments:
|
||||
--dyn-host:
|
||||
help: Dynette DNS server to inform
|
||||
|
@ -1489,7 +1463,9 @@ tools:
|
|||
### tools_regen_conf()
|
||||
regen-conf:
|
||||
action_help: Regenerate the configuration file(s)
|
||||
api: PUT /tools/regenconf
|
||||
api:
|
||||
- PUT /regenconf
|
||||
- PUT /regenconf/<names>
|
||||
arguments:
|
||||
names:
|
||||
help: Categories to regenerate configuration of (all by default)
|
||||
|
@ -1538,7 +1514,7 @@ tools:
|
|||
### tools_migrations_run()
|
||||
run:
|
||||
action_help: Run migrations
|
||||
api: POST /migrations/run
|
||||
api: PUT /migrations/<targets>
|
||||
deprecated_alias:
|
||||
- migrate
|
||||
arguments:
|
||||
|
@ -1561,7 +1537,6 @@ tools:
|
|||
### tools_migrations_state()
|
||||
state:
|
||||
action_help: Show current migrations state
|
||||
api: GET /migrations/state
|
||||
|
||||
|
||||
#############################
|
||||
|
@ -1590,7 +1565,6 @@ hook:
|
|||
### hook_info()
|
||||
info:
|
||||
action_help: Get information about a given hook
|
||||
api: GET /hooks/<action>/<name>
|
||||
arguments:
|
||||
action:
|
||||
help: Action name
|
||||
|
@ -1600,7 +1574,6 @@ hook:
|
|||
### hook_list()
|
||||
list:
|
||||
action_help: List available hooks for an action
|
||||
api: GET /hooks/<action>
|
||||
arguments:
|
||||
action:
|
||||
help: Action name
|
||||
|
@ -1620,7 +1593,6 @@ hook:
|
|||
### hook_callback()
|
||||
callback:
|
||||
action_help: Execute all scripts binded to an action
|
||||
api: POST /hooks/<action>
|
||||
arguments:
|
||||
action:
|
||||
help: Action name
|
||||
|
@ -1716,7 +1688,7 @@ log:
|
|||
### log_share()
|
||||
share:
|
||||
action_help: Share the full log on yunopaste (alias to show --share)
|
||||
api: GET /logs/share
|
||||
api: GET /logs/<path>/share
|
||||
arguments:
|
||||
path:
|
||||
help: Log file to share
|
||||
|
@ -1731,11 +1703,11 @@ diagnosis:
|
|||
|
||||
list:
|
||||
action_help: List diagnosis categories
|
||||
api: GET /diagnosis/list
|
||||
api: GET /diagnosis/categories
|
||||
|
||||
show:
|
||||
action_help: Show most recents diagnosis results
|
||||
api: GET /diagnosis/show
|
||||
api: GET /diagnosis
|
||||
arguments:
|
||||
categories:
|
||||
help: Diagnosis categories to display (all by default)
|
||||
|
@ -1753,9 +1725,20 @@ diagnosis:
|
|||
help: Show a human-readable output
|
||||
action: store_true
|
||||
|
||||
get:
|
||||
action_help: Low-level command to fetch raw data and status about a specific diagnosis test
|
||||
api: GET /diagnosis/<category>
|
||||
arguments:
|
||||
category:
|
||||
help: Diagnosis category to fetch results from
|
||||
item:
|
||||
help: "List of criteria describing the test. Must correspond exactly to the 'meta' infos in 'yunohost diagnosis show'"
|
||||
metavar: CRITERIA
|
||||
nargs: "*"
|
||||
|
||||
run:
|
||||
action_help: Run diagnosis
|
||||
api: POST /diagnosis/run
|
||||
api: PUT /diagnosis/run
|
||||
arguments:
|
||||
categories:
|
||||
help: Diagnosis categories to run (all by default)
|
||||
|
@ -1786,13 +1769,3 @@ diagnosis:
|
|||
help: List active ignore filters
|
||||
action: store_true
|
||||
|
||||
get:
|
||||
action_help: Low-level command to fetch raw data and status about a specific diagnosis test
|
||||
api: GET /diagnosis/item/<category>
|
||||
arguments:
|
||||
category:
|
||||
help: Diagnosis category to fetch results from
|
||||
item:
|
||||
help: "List of criteria describing the test. Must correspond exactly to the 'meta' infos in 'yunohost diagnosis show'"
|
||||
metavar: CRITERIA
|
||||
nargs: "*"
|
||||
|
|
Loading…
Add table
Reference in a new issue