Changes between Version 22 and Version 23 of NewTestbedAPISpec


Ignore:
Timestamp:
Sep 11, 2013 11:08:50 AM (11 years ago)
Author:
faber
Comment:

Circle updates

Legend:

Unmodified
Added
Removed
Modified

  • NewTestbedAPISpec

    v22 v23  
    704704== Circles ==
    705705
    706 The profile API lets users manage their circle memberships as well as manipulate circles.  The circles API is similar to the Projects API.  The primary exceptions are that there is no approval process for circles (though there is for joining or adding a user) and that the permissions are different.
     706The circle API lets users manage their circle memberships as well as manipulate circles.  The circles API is similar to the Projects API.  The primary exceptions are that there is no approval process for circles (though there is for joining or adding a user) and that the permissions are different.
    707707
    708708These calls work on all circles '''except''' those linked to a project.  Those circles must have their membership, ownership, and permissions manipulated through the project to ensure that the contents remain synchronized.
    … …  
    724724     * Members - an array of structures containing
    725725       * Userid - a member's userid
    726        * rights - a 32-bit integer encoding the user's rights (each a flag)
     726       * permissions - a list of strings encoding the user's rights (each a flag - the user has the permission if the string is present)
    727727         * ADD_USER - right to add a user to this circle
    728728         * REMOVE_USER - right to remove a user from this circle
    … …  
    741741   * CircleID - the circle
    742742   * Uids - the userids to add
    743    * Perms - the permissions to grant the user in this circle.  The values are given here.
     743   * Perms - a list of strings that give the permissions to grant the user in this circle.  The values are the same as described in viewCircles.
    744744   * urlPrefix - a prefix to direct the user to a specific web interface to respond to the challenge.
    745745 * '''Return Values:'''
    … …  
    765765   * CircleID - the circle
    766766   * Uids - the userids to add
    767    * Perms - the permissions to grant the user in this circle.  The values are given here.
     767   * Perms - a list of strings giving the permissions to grant the user in this circle.  The values are given the same as described in viewCircles.
    768768 * '''Return Values:'''
    769769   * A list of results of the form
    … …  
    790790 * '''Input Parameters:'''
    791791   * ChallengeID - the challenge being responded to
    792    * Perms - the permissions to grant the user in this circle.  The values are given here.
     792   * Perms - a list of strings giving the permissions to grant the user in this circle.  The values are as described in viewCircles.
    793793 * '''Return Values:'''
    794794   * true if the user was subsequently added.  A fault is thrown on errors.
    … …  
    815815   * CircleName - the circle to change
    816816   * Uids - the uids to manipulate
    817    * Rights - a 32-bit integer encoding the user's rights (each a flag)
     817   * Rights - a list of strings encoding the user's rights (each a flag).  Values are as given in viewCircles.  If the string is present, the user is granted the permission.
    818818 * '''Return Values:'''
    819819   * A list of results of the form
    … …  
    854854       * binary/opaque
    855855     * Value - a string containing the element's value
    856      * Access - a 32-bit integer describing the access values (values at [http://www.isi.edu/~faber/tmp/doc/net/deterlab/testbed/user/UserAttribute.html Attribute's javadoc])
    857        * READ_WRITE
    858        * READ_ONLY
    859        * WRITE_ONLY (e.g., password)
     856     * Access - a string describing the access values (values [http://www.isi.edu/~faber/tmp/DeterAPI/doc/constant-values.html here])
    860857     * Optional - a flag true if the field is optional (must be present but may be empty)
    861858     * Removable - a flag true if the field can be removed
    … …  
    882879       * binary/opaque
    883880     * Value - a string containing the element's value
    884      * Access - a 32-bit integer describing the access values (values at [http://www.isi.edu/~faber/tmp/doc/net/deterlab/testbed/user/UserAttribute.html Attribute's javadoc])
     881     * Access - a string  describing the access values (values [http://www.isi.edu/~faber/tmp/DeterAPI/doc/constant-values.html here])
    885882       * READ_WRITE
    886883       * READ_ONLY
    … …  
    922919   * Type - the type (STRING, INT, FLOAT, OPAQUE)
    923920   * Optional - a boolean, true if this attribute is optional
    924    * Access - an integer the user's ability to modify (READ_WRITE, READ_ONLY, WRITE_ONLY, NO_ACCESS)
     921   * Access - a string: the user's ability to modify (READ_WRITE, READ_ONLY, WRITE_ONLY, NO_ACCESS)
    925922   * Description - natural language description of the field (optional)
    926923   * Format - a regular expression describing the format (optional)
    … …  
    949946   * Type - the type (STRING, INT, FLOAT, OPAQUE)
    950947   * Optional - a boolean, true if this attribute is optional
    951    * Access - an integer the user's ability to modify (READ_WRITE, READ_ONLY, WRITE_ONLY, NO_ACCESS)
     948   * Access - a string: the user's ability to modify (READ_WRITE, READ_ONLY, WRITE_ONLY, NO_ACCESS)
    952949   * Description - natural language description of the field (optional)
    953950   * Format - a regular expression describing the format (optional)