Skip to content

Commit

Permalink
Merge pull request #40 from ably/remove-mention-of-major-REST-api-ver…
Browse files Browse the repository at this point in the history
…sion

Fix terminology used to refer to REST API version
  • Loading branch information
lawrence-forooghian authored Dec 5, 2024
2 parents 25ec0cd + 7cc5a28 commit cfc69c3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion descriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ A client that offers a simple stateless API to interact directly with Ably's RES
| request(String method, String path, Int version, `Dict<String, String>` params?, JsonObject \| JsonArray body?, `Dict<String, String>` headers?) => io HttpPaginatedResponse || | RSC19 | Makes a REST request to a provided path. This is provided as a convenience for developers who wish to use REST API functionality that is either not documented or is not yet included in the public API, without having to directly handle features such as authentication, paging, fallback hosts, MsgPack and JSON support. |
|| `method` ||| The request method to use, such as `GET`, `POST`. |
|| `path` ||| The request path. |
|| `version` || RSC19f1 | The major version of the Ably REST API to use. See the [REST API reference](https://ably.com/docs/api/rest-api#versioning) for information on versioning. |
|| `version` || RSC19f1 | The version of the Ably REST API to use. See the [REST API reference](https://ably.com/docs/api/rest-api#versioning) for information on versioning. |
|| `params` ||| The parameters to include in the URL query of the request. The parameters depend on the endpoint being queried. See the [REST API reference](https://ably.com/docs/api/rest-api) for the available parameters of each endpoint. |
|| `body` ||| The JSON body of the request. |
|| `headers` ||| Additional HTTP headers to include in the request. |
Expand Down

0 comments on commit cfc69c3

Please sign in to comment.