Changes between Version 12 and Version 13 of NewTestbedAPISpec

Timestamp:

Aug 12, 2013 12:53:52 PM (11 years ago)

Author:

faber

Comment:

--

NewTestbedAPISpec

@@ -561 +561 @@
     * Success - a flag indicating if the request succeeded
     * Reason - a string indicating the reason if Success is false
+
+
+=== Manipulating Profile Attributes ===
+
+Administrators may add attributes to project profiles or remove them.  That is to say, add a schema (including format constraints and descriptions), not set a value for a project.
+
+Creating an attribute:
+
+* '''Service:''' Projects
+ * '''Operation:''' createProjectAttribute
+ * '''Input Parameters:'''
+   * Name - the attribute name
+   * Type - the type (STRING, INT, FLOAT, OPAQUE)
+   * Optional - a boolean, true if this attribute is optional
+   * Access - an integer the user's ability to modify (READ_WRITE, READ_ONLY, WRITE_ONLY, NO_ACCESS)
+   * Description - natural language description of the field (optional)
+   * Format - a regular expression describing the format (optional)
+   * Formatdescription - a natural language explanation of the format (optional)
+   * OrderingHint - an integer suggesting where to present the attribute. Lower numbers come first
+   * LengthHint - an integer suggesting how long an input 
+   * Def - default value of the attribute (will be set for all users)
+ * '''Return Values:'''
+  * a boolean, true if the attribute was created 
+
+And removing an attribute:
+
+* '''Service:''' Projects
+ * '''Operation:''' removeProjectAttribute
+ * '''Input Parameters:'''
+   * Name - the attribute name
+ * '''Return Values:'''
+  * a boolean, true if the attribute was removed 
 
 === Creating and Deleting Projects ===