Skip to content

Commit 38af01c

Browse files
committed
Update internal documentation to emphasize future API deprecation
Per Jaime's comment, since we plan to deprecate the `config_set_blah()` family of functions in favor of the prefixed versions, I've updated the internal API documentation to point people toward the preferred APIs.
1 parent fffb45a commit 38af01c

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

src/scitokens.h

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -291,49 +291,49 @@ int keycache_get_cached_jwks(const char *issuer, char **jwks, char **err_msg);
291291
int keycache_set_jwks(const char *issuer, const char *jwks, char **err_msg);
292292

293293
/**
294-
* API for managing scitokens configuration parameters.
294+
* APIs for managing scitokens configuration parameters.
295295
*/
296296

297+
// On its way to deprecation
298+
int config_set_int(const char *key, int value, char **err_msg);
299+
297300
/**
298301
* Update scitokens int parameters.
299302
* Takes in key/value pairs and assigns the input value to whatever
300303
* configuration variable is indicated by the key.
301304
* Returns 0 on success, and non-zero for invalid keys or values.
302305
*/
303-
int config_set_int(const char *key, int value, char **err_msg);
304-
305-
// Prefixed version of the same API to avoid potential symbol collisions
306306
int scitokens_config_set_int(const char *key, int value, char **err_msg);
307307

308+
// On its way to deprecation
309+
int config_get_int(const char *key, char **err_msg);
310+
308311
/**
309312
* Get current scitokens int parameters.
310313
* Returns the value associated with the supplied input key on success, and -1
311-
* on failure This assumes there are no keys for which a negative return value
314+
* on failure. This assumes there are no keys for which a negative return value
312315
* is permissible.
313316
*/
314-
int config_get_int(const char *key, char **err_msg);
315-
316-
// Prefixed version of the same API to avoid potential symbol collisions
317317
int scitokens_config_get_int(const char *key, char **err_msg);
318318

319+
// On its way to deprecation
320+
int config_set_str(const char *key, const char *value, char **err_msg);
321+
319322
/**
320323
* Set current scitokens str parameters.
321324
* Returns 0 on success, nonzero on failure
322325
*/
323-
int config_set_str(const char *key, const char *value, char **err_msg);
324-
325-
// Prefixed version of the same API to avoid potential symbol collisions
326326
int scitokens_config_set_str(const char *key, const char *value,
327327
char **err_msg);
328328

329+
// On its way to deprecation
330+
int config_get_str(const char *key, char **output, char **err_msg);
331+
329332
/**
330333
* Get current scitokens str parameters.
331334
* Returns 0 on success, nonzero on failure, and populates the value associated
332335
* with the input key to output.
333336
*/
334-
int config_get_str(const char *key, char **output, char **err_msg);
335-
336-
// Prefixed version of the same API to avoid potential symbol collisions
337337
int scitokens_config_get_str(const char *key, char **output, char **err_msg);
338338

339339
#ifdef __cplusplus

0 commit comments

Comments
 (0)