Mono repo -> Master (#22553)
Combines the following repositories into one: https://github.com/mattermost/mattermost-server https://github.com/mattermost/mattermost-webapp https://github.com/mattermost/focalboard https://github.com/mattermost/mattermost-plugin-playbooks
Этот коммит содержится в:
75
server/boards/swagger/README.md
Обычный файл
75
server/boards/swagger/README.md
Обычный файл
@@ -0,0 +1,75 @@
|
||||
# Swagger / OpenAPI 2.0 auto-generated files
|
||||
|
||||
⚠️ **Warning:** The API is currently considered Beta and major changes are planned. Please [see this note](https://github.com/mattermost/focalboard/discussions/2139) for more details.
|
||||
|
||||
This folder is generated by the `make swagger` command from comments in the server code.
|
||||
|
||||
Prerequisites:
|
||||
1. [go-swagger](https://goswagger.io/install.html)
|
||||
2. [openapi-generator](https://github.com/OpenAPITools/openapi-generator)
|
||||
|
||||
These can be installed via Homebrew:
|
||||
```
|
||||
brew tap go-swagger/go-swagger
|
||||
brew install go-swagger
|
||||
brew install openapi-generator
|
||||
```
|
||||
|
||||
# Server API documentation
|
||||
|
||||
See the generated [server API documentation here](https://htmlpreview.github.io/?https://github.com/mattermost/focalboard/blob/main/server/swagger/docs/html/index.html).
|
||||
|
||||
# How to authenticate
|
||||
|
||||
To auth against Personal Server, first call login with your credentials to get a token, e.g.
|
||||
```
|
||||
curl -X POST \
|
||||
-H "Accept: application/json" \
|
||||
-H "X-Requested-With: XMLHttpRequest" \
|
||||
-H "Content-Type: application/json" \
|
||||
"http://localhost:8000/api/v2/login" \
|
||||
-d '{
|
||||
"type" : "normal",
|
||||
"username" : "testuser",
|
||||
"password" : "testpass"
|
||||
}'
|
||||
```
|
||||
|
||||
This should return a token in the form:
|
||||
```
|
||||
{"token":"abcdefghijklmnopqrstuvwxyz1"}
|
||||
```
|
||||
|
||||
Pass this as the bearer auth to subsequent calls, e.g.
|
||||
```
|
||||
curl -X GET \
|
||||
-H "Accept: application/json" \
|
||||
-H "Authorization: Bearer abcdefghijklmnopqrstuvwxyz1" \
|
||||
-H "X-Requested-With: XMLHttpRequest" \
|
||||
-H "Content-Type: application/json" \
|
||||
"http://localhost:8000/api/v2/teams/0/boards"
|
||||
```
|
||||
|
||||
# Differences for Mattermost Boards
|
||||
|
||||
The auto-generated Swagger API documentation is for Focalboard Personal Server. If you are calling the API on Mattermost Boards, the additional changes are:
|
||||
|
||||
### API URLs endpoint
|
||||
|
||||
The API endpoint is at `https://SERVERNAME/plugins/focalboard/api/`, e.g. `https://community.mattermost.com/plugins/focalboard/api/`.
|
||||
|
||||
### Use the Mattermost auth token
|
||||
|
||||
Refer to the [Mattermost API documentation here](https://api.mattermost.com/#tag/authentication) on how to obtain the auth token.
|
||||
|
||||
Pass this token as a bearer token to the Boards APIs, e.g.
|
||||
|
||||
```
|
||||
curl -i -H "X-Requested-With: XMLHttpRequest" -H 'Authorization: Bearer abcdefghijklmnopqrstuvwxyz' https://community.mattermost.com/plugins/focalboard/api/v2/workspaces
|
||||
```
|
||||
|
||||
Note that the `X-Requested-With: XMLHttpRequest` header is required to pass the CSRF check.
|
||||
|
||||
# We want to hear from you!
|
||||
|
||||
If you are planning on using the Boards API, we would love to hear about what you'd like to do, and how we can improve the APIs in the future. [See here](https://github.com/mattermost/focalboard/discussions/2139) for more details on how to connect.
|
||||
23
server/boards/swagger/docs/html/.openapi-generator-ignore
Обычный файл
23
server/boards/swagger/docs/html/.openapi-generator-ignore
Обычный файл
@@ -0,0 +1,23 @@
|
||||
# OpenAPI Generator Ignore
|
||||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
||||
|
||||
# Use this file to prevent files from being overwritten by the generator.
|
||||
# The patterns follow closely to .gitignore or .dockerignore.
|
||||
|
||||
# As an example, the C# client generator defines ApiClient.cs.
|
||||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
||||
#ApiClient.cs
|
||||
|
||||
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
||||
#foo/*/qux
|
||||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
||||
|
||||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
||||
#foo/**/qux
|
||||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
||||
|
||||
# You can also negate patterns with an exclamation (!).
|
||||
# For example, you can ignore all files in a docs folder with the file extension .md:
|
||||
#docs/*.md
|
||||
# Then explicitly reverse the ignore rule for a single file:
|
||||
#!docs/README.md
|
||||
1
server/boards/swagger/docs/html/.openapi-generator/VERSION
Обычный файл
1
server/boards/swagger/docs/html/.openapi-generator/VERSION
Обычный файл
@@ -0,0 +1 @@
|
||||
6.2.1
|
||||
35262
server/boards/swagger/docs/html/index.html
Обычный файл
35262
server/boards/swagger/docs/html/index.html
Обычный файл
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
2023
server/boards/swagger/swagger.yml
Обычный файл
2023
server/boards/swagger/swagger.yml
Обычный файл
Разница между файлами не показана из-за своего большого размера
Загрузить разницу
Ссылка в новой задаче
Block a user