Revision f20c20fe astakosclient/docs/index.rst

b/astakosclient/docs/index.rst
122 122
    **get_resources()**
123 123
        Return a list of dicts with the available resources
124 124

  
125
    **send_feedback(**\ token, message, data\ **)**
126
        Using a user's authentication token send some feedback to
127
        astakos service. Additional information about the service
128
        client status can be given in the data variable.
129
        In case of success returns nothing.
130
        Otherwise raise an AstakosClientException exception.
131

  
132
    **get_endpoints(**\ token, belongs_to, marker, limit\ **)**
133
        Given a user's authentication token, request registered
134
        endpoints from astakos service. If belongs_to is given (uuid)
135
        check that the token belongs to this user. If marker is given
136
        (int) return endpoints (ordered by ID) whose ID is higher than
137
        the marker. Limit (int) specifies the maximum number of
138
        endpoints to return. Return a json formatted dictionary containing
139
        information about registered endpoints.
140

  
141
        .. warning:: *get_endpoints* api call encodes the user's token inside
142
            the url. It's security unsafe to use it (both astakosclient
143
            and nginx tend to log requested urls).
144

  
125 145
    **get_quotas(**\ token\ **)**
126 146
        Given a user's authentication token return user's
127 147
        current quotas (as dict of dicts).

Also available in: Unified diff