From 34dac16845a0b6e19427650714a1fd8864babe0b Mon Sep 17 00:00:00 2001 From: Tim Zhukov Date: Thu, 23 Apr 2020 11:14:02 -0400 Subject: [PATCH 1/2] adding doc to reflect user.id to the documentation --- source/includes/_users.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/source/includes/_users.md b/source/includes/_users.md index c32db08..eca95d5 100644 --- a/source/includes/_users.md +++ b/source/includes/_users.md @@ -4,6 +4,7 @@ ```json { + "id":"123e4567-e89b-12d3-a456-426655440000", "company_name": "Algorithmia", "company_role": "Example User", "email": "me@example.com", @@ -16,13 +17,14 @@ |Attribute|Type|Description| |-|-|-| +|`id`|String|The unique identifier for this user.| |`company_name`|String|The name of the user's employer.| |`company_role`|String|The user's occupation.| |`email`|String|The user's email address.| |`fullname`|String|The user's full name.| |`resource_type`|String|Always set to `user` for users. |`self_link`|String|The URL that can be used to retrieve this specific user via the REST API.| -|`username`|String|The unique identifier for this user.| +|`username`|String|The unique alias for this user.| ## Create a user @@ -64,6 +66,7 @@ In order to interact with this endpoint you must provide an admin API key. Visit ```json { + "id":"123e4567-e89b-12d3-a456-426655440000", "company_name": "Algorithmia", "company_role": "Example User", "email": "me@example.com", @@ -107,6 +110,7 @@ In order to interact with this endpoint you must provide an admin API key. Visit "marker": null, "next_link": null, "results": [{ + "id":"123e4567-e89b-12d3-a456-426655440000", "company_name": "Algorithmia", "company_role": "Example User", "email": "me@example.com", @@ -199,6 +203,7 @@ In order to interact with this endpoint you must provide an admin API key. Visit ```json { + "id":"123e4567-e89b-12d3-a456-426655440000", "company_name": "Algorithmia", "company_role": "Example User", "email": "me@example.com", From fa4b9d863ac83fb36a00e7c4ad271d981fb0d175 Mon Sep 17 00:00:00 2001 From: Tim Zhukov Date: Mon, 27 Apr 2020 09:40:08 -0400 Subject: [PATCH 2/2] cleanup --- source/includes/_users.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/includes/_users.md b/source/includes/_users.md index eca95d5..52649e2 100644 --- a/source/includes/_users.md +++ b/source/includes/_users.md @@ -4,7 +4,7 @@ ```json { - "id":"123e4567-e89b-12d3-a456-426655440000", + "id": "123e4567-e89b-12d3-a456-426655440000", "company_name": "Algorithmia", "company_role": "Example User", "email": "me@example.com", @@ -66,7 +66,7 @@ In order to interact with this endpoint you must provide an admin API key. Visit ```json { - "id":"123e4567-e89b-12d3-a456-426655440000", + "id": "123e4567-e89b-12d3-a456-426655440000", "company_name": "Algorithmia", "company_role": "Example User", "email": "me@example.com", @@ -110,7 +110,7 @@ In order to interact with this endpoint you must provide an admin API key. Visit "marker": null, "next_link": null, "results": [{ - "id":"123e4567-e89b-12d3-a456-426655440000", + "id": "123e4567-e89b-12d3-a456-426655440000", "company_name": "Algorithmia", "company_role": "Example User", "email": "me@example.com", @@ -203,7 +203,7 @@ In order to interact with this endpoint you must provide an admin API key. Visit ```json { - "id":"123e4567-e89b-12d3-a456-426655440000", + "id": "123e4567-e89b-12d3-a456-426655440000", "company_name": "Algorithmia", "company_role": "Example User", "email": "me@example.com",