https://github.com/saturninoabril/mattermost-openapi-insomnia

Mattermost Open API for Insomnia
https://github.com/saturninoabril/mattermost-openapi-insomnia

insomnia-resource mattermost mattermost-api openapi

Last synced: 3 months ago
JSON representation

Mattermost Open API for Insomnia

• Host: GitHub
• URL: https://github.com/saturninoabril/mattermost-openapi-insomnia
• Owner: saturninoabril
• License: apache-2.0
• Created: 2019-04-28T08:51:33.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-07-12T08:02:41.000Z (almost 6 years ago)
• Last Synced: 2025-01-15T13:12:46.891Z (4 months ago)
• Topics: insomnia-resource, mattermost, mattermost-api, openapi
• Language: JavaScript
• Size: 90.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mattermost Open API for Insomnia ![CircleCI branch](https://img.shields.io/circleci/project/github/saturninoabril/mattermost-openapi-insomnia/master.svg)

A complete set of [Mattermost Open API](https://api.mattermost.com/) route specifications that can be imported straight into [Insomnia REST Client](https://insomnia.rest/).

This script directly downloads [mattermost-openapi-v4.yaml](https://api.mattermost.com/static/mattermost-openapi-v4.yaml) and then generate Insomnia-compatible resources out of it.

## Build the resource

```

$ npm install

$ npm run build

```

## Usage

Import directly into Insomnia, via `Workspace` :arrow_right: `Import/Export` :arrow_right: `Import Data` :arrow_right: `From URL` and entering **`https://raw.githubusercontent.com/saturninoabril/mattermost-openapi-insomnia/master/dist/mattermost_openapi_v4_insomnia.json`**:

## Modify [base environment](https://support.insomnia.rest/article/18-environment-variables):

- `mattermost_token`: Add your personal access or session token to authorize access to routes.  See [documention](https://docs.mattermost.com/developer/personal-access-tokens.html) on how to create personal access token.

- `mattermost_api_root`: Set by default to `http://localhost:8065/api/v4` but can also change to remotely access your Mattermost instance.

- modify other parameters/environment variable as needed.