1
0
Fork 0
mirror of https://github.com/ansible-collections/hetzner.hcloud.git synced 2026-02-04 08:01:49 +00:00

doc: do not use type: complex for return values

This commit is contained in:
jo 2025-12-17 15:45:20 +01:00
parent 10c0e14d9d
commit 67164a5fd8
No known key found for this signature in database
GPG key ID: B2FEC9B22722B984
31 changed files with 42 additions and 42 deletions

View file

@ -105,7 +105,7 @@ RETURN = """
hcloud_certificate: hcloud_certificate:
description: The certificate instance description: The certificate instance
returned: Always returned: Always
type: complex type: dict
contains: contains:
id: id:
description: Numeric identifier of the certificate description: Numeric identifier of the certificate

View file

@ -46,7 +46,7 @@ RETURN = """
hcloud_certificate_info: hcloud_certificate_info:
description: The certificate instances description: The certificate instances
returned: Always returned: Always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the certificate description: Numeric identifier of the certificate

View file

@ -65,7 +65,7 @@ hcloud_datacenter_info:
description: description:
- The datacenter info as list - The datacenter info as list
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the datacenter description: Numeric identifier of the datacenter

View file

@ -108,7 +108,7 @@ RETURN = """
hcloud_floating_ip: hcloud_floating_ip:
description: The Floating IP instance description: The Floating IP instance
returned: Always returned: Always
type: complex type: dict
contains: contains:
id: id:
description: ID of the Floating IP description: ID of the Floating IP

View file

@ -50,7 +50,7 @@ RETURN = """
hcloud_floating_ip_info: hcloud_floating_ip_info:
description: The Floating ip infos as list description: The Floating ip infos as list
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the Floating IP description: Numeric identifier of the Floating IP

View file

@ -63,7 +63,7 @@ RETURN = """
hcloud_image_info: hcloud_image_info:
description: The image infos as list description: The image infos as list
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the image description: Numeric identifier of the image

View file

@ -59,7 +59,7 @@ RETURN = """
hcloud_iso_info: hcloud_iso_info:
description: The ISO type infos as list description: The ISO type infos as list
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: ID of the ISO description: ID of the ISO

View file

@ -93,7 +93,7 @@ RETURN = """
hcloud_load_balancer: hcloud_load_balancer:
description: The Load Balancer instance description: The Load Balancer instance
returned: Always returned: Always
type: complex type: dict
contains: contains:
id: id:
description: Numeric identifier of the Load Balancer description: Numeric identifier of the Load Balancer

View file

@ -52,7 +52,7 @@ RETURN = """
hcloud_load_balancer_info: hcloud_load_balancer_info:
description: The load_balancer infos as list description: The load_balancer infos as list
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the Load Balancer description: Numeric identifier of the Load Balancer
@ -101,7 +101,7 @@ hcloud_load_balancer_info:
targets: targets:
description: The targets of the Load Balancer description: The targets of the Load Balancer
returned: always returned: always
type: complex type: list
contains: contains:
type: type:
description: Type of the Load Balancer Target description: Type of the Load Balancer Target
@ -155,7 +155,7 @@ hcloud_load_balancer_info:
services: services:
description: all services from this Load Balancer description: all services from this Load Balancer
returned: Always returned: Always
type: complex type: list
contains: contains:
listen_port: listen_port:
description: The port the service listens on, i.e. the port users can connect to. description: The port the service listens on, i.e. the port users can connect to.
@ -182,7 +182,7 @@ hcloud_load_balancer_info:
http: http:
description: Configuration for HTTP and HTTPS services description: Configuration for HTTP and HTTPS services
returned: always returned: always
type: complex type: dict
contains: contains:
cookie_name: cookie_name:
description: Name of the cookie which will be set when you enable sticky sessions description: Name of the cookie which will be set when you enable sticky sessions
@ -212,7 +212,7 @@ hcloud_load_balancer_info:
health_check: health_check:
description: Configuration for health checks description: Configuration for health checks
returned: always returned: always
type: complex type: dict
contains: contains:
protocol: protocol:
description: Protocol the health checks will be performed over description: Protocol the health checks will be performed over
@ -242,7 +242,7 @@ hcloud_load_balancer_info:
http: http:
description: Additional Configuration of health checks with protocol http/https description: Additional Configuration of health checks with protocol http/https
returned: always returned: always
type: complex type: dict
contains: contains:
domain: domain:
description: Domain we will set within the HTTP HOST header description: Domain we will set within the HTTP HOST header

