Move API Reference (#23777)
* merge mattermost-api-reference unchanged * api: update repostiory paths * api: drop GitPod for api (for now) * api: improved node_modules target * api: relocate GitHub actions to root * Update .github/workflows/api.yml Co-authored-by: Antonis Stamatiou <stamatiou.antonis@gmail.com> * fix cache-dependency-path * adopt node-version-file * pin versions for uses * tidy steps/runs * api/.gitpod.yml: tidy * api: rm now unused .gitlab-ci.yml --------- Co-authored-by: Antonis Stamatiou <stamatiou.antonis@gmail.com>
Этот коммит содержится в:
Jesse Hallam
коммит произвёл
GitHub
GitHub
родитель
3f99b7618d
Коммит
d9614cbb12
214
api/v4/source/roles.yaml
Обычный файл
214
api/v4/source/roles.yaml
Обычный файл
@@ -0,0 +1,214 @@
|
||||
"/api/v4/roles":
|
||||
get:
|
||||
tags:
|
||||
- roles
|
||||
summary: Get a list of all the roles
|
||||
description: |
|
||||
##### Permissions
|
||||
|
||||
`manage_system` permission is required.
|
||||
|
||||
__Minimum server version__: 5.33
|
||||
operationId: GetAllRoles
|
||||
responses:
|
||||
"200":
|
||||
description: Roles retrieval successful
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Role"
|
||||
"400":
|
||||
$ref: "#/components/responses/BadRequest"
|
||||
"401":
|
||||
$ref: "#/components/responses/Unauthorized"
|
||||
"403":
|
||||
$ref: "#/components/responses/Forbidden"
|
||||
x-code-samples:
|
||||
- lang: Go
|
||||
source: |
|
||||
import "github.com/mattermost/mattermost-server/v5/model"
|
||||
Client := model.NewAPIv4Client("https://your-mattermost-url.com")
|
||||
Client.Login("email@domain.com", "Password1")
|
||||
|
||||
roles, resp := Client.GetAllRoles()
|
||||
|
||||
"/api/v4/roles/{role_id}":
|
||||
get:
|
||||
tags:
|
||||
- roles
|
||||
summary: Get a role
|
||||
description: |
|
||||
Get a role from the provided role id.
|
||||
|
||||
##### Permissions
|
||||
Requires an active session but no other permissions.
|
||||
|
||||
__Minimum server version__: 4.9
|
||||
operationId: GetRole
|
||||
parameters:
|
||||
- name: role_id
|
||||
in: path
|
||||
description: Role GUID
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: Role retrieval successful
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Role"
|
||||
"401":
|
||||
$ref: "#/components/responses/Unauthorized"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFound"
|
||||
x-code-samples:
|
||||
- lang: Go
|
||||
source: |
|
||||
import "github.com/mattermost/mattermost-server/v5/model"
|
||||
Client := model.NewAPIv4Client("https://your-mattermost-url.com")
|
||||
Client.Login("email@domain.com", "Password1")
|
||||
|
||||
role, resp := Client.GetRole(<ROLEID>, "")
|
||||
"/api/v4/roles/name/{role_name}":
|
||||
get:
|
||||
tags:
|
||||
- roles
|
||||
summary: Get a role
|
||||
description: |
|
||||
Get a role from the provided role name.
|
||||
|
||||
##### Permissions
|
||||
Requires an active session but no other permissions.
|
||||
|
||||
__Minimum server version__: 4.9
|
||||
operationId: GetRoleByName
|
||||
parameters:
|
||||
- name: role_name
|
||||
in: path
|
||||
description: Role Name
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
"200":
|
||||
description: Role retrieval successful
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Role"
|
||||
"401":
|
||||
$ref: "#/components/responses/Unauthorized"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFound"
|
||||
x-code-samples:
|
||||
- lang: Go
|
||||
source: |
|
||||
import "github.com/mattermost/mattermost-server/v5/model"
|
||||
Client := model.NewAPIv4Client("https://your-mattermost-url.com")
|
||||
Client.Login("email@domain.com", "Password1")
|
||||
|
||||
role, resp := Client.GetRoleByName(<ROLENAME>, "")
|
||||
"/api/v4/roles/{role_id}/patch":
|
||||
put:
|
||||
tags:
|
||||
- roles
|
||||
summary: Patch a role
|
||||
description: >
|
||||
Partially update a role by providing only the fields you want to update.
|
||||
Omitted fields will not be updated. The fields that can be updated are
|
||||
defined in the request body, all other provided fields will be ignored.
|
||||
|
||||
|
||||
##### Permissions
|
||||
|
||||
`manage_system` permission is required.
|
||||
|
||||
|
||||
__Minimum server version__: 4.9
|
||||
operationId: PatchRole
|
||||
parameters:
|
||||
- name: role_id
|
||||
in: path
|
||||
description: Role GUID
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
permissions:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: The permissions the role should grant.
|
||||
description: Role object to be updated
|
||||
required: true
|
||||
responses:
|
||||
"200":
|
||||
description: Role patch successful
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Role"
|
||||
"400":
|
||||
$ref: "#/components/responses/BadRequest"
|
||||
"401":
|
||||
$ref: "#/components/responses/Unauthorized"
|
||||
"403":
|
||||
$ref: "#/components/responses/Forbidden"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFound"
|
||||
/api/v4/roles/names:
|
||||
post:
|
||||
tags:
|
||||
- roles
|
||||
summary: Get a list of roles by name
|
||||
description: |
|
||||
Get a list of roles from their names.
|
||||
|
||||
##### Permissions
|
||||
Requires an active session but no other permissions.
|
||||
|
||||
__Minimum server version__: 4.9
|
||||
operationId: GetRolesByNames
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
description: List of role names
|
||||
required: true
|
||||
responses:
|
||||
"200":
|
||||
description: Role list retrieval successful
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/Role"
|
||||
"400":
|
||||
$ref: "#/components/responses/BadRequest"
|
||||
"401":
|
||||
$ref: "#/components/responses/Unauthorized"
|
||||
"404":
|
||||
$ref: "#/components/responses/NotFound"
|
||||
x-code-samples:
|
||||
- lang: Go
|
||||
source: |
|
||||
import "github.com/mattermost/mattermost-server/v5/model"
|
||||
Client := model.NewAPIv4Client("https://your-mattermost-url.com")
|
||||
Client.Login("email@domain.com", "Password1")
|
||||
|
||||
roleNames := []string{<NAME OF ROLE1>, <NAME OF ROLE2>, ...}
|
||||
|
||||
roles, resp := Client.GetRolesByNames(roleNames)
|
||||
Ссылка в новой задаче
Block a user