Coder Social home page Coder Social logo

rickbatka / mattermost-api-reference Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mattermost/mattermost-api-reference

0.0 1.0 0.0 13.96 MB

Mattermost API reference documentation.

Home Page: https://api.mattermost.com

Makefile 63.86% HTML 36.14%

mattermost-api-reference's Introduction

Mattermost API Documentation

This respository holds the API reference available at https://api.mattermost.com.

The Mattermost API reference uses the OpenAPI standard and the ReDoc document generator.

All documentation is available under the terms of a Creative Commons License.

Contributing

Mattermost API version 4 is an active and in-progress project. We're looking for contributors to code server endpoints, build drivers and write documentation. If you're interested please join our Mattermost instance and join the APIv4 channel.

We're accepting pull requests! Specifically we're looking for documenation on routes defined here.

All the documentation is written in YAML and found in the v3/source and v4/source directories. APIv3 documentation is in the v3 directory, and APIv4 documentation is in the v4 directory.

There is no strict style guide but please try to follow the example of the existing documentation.

To build the full YAML, run make build and it will be output to html/static/mattermost-openapi.yaml. This will also check syntax using swagger-cli.

Deployment

Deployment is handled automatically by our Jenkins CLI machine. When a pull request is merged it will automatically be deployed to https://api.mattermost.com.

mattermost-api-reference's People

Contributors

andreistanciu24 avatar atpons avatar ccbrown avatar cometkim avatar coreyhulen avatar cpanato avatar crspeller avatar dagit avatar enahum avatar grundleborg avatar hmhealey avatar jasonblais avatar jwilander avatar martindelille avatar mpoornima avatar n1aba avatar pichouk avatar prixone avatar rickbatka avatar ruzette avatar saturninoabril avatar senk avatar thepanz avatar trarbr avatar vaelor avatar zaicon avatar zhouzi avatar zjvandeweg avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.