Merge pull request #305 from Esri/mkt-add-param-notes

Added notes for i/o parameters of createFolder and moveItem
Esri · Sep 5, 2018 · 984f76b · 984f76b
2 parents 1bbe7e6 + 080573b
commit 984f76b
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 3 deletions.
diff --git a/packages/arcgis-rest-items/src/create.ts b/packages/arcgis-rest-items/src/create.ts
@@ -16,6 +16,9 @@ import {
 } from "./helpers";
 
 export interface IAddFolderRequestOptions extends IItemCrudRequestOptions {
+  /**
+   * Name of the folder to create.
+   */
   title: string;
 }
 

diff --git a/packages/arcgis-rest-items/src/helpers.ts b/packages/arcgis-rest-items/src/helpers.ts
@@ -69,7 +69,13 @@ export interface IItemResourceResponse {
 }
 
 export interface IAddFolderResponse {
+  /**
+   * Success or failure of request.
+   */
   success: boolean;
+  /**
+   * Information about created folder: its alphanumeric id, name, and owner's name.
+   */
   folder: {
     id: string;
     title: string;
@@ -78,10 +84,22 @@ export interface IAddFolderResponse {
 }
 
 export interface IItemMoveResponse {
+  /**
+   * Success or failure of request.
+   */
   success: boolean;
+  /**
+   * Alphanumeric id of moved item.
+   */
   itemId: string;
+  /**
+   * Name of owner of item.
+   */
   owner: string;
-  folder: string; // folder id
+  /**
+   * Alphanumeric id of folder now housing item.
+   */
+  folder: string;
 }
 
 /**

diff --git a/packages/arcgis-rest-items/src/update.ts b/packages/arcgis-rest-items/src/update.ts
@@ -19,8 +19,15 @@ export interface IItemUpdateRequestOptions extends IItemCrudRequestOptions {
 }
 
 export interface IItemMoveRequestOptions extends IItemCrudRequestOptions {
-  itemId: string; // id of item to be moved
-  folder: string; // id of destination folder; null, empty, or "/" if the destination is the root folder
+  /**
+   * Alphanumeric id of item to be moved.
+   */
+  itemId: string;
+  /**
+   * Alphanumeric id of folder to house moved item. If null, empty, or "/", the destination is the
+   * root folder.
+   */
+  folder: string;
 }
 
 /**