Skip to content

Commit 46df468

Browse files
Davidb1naryth1ef
David
authored andcommitted
Cleaned up a couple things (#3)
- Moved the user agent into a code block since your docs site doesn't like one lines. - Renamed websocket in title to WebSocket, personal preferance. - Renamed `guild_Id` to `guild_id`. - Added a full stop. - Added the year on the bot user accounts to clarify. - Bot authentication URL takes app id, not bot id.
1 parent 8b2c0cb commit 46df468

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

docs/REFERENCE.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ Authenticating with the Discord API can be done in one of two ways:
1111

1212
## Encryption
1313

14-
All HTTP-layer services and protocols (e.g. http, websocket) within the Discord API use
14+
All HTTP-layer services and protocols (e.g. http, websocket) within the Discord API use TLS 1.2.
1515

1616
## Snowflake ID's
1717

18-
Discord utilizes a Twitter's [snowflake](https://github.com/twitter/snowflake/tree/snowflake-2010) format for uniquely identifiable descriptors (ID's). These ID's are up to 64bits in size (e.g. a uint64) and therefore are always returned as strings in the API to prevent integer overflows in some languages. Snowflake ID's are guaranteed to be unique across all of Discord, except in some unique scenarios in which child objects share their parents ID.
18+
Discord utilizes Twitter's [snowflake](https://github.com/twitter/snowflake/tree/snowflake-2010) format for uniquely identifiable descriptors (ID's). These ID's are up to 64bits in size (e.g. a uint64) and therefore are always returned as strings in the API to prevent integer overflows in some languages. Snowflake ID's are guaranteed to be unique across all of Discord, except in some unique scenarios in which child objects share their parents ID.
1919

2020
## Consistency
2121

@@ -31,12 +31,16 @@ Clients should operate on events and results from the API in as much of a idempo
3131

3232
### User Agent
3333

34-
Clients using the HTTP API must provide a valid [User Agent](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.43) which specifies information about the client library and version, in the following format: `User-Agent: DiscordBot ($url, $versionNumber)`
34+
Clients using the HTTP API must provide a valid [User Agent](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.43) which specifies information about the client library and version, in the following format:
35+
36+
```
37+
User-Agent: DiscordBot ($url, $versionNumber)
38+
```
3539

3640
### Rate Limiting
3741

3842
The HTTP API implements a process for limiting and preventing excessive requests in accordance with [RFC 6585](https://tools.ietf.org/html/rfc6585#section-4). When returning a `429` error code, our API servers will always provide a `Retry-After` header allowing you to delay further requests within your API client. API users that regularly hit and ignore rate limits will have their API keys revoked, and be blocked from the platform.
3943

40-
## Gateway (websocket) API
44+
## Gateway (WebSocket) API
4145

4246
Discord's Gateway API is used for maintaining persistent, stateful websocket connections between your client and our servers. These connections are used for sending and receiving real-time events your client can use to track and update local state. The Gateway API uses secure websocket connections as specified in [RFC 6455](https://tools.ietf.org/html/rfc6455). For information on opening Gateway connections, please see the [Gateway API](#DOCS_GATEWAY_TOPIC/gateways) section.

docs/topics/OAUTH2.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The first step in implementing OAuth2 is [registering a developer application](#
1919

2020
### Converting User Accounts
2121

22-
We've provided functionality for users looking to migrate previous (unofficial) user accounts to fully-fledged bot accounts. Users have until May 1st to convert previous accounts, after which the migration endpoint will be removed, and public bots using normal user accounts will be deactivated. The migration endpoint should only be used by users with a good understand of the command line, and the current Discord API landscape. Other users should create a new bot account instead. Once migrated, there is **no way to rollback to a normal account** (don't be a Bastian). Therefore, this process should **not** be used by normal users looking to continue accessing their accounts from the desktop/web apps.
22+
We've provided functionality for users looking to migrate previous (unofficial) user accounts to fully-fledged bot accounts. Users have until May 1st, 2016 to convert previous accounts, after which the migration endpoint will be removed, and public bots using normal user accounts will be deactivated. The migration endpoint should only be used by users with a good understand of the command line, and the current Discord API landscape. Other users should create a new bot account instead. Once migrated, there is **no way to rollback to a normal account** (don't be a Bastian). Therefore, this process should **not** be used by normal users looking to continue accessing their accounts from the desktop/web apps.
2323

2424
#### Creating Application
2525

@@ -77,4 +77,4 @@ A URL can be generated that redirects authenticated users to the add-bot flow, b
7777
https://discordapp.com/oauth2/authorize?&client_id=157730590492196864&scope=bot&permissions=0
7878
```
7979

80-
Where client\_id is your _bot_ account's ID, and permissions is an integer following the [permissions](#DOCS_PERMISSIONS/bitwise-permission-flags) format.
80+
Where `client_id` is your _bot_ applications ID, and permissions is an integer following the [permissions](#DOCS_PERMISSIONS/bitwise-permission-flags) format.

0 commit comments

Comments
 (0)