Git Product home page Git Product logo

api's Introduction

Revolt API

revolt-api

This package contains typings for objects in the Revolt API and code for generating the OpenAPI specification.

For most cases, if not all, you should only be concerned with revolt-api/types.

Example Usage

import type { User } from 'revolt-api/types/Users';

Commit Style

If publishing a new version of the spec, the first line should always be the API version.

0.5.0-alpha.0
Commit description.
Line 2.

If you are creating new changes for a PR, don't include any version!

For any subsequent lines, prepend the relevant text:

Prefix Description
Structure Added a new data structure to the API.
Route Added a new route to the API.
Change Changed an existing route or data structure.
Fix Fixes to structures / routes.
Deprecation Use when deprecating a structure or route.
Library Changes to this repo unrelated to the API.

Add new prefixes to this list as necessary.

Tip

For faster compile times when working on API routes, comment out the categories you don't care about.

/// src/routes/index.ts
export async function load() {
    // await import('./core.js');
    // await import('./users.js');
    // await import('./channels.js');
    await import('./servers.js');
}

await load();

api's People

Contributors

goaaats avatar insertish avatar jackenmen avatar jan0660 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.