View file

@ -81,7 +81,7 @@ RETURN = """
hcloud_load_balancer_network: hcloud_load_balancer_network:
description: The relationship between a Load Balancer and a network description: The relationship between a Load Balancer and a network
returned: always returned: always
type: complex type: dict
contains: contains:
network: network:
description: Name of the Network description: Name of the Network

View file

@ -157,7 +157,7 @@ RETURN = """
hcloud_load_balancer_service: hcloud_load_balancer_service:
description: The Load Balancer service instance description: The Load Balancer service instance
returned: Always returned: Always
type: complex type: dict
contains: contains:
load_balancer: load_balancer:
description: The name of the Load Balancer where the service belongs to description: The name of the Load Balancer where the service belongs to
@ -189,7 +189,7 @@ hcloud_load_balancer_service:
http: http:
description: Configuration for HTTP and HTTPS services description: Configuration for HTTP and HTTPS services
returned: always returned: always
type: complex type: dict
contains: contains:
cookie_name: cookie_name:
description: Name of the cookie which will be set when you enable sticky sessions description: Name of the cookie which will be set when you enable sticky sessions
@ -219,7 +219,7 @@ hcloud_load_balancer_service:
health_check: health_check:
description: Configuration for health checks description: Configuration for health checks
returned: always returned: always
type: complex type: dict
contains: contains:
protocol: protocol:
description: Protocol the health checks will be performed over description: Protocol the health checks will be performed over
@ -249,7 +249,7 @@ hcloud_load_balancer_service:
http: http:
description: Additional Configuration of health checks with protocol http/https description: Additional Configuration of health checks with protocol http/https
returned: always returned: always
type: complex type: dict
contains: contains:
domain: domain:
description: Domain we will set within the HTTP HOST header description: Domain we will set within the HTTP HOST header

View file

@ -97,7 +97,7 @@ RETURN = """
hcloud_load_balancer_target: hcloud_load_balancer_target:
description: The relationship between a Load Balancer and a network description: The relationship between a Load Balancer and a network
returned: always returned: always
type: complex type: dict
contains: contains:
type: type:
description: Type of the Load Balancer Target description: Type of the Load Balancer Target

View file

@ -48,7 +48,7 @@ RETURN = """
hcloud_load_balancer_type_info: hcloud_load_balancer_type_info:
description: The Load Balancer type infos as list description: The Load Balancer type infos as list
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the Load Balancer type description: Numeric identifier of the Load Balancer type

View file

@ -48,7 +48,7 @@ RETURN = """
hcloud_location_info: hcloud_location_info:
description: The location infos as list description: The location infos as list
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the location description: Numeric identifier of the location

View file

@ -77,7 +77,7 @@ RETURN = """
hcloud_network: hcloud_network:
description: The Network description: The Network
returned: always returned: always
type: complex type: dict
contains: contains:
id: id:
description: ID of the Network description: ID of the Network

View file

@ -52,7 +52,7 @@ RETURN = """
hcloud_network_info: hcloud_network_info:
description: The network info as list description: The network info as list
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the network description: Numeric identifier of the network
@ -72,7 +72,7 @@ hcloud_network_info:
subnetworks: subnetworks:
description: Subnetworks belonging to the network description: Subnetworks belonging to the network
returned: always returned: always
type: complex type: list
contains: contains:
type: type:
description: Type of the subnetwork. description: Type of the subnetwork.
@ -97,7 +97,7 @@ hcloud_network_info:
routes: routes:
description: Routes belonging to the network description: Routes belonging to the network
returned: always returned: always
type: complex type: list
contains: contains:
ip_range: ip_range:
description: Destination network or host of this route. description: Destination network or host of this route.
@ -117,7 +117,7 @@ hcloud_network_info:
servers: servers:
description: Servers attached to the network description: Servers attached to the network
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the server description: Numeric identifier of the server

View file

@ -75,7 +75,7 @@ RETURN = """
hcloud_placement_group: hcloud_placement_group:
description: The placement group instance description: The placement group instance
returned: Always returned: Always
type: complex type: dict
contains: contains:
id: id:
description: Numeric identifier of the placement group description: Numeric identifier of the placement group

