Merge pull request #840 from puppetlabs/release

[puppet-modules/puppetlabs-apt.git] / REFERENCE.md

diff --git a/REFERENCE.md b/REFERENCE.md
index ded9ade0e188141f7a359e9f752f831b71717233..081866dcd89c67be39c737977c75bae1748030ca 100644 (file)
--- a/REFERENCE.md
+++ b/REFERENCE.md
@@ -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**
 
@@ -63,8 +65,8 @@ Default value: $apt::params::provider
 
 Data type: `String`
 
-Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://, or
-hkp://).
+Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://,
+hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04.
 
 Default value: $apt::params::keyserver
 
@@ -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).
@@ -453,9 +455,10 @@ Default value: $title
 
 ##### `ensure`
 
-Data type: `Enum['present', 'absent']`
+Data type: `Enum['present', 'absent', 'refreshed']`
 
-Specifies whether the key should exist. Valid options: 'present' and 'absent'.
+Specifies whether the key should exist. Valid options: 'present', 'absent' or 'refreshed'. Using 'refreshed' will make keys auto
+update when they have expired (assuming a new key exists on the key server).
 
 Default value: present
 
@@ -469,7 +472,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,10 +481,10 @@ Default value: `undef`
 
 ##### `server`
 
-Data type: `String`
+Data type: `Pattern[/\A((hkp|hkps|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://).
+Specifies a keyserver to provide the GPG key. Valid options: a string containing a domain name or a full URL (http://, https://,
+hkp:// or hkps://). The hkps:// protocol is currently only supported on Ubuntu 18.04.
 
 Default value: $::apt::keyserver