From 44171d16fb8c9ed3366f0fe4046f548617b34174 Mon Sep 17 00:00:00 2001 From: Tony Lee Date: Thu, 21 Jun 2018 01:58:14 +0800 Subject: [PATCH] update user-guides api page --- docs/content/doc/user-guides.en-us.md | 6 ++--- .../doc/user-guides/api-authentication.md | 26 +++++++++++++++---- 2 files changed, 24 insertions(+), 8 deletions(-) diff --git a/docs/content/doc/user-guides.en-us.md b/docs/content/doc/user-guides.en-us.md index 468289cbb..6139cbf81 100644 --- a/docs/content/doc/user-guides.en-us.md +++ b/docs/content/doc/user-guides.en-us.md @@ -1,13 +1,13 @@ --- date: "2018-06-19T16:00:00+02:00" -title: "User-guides" +title: "User Guides" slug: "user-guides" -weight: 45 +weight: 35 toc: false draft: false menu: sidebar: - name: "User-guides" + name: "User Guides" weight: 45 identifier: "user-guides" --- diff --git a/docs/content/doc/user-guides/api-authentication.md b/docs/content/doc/user-guides/api-authentication.md index a28619bc3..e82aa0c98 100644 --- a/docs/content/doc/user-guides/api-authentication.md +++ b/docs/content/doc/user-guides/api-authentication.md @@ -1,12 +1,28 @@ -# API user guide +--- +date: "2018-06-19T16:00:00+02:00" +title: "User Guides: API Usage" +slug: "api-usage" +weight: 10 +toc: true +draft: false +menu: + sidebar: + parent: "user-guides" + name: "API Usage" + weight: 10 + identifier: "api-usage" +--- -## User +## API Usage ### /users/{username}/tokens -Basic usage: - +Usage: +``` +$ curl --request GET --url https://m:yourpassword@git.your.host/api/v1/users/m/tokens +``` + +Response: ``` -$ curl --request GET --url https://m:mypassword@git.your.host/api/v1/users/m/tokens [{"name":"test","sha1":"..."},{"name":"dev","sha1":"..."}] ```