Kharec/goyco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update refresh token rotation description and examples

Browse Source
This commit is contained in:
Sandro CURY CAZZANIGA
2026-01-08 06:29:12 +01:00
parent bc0c9e5fea
commit dfee90504a
3 changed files with 13 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/docs.go
View File

@@ -487,7 +487,7 @@ const docTemplate = `{
}, },
"/api/auth/refresh": { "/api/auth/refresh": {
"post": { "post": {
"description": "Use a refresh token to get a new access token. This endpoint allows clients to obtain a new access token using a valid refresh token without requiring user credentials.", "description": "Use a refresh token to get a new access token. The refresh token is rotated on success, and the previous refresh token becomes invalid.",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1906,7 +1906,7 @@ const docTemplate = `{
"properties": { "properties": {
"refresh_token": { "refresh_token": {
"type": "string", "type": "string",
"example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." "example": "f94d4ddc7d9b4fcb9d3a2c44c400b780c3e1f1a5c2b7d4e6a0b1c2d3e4f5a6b7"
} }
} }
}, },
@@ -1971,7 +1971,7 @@ const docTemplate = `{
"properties": { "properties": {
"refresh_token": { "refresh_token": {
"type": "string", "type": "string",
"example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." "example": "f94d4ddc7d9b4fcb9d3a2c44c400b780c3e1f1a5c2b7d4e6a0b1c2d3e4f5a6b7"
} }
} }
}, },
@@ -2073,7 +2073,7 @@ const docTemplate = `{
}, },
"refresh_token": { "refresh_token": {
"type": "string", "type": "string",
"example": "f94d4ddc7d9b4fcb9d3a2c44c400b780" "example": "f94d4ddc7d9b4fcb9d3a2c44c400b780c3e1f1a5c2b7d4e6a0b1c2d3e4f5a6b7"
}, },
"user": { "user": {
"$ref": "#/definitions/handlers.AuthUserSummary" "$ref": "#/definitions/handlers.AuthUserSummary"

8
docs/swagger.json
View File

@@ -484,7 +484,7 @@
}, },
"/api/auth/refresh": { "/api/auth/refresh": {
"post": { "post": {
"description": "Use a refresh token to get a new access token. This endpoint allows clients to obtain a new access token using a valid refresh token without requiring user credentials.", "description": "Use a refresh token to get a new access token. The refresh token is rotated on success, and the previous refresh token becomes invalid.",
"consumes": [ "consumes": [
"application/json" "application/json"
], ],
@@ -1903,7 +1903,7 @@
"properties": { "properties": {
"refresh_token": { "refresh_token": {
"type": "string", "type": "string",
"example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." "example": "f94d4ddc7d9b4fcb9d3a2c44c400b780c3e1f1a5c2b7d4e6a0b1c2d3e4f5a6b7"
} }
} }
}, },
@@ -1968,7 +1968,7 @@
"properties": { "properties": {
"refresh_token": { "refresh_token": {
"type": "string", "type": "string",
"example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." "example": "f94d4ddc7d9b4fcb9d3a2c44c400b780c3e1f1a5c2b7d4e6a0b1c2d3e4f5a6b7"
} }
} }
}, },
@@ -2070,7 +2070,7 @@
}, },
"refresh_token": { "refresh_token": {
"type": "string", "type": "string",
"example": "f94d4ddc7d9b4fcb9d3a2c44c400b780" "example": "f94d4ddc7d9b4fcb9d3a2c44c400b780c3e1f1a5c2b7d4e6a0b1c2d3e4f5a6b7"
}, },
"user": { "user": {
"$ref": "#/definitions/handlers.AuthUserSummary" "$ref": "#/definitions/handlers.AuthUserSummary"

11
docs/swagger.yaml
View File

@@ -59,7 +59,7 @@ definitions:
dto.RefreshTokenRequest: dto.RefreshTokenRequest:
properties: properties:
refresh_token: refresh_token:
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... example: f94d4ddc7d9b4fcb9d3a2c44c400b780c3e1f1a5c2b7d4e6a0b1c2d3e4f5a6b7
type: string type: string
required: required:
- refresh_token - refresh_token
@@ -105,7 +105,7 @@ definitions:
dto.RevokeTokenRequest: dto.RevokeTokenRequest:
properties: properties:
refresh_token: refresh_token:
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... example: f94d4ddc7d9b4fcb9d3a2c44c400b780c3e1f1a5c2b7d4e6a0b1c2d3e4f5a6b7
type: string type: string
required: required:
- refresh_token - refresh_token
@@ -177,7 +177,7 @@ definitions:
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
type: string type: string
refresh_token: refresh_token:
example: f94d4ddc7d9b4fcb9d3a2c44c400b780 example: f94d4ddc7d9b4fcb9d3a2c44c400b780c3e1f1a5c2b7d4e6a0b1c2d3e4f5a6b7
type: string type: string
user: user:
$ref: '#/definitions/handlers.AuthUserSummary' $ref: '#/definitions/handlers.AuthUserSummary'
@@ -565,9 +565,8 @@ paths:
post: post:
consumes: consumes:
- application/json - application/json
description: Use a refresh token to get a new access token. This endpoint allows description: Use a refresh token to get a new access token. The refresh token
clients to obtain a new access token using a valid refresh token without requiring is rotated on success, and the previous refresh token becomes invalid.
user credentials.
parameters: parameters:
- description: Refresh token data - description: Refresh token data
in: body in: body