]> review.fuel-infra Code Review - puppet-modules/puppetlabs-apt.git/commitdiff
(maint) - Fix cut off summary for apt_key
authorEimhin Laverty <eimhin.laverty@puppet.com>
Mon, 24 Sep 2018 13:13:06 +0000 (14:13 +0100)
committerEimhin Laverty <eimhin.laverty@puppet.com>
Mon, 24 Sep 2018 13:13:06 +0000 (14:13 +0100)
REFERENCE.md
lib/puppet/type/apt_key.rb

index ded9ade0e188141f7a359e9f752f831b71717233..3e1347a9f9381370073d78e505055866113cefeb 100644 (file)
@@ -31,7 +31,9 @@ _Public Resource types_
 
 _Private Resource types_
 
-* `apt_key`: This type provides Puppet with the capabilities to manage GPG keys needed by apt to perform package validation. Apt has it's own GPG keyring 
+* `apt_key`: This type provides Puppet with the capabilities to manage GPG keys needed
+by apt to perform package validation. Apt has it's own GPG keyring that can
+be manipulated through the `apt-key` command.
 
 **Tasks**
 
@@ -444,7 +446,7 @@ The following parameters are available in the `apt::key` defined type.
 
 ##### `id`
 
-Data type: `String`
+Data type: `Pattern[/\A(0x)?[0-9a-fA-F]{8}\Z/, /\A(0x)?[0-9a-fA-F]{16}\Z/, /\A(0x)?[0-9a-fA-F]{40}\Z/]`
 
 Specifies a GPG key to authenticate Apt package signatures. Valid options: a string containing a key ID (8 or 16 hexadecimal
 characters, optionally prefixed with "0x") or a full key fingerprint (40 hexadecimal characters).
@@ -469,7 +471,7 @@ Default value: `undef`
 
 ##### `source`
 
-Data type: `Optional[String]`
+Data type: `Optional[Pattern[/\Ahttps?:\/\//, /\Aftp:\/\//, /\A\/\w+/]]`
 
 Specifies the location of an existing GPG key file to copy. Valid options: a string containing a URL (ftp://, http://, or https://) or
 an absolute path.
@@ -478,7 +480,7 @@ Default value: `undef`
 
 ##### `server`
 
-Data type: `String`
+Data type: `Pattern[/\A((hkp|http|https):\/\/)?([a-z\d])([a-z\d-]{0,61}\.)+[a-z\d]+(:\d{2,5})?$/]`
 
 Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or
 hkp://).
index 10bffb46e65ae50239783558f81c404889d6ef32..1778e4ba6c729fa758aae837b23629f76e4a4d14 100644 (file)
@@ -2,9 +2,9 @@ require 'pathname'
 
 Puppet::Type.newtype(:apt_key) do
   @doc = <<-MANIFEST
-    This type provides Puppet with the capabilities to manage GPG keys needed
-    by apt to perform package validation. Apt has it's own GPG keyring that can
-    be manipulated through the `apt-key` command.
+    @summary This type provides Puppet with the capabilities to manage GPG keys needed
+      by apt to perform package validation. Apt has it's own GPG keyring that can
+      be manipulated through the `apt-key` command.
 
     @example Basic usage
       apt_key { '6F6B15509CF8E59E6E469F327F438280EF8D349F':