Document Release Models

azenla · azenla · commit e1dfca236f40 · 2014-08-22T21:16:37.000-04:00
diff --git a/lib/src/client/releases.dart b/lib/src/client/releases.dart
@@ -3,37 +3,86 @@ part of github.client;
 class Release {
   final GitHub github;
 
+  /**
+   * Url to this Release
+   */
   @ApiName("html_url")
   String url;
 
+  /**
+   * Tarball of the Repository Tree at the commit of this release.
+   */
   @ApiName("tarball_url")
   String tarballUrl;
 
+  /**
+   * ZIP of the Repository Tree at the commit of this release.
+   */
   @ApiName("zipball_url")
   String zipballUrl;
 
+  /**
+   * Release ID
+   */
   int id;
 
+  /**
+   * Release Tag Name
+   */
   @ApiName("tag_name")
   String tagName;
 
+  /**
+   * Target Commit
+   */
   @ApiName("target_commitish")
   String targetCommitsh;
 
+  /**
+   * Release Name
+   */
   String name;
+  
+  /**
+   * Release Notes
+   */
   String body;
+  
+  /**
+   * Release Description
+   */
   String description;
+  
+  /**
+   * If the release is a draft.
+   */
   bool draft;
+  
+  /**
+   * If the release is a pre release.
+   */
   bool prerelease;
 
+  /**
+   * The time this release was created at.
+   */
   @ApiName("created_at")
   DateTime createdAt;
 
+  /**
+   * The time this release was published at.
+   */
   @ApiName("published_at")
   DateTime publishedAt;
 
+  /**
+   * The author of this release.
+   */
   User author;
 
+  /**
+   * Release Assets
+   */
   List<ReleaseAsset> assets;
 
   Release(this.github);
@@ -61,25 +110,58 @@ class Release {
 class ReleaseAsset {
   final GitHub github;
 
+  /**
+   * Url to download the asset.
+   */
   @ApiName("browser_download_url")
   String url;
 
+  /**
+   * Asset ID
+   */
   int id;
+  
+  /**
+   * Assert Name
+   */
   String name;
+  
+  /**
+   * Assert Label
+   */
   String label;
+  
+  /**
+   * Assert State
+   */
   String state;
 
+  /**
+   * Assert Content Type
+   */
   @ApiName("content_type")
   String contentType;
 
+  /**
+   * Size of Asset
+   */
   int size;
 
+  /**
+   * Number of Downloads
+   */
   @ApiName("download_count")
   int downloadCount;
 
+  /**
+   * Time the assert was created at
+   */
   @ApiName("created_at")
   DateTime createdAt;
 
+  /**
+   * Time the asset was last updated
+   */
   @ApiName("updated_at")
   DateTime updatedAt;
 
@@ -100,12 +182,38 @@ class ReleaseAsset {
   }
 }
 
+/**
+ * A Request to Create a Release
+ */
 class CreateReleaseRequest {
+  /**
+   * Tag Name to Base off of
+   */
   final String tagName;
+  
+  /**
+   * Commit to Target
+   */
   String targetCommitish;
+  
+  /**
+   * Release Name
+   */
   String name;
+  
+  /**
+   * Release Body
+   */
   String body;
+  
+  /**
+   * If the release is a draft
+   */
   bool draft;
+  
+  /**
+   * If the release should actually be released.
+   */
   bool release;
 
   CreateReleaseRequest(this.tagName);
