#164983 by multiple contributors: document the core database schemas

1 files changed, 39 insertions, 8 deletions

diff --git a/modules/openid/openid.install b/modules/openid/openid.install
index 1931e4edf..572738a8a 100644
--- a/modules/openid/openid.install
+++ b/modules/openid/openid.install
@@ -22,18 +22,49 @@ function openid_uninstall() {
  */
 function openid_schema() {
   $schema['openid_association'] = array(
+    'description' => t('Stores temporary shared key association information for OpenID authentication.'),
     'fields' => array(
-      'idp_endpoint_uri' => array('type' => 'varchar', 'length' => 255),
-      'assoc_handle' => array('type' => 'varchar', 'length' => 255, 'not null' => TRUE),
-      'assoc_type' => array('type' => 'varchar', 'length' => 32),
-      'session_type' => array('type' => 'varchar', 'length' => 32),
-      'mac_key' => array('type' => 'varchar', 'length' => 255),
-      'created' => array('type' => 'int', 'not null' => TRUE, 'default' => 0),
-      'expires_in' => array('type' => 'int', 'not null' => TRUE, 'default' => 0),
+      'idp_endpoint_uri' => array(
+        'type' => 'varchar',
+        'length' => 255,
+        'description' => t('URI of the OpenID Provider endpoint.'),
+      ),
+      'assoc_handle' => array(
+        'type' => 'varchar',
+        'length' => 255,
+        'not null' => TRUE,
+        'description' => t('Primary Key: Used to refer to this association in subsequent messages.'),
+      ),
+      'assoc_type' => array(
+        'type' => 'varchar',
+        'length' => 32,
+        'description' => t('The signature algorithm used: one of HMAC-SHA1 or HMAC-SHA256.'),
+      ),
+      'session_type' => array(
+        'type' => 'varchar',
+        'length' => 32,
+        'description' => t('Valid association session types: "no-encryption", "DH-SHA1", and "DH-SHA256".'),
+      ),
+      'mac_key' => array(
+        'type' => 'varchar',
+        'length' => 255,
+        'description' => t('The MAC key (shared secret) for this association.'),
+      ),
+      'created' => array(
+        'type' => 'int',
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => t('UNIX timestamp for when the association was created.'),
+      ),
+      'expires_in' => array(
+        'type' => 'int',
+        'not null' => TRUE,
+        'default' => 0,
+        'description' => t('The lifetime, in seconds, of this association.'),
+      ),
     ),
     'primary key' => array('assoc_handle'),
   );
 
   return $schema;
 }
-