docs: add swagger docs for Resource-API (#2044)

swagger files are all auto generated.
This commit is contained in:
WintBit
2023-07-07 14:28:10 +08:00
committed by GitHub
parent 347d3d2b53
commit 9511fae9d9
3 changed files with 507 additions and 16 deletions

View File

@ -308,6 +308,18 @@ paths:
tags:
- Resource API
operationId: ApiController.AddResource
parameters:
- in: body
name: resource
description: Resource object
required: true
schema:
$ref: '#/definitions/object.Resource'
responses:
"200":
description: Success or error
schema:
$ref: '#/definitions/controllers.Response'
/api/add-role:
post:
tags:
@ -869,6 +881,18 @@ paths:
tags:
- Resource API
operationId: ApiController.DeleteResource
parameters:
- in: body
name: resource
description: Resource object
required: true
schema:
$ref: '#/definitions/object.Resource'
responses:
"200":
description: Success or error
schema:
$ref: '#/definitions/controllers.Response'
/api/delete-role:
post:
tags:
@ -1818,12 +1842,67 @@ paths:
get:
tags:
- Resource API
description: get resource
operationId: ApiController.GetResource
parameters:
- in: query
name: id
description: The id ( owner/name ) of resource
required: true
type: string
responses:
"200":
description: The Response object
schema:
$ref: '#/definitions/object.Resource'
/api/get-resources:
get:
tags:
- Resource API
description: get resources
operationId: ApiController.GetResources
parameters:
- in: query
name: owner
description: Owner
required: true
type: string
- in: query
name: user
description: User
required: true
type: string
- in: query
name: pageSize
description: Page Size
type: integer
- in: query
name: p
description: Page Number
type: integer
- in: query
name: field
description: Field
type: string
- in: query
name: value
description: Value
type: string
- in: query
name: sortField
description: Sort Field
type: string
- in: query
name: sortOrder
description: Sort Order
type: string
responses:
"200":
description: The Response object
schema:
type: array
items:
$ref: '#/definitions/object.Resource'
/api/get-role:
get:
tags:
@ -2960,7 +3039,25 @@ paths:
post:
tags:
- Resource API
description: get resource
operationId: ApiController.UpdateResource
parameters:
- in: query
name: id
description: The id ( owner/name ) of resource
required: true
type: string
- in: body
name: resource
description: The resource object
required: true
schema:
$ref: '#/definitions/object.Resource'
responses:
"200":
description: Success or error
schema:
$ref: '#/definitions/controllers.Response'
/api/update-role:
post:
tags:
@ -3123,6 +3220,53 @@ paths:
tags:
- Resource API
operationId: ApiController.UploadResource
parameters:
- in: query
name: owner
description: Owner
required: true
type: string
- in: query
name: user
description: User
required: true
type: string
- in: query
name: application
description: Application
required: true
type: string
- in: query
name: tag
description: Tag
type: string
- in: query
name: parent
description: Parent
type: string
- in: query
name: fullFilePath
description: Full File Path
required: true
type: string
- in: query
name: createdTime
description: Created Time
type: string
- in: query
name: description
description: Description
type: string
- in: formData
name: file
description: Resource file
required: true
type: file
responses:
"200":
description: FileUrl, objectKey
schema:
$ref: '#/definitions/object.Resource'
/api/user:
get:
tags:
@ -3251,11 +3395,11 @@ definitions:
properties:
data:
additionalProperties:
description: support string | class | List<class> and os on
description: support string, struct or []struct
type: string
data2:
additionalProperties:
description: support string | class | List<class> and os on
description: support string, struct or []struct
type: string
msg:
type: string
@ -3400,6 +3544,10 @@ definitions:
$ref: '#/definitions/object.SignupItem'
signupUrl:
type: string
tags:
type: array
items:
type: string
termsOfUse:
type: string
themeData:
@ -4026,8 +4174,6 @@ definitions:
type: string
customLogo:
type: string
scopes:
type: string
customTokenUrl:
type: string
customUserInfoUrl:
@ -4069,6 +4215,8 @@ definitions:
type: string
regionId:
type: string
scopes:
type: string
signName:
type: string
subType:
@ -4079,6 +4227,9 @@ definitions:
type: string
type:
type: string
userMapping:
additionalProperties:
type: string
object.ProviderItem:
title: ProviderItem
type: object
@ -4132,6 +4283,39 @@ definitions:
type: string
user:
type: string
object.Resource:
title: Resource
type: object
properties:
application:
type: string
createdTime:
type: string
description:
type: string
fileFormat:
type: string
fileName:
type: string
fileSize:
type: integer
format: int64
fileType:
type: string
name:
type: string
owner:
type: string
parent:
type: string
provider:
type: string
tag:
type: string
url:
type: string
user:
type: string
object.Role:
title: Role
type: object