View file

@ -112,7 +112,7 @@ RETURN = """
hcloud_primary_ip: hcloud_primary_ip:
description: The Primary IP instance description: The Primary IP instance
returned: Always returned: Always
type: complex type: dict
contains: contains:
id: id:
description: ID of the Primary IP description: ID of the Primary IP

View file

@ -67,7 +67,7 @@ RETURN = """
hcloud_primary_ip_info: hcloud_primary_ip_info:
description: The Primary IP infos as list description: The Primary IP infos as list
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the Primary IP description: Numeric identifier of the Primary IP

View file

@ -98,7 +98,7 @@ RETURN = """
hcloud_rdns: hcloud_rdns:
description: The reverse DNS entry description: The reverse DNS entry
returned: always returned: always
type: complex type: dict
contains: contains:
server: server:
description: Name of the server description: Name of the server

View file

@ -66,7 +66,7 @@ RETURN = """
hcloud_route: hcloud_route:
description: One Route of a Network description: One Route of a Network
returned: always returned: always
type: complex type: dict
contains: contains:
network: network:
description: Name of the Network description: Name of the Network

View file

@ -242,7 +242,7 @@ RETURN = """
hcloud_server: hcloud_server:
description: The server instance description: The server instance
returned: Always returned: Always
type: complex type: dict
contains: contains:
id: id:
description: Numeric identifier of the server description: Numeric identifier of the server

View file

@ -52,7 +52,7 @@ RETURN = """
hcloud_server_info: hcloud_server_info:
description: The server infos as list description: The server infos as list
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the server description: Numeric identifier of the server

View file

@ -96,7 +96,7 @@ RETURN = """
hcloud_server_network: hcloud_server_network:
description: The relationship between a server and a network description: The relationship between a server and a network
returned: always returned: always
type: complex type: dict
contains: contains:
network: network:
description: Name of the Network description: Name of the Network

View file

@ -48,7 +48,7 @@ RETURN = """
hcloud_server_type_info: hcloud_server_type_info:
description: The server type infos as list description: The server type infos as list
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the server type description: Numeric identifier of the server type

View file

@ -86,7 +86,7 @@ RETURN = """
hcloud_ssh_key: hcloud_ssh_key:
description: The ssh_key instance description: The ssh_key instance
returned: Always returned: Always
type: complex type: dict
contains: contains:
id: id:
description: ID of the ssh_key description: ID of the ssh_key

View file

@ -50,7 +50,7 @@ RETURN = """
hcloud_ssh_key_info: hcloud_ssh_key_info:
description: The ssh key instances description: The ssh key instances
returned: Always returned: Always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the ssh_key description: Numeric identifier of the ssh_key

View file

@ -88,7 +88,7 @@ RETURN = """
hcloud_subnetwork: hcloud_subnetwork:
description: One Subnet of a Network description: One Subnet of a Network
returned: always returned: always
type: complex type: dict
contains: contains:
network: network:
description: Name of the Network description: Name of the Network

View file

@ -111,7 +111,7 @@ RETURN = """
hcloud_volume: hcloud_volume:
description: The block Volume description: The block Volume
returned: Always returned: Always
type: complex type: dict
contains: contains:
id: id:
description: ID of the Volume description: ID of the Volume

View file

@ -68,7 +68,7 @@ RETURN = """
hcloud_volume_attachment: hcloud_volume_attachment:
description: The relationship between a Server and a Volume description: The relationship between a Server and a Volume
returned: always returned: always
type: complex type: dict
contains: contains:
volume: volume:
description: Name of the Volume description: Name of the Volume

View file

@ -50,7 +50,7 @@ RETURN = """
hcloud_volume_info: hcloud_volume_info:
description: The Volume infos as list description: The Volume infos as list
returned: always returned: always
type: complex type: list
contains: contains:
id: id:
description: Numeric identifier of the Volume description: Numeric identifier of the Volume