mirror of
https://github.com/LukeHagar/discoursejs.git
synced 2025-12-09 12:27:49 +00:00
ci: regenerated with OpenAPI Doc latest, Speakeasy CLI 1.134.1
This commit is contained in:
44
docs/sdks/site/README.md
Normal file
44
docs/sdks/site/README.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Site
|
||||
(*site*)
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [getSite](#getsite) - Get site info
|
||||
|
||||
## getSite
|
||||
|
||||
Can be used to fetch all categories and subcategories
|
||||
|
||||
### Example Usage
|
||||
|
||||
```typescript
|
||||
import { SDK } from "openapi";
|
||||
|
||||
async function run() {
|
||||
const sdk = new SDK();
|
||||
|
||||
const res = await sdk.site.getSite();
|
||||
|
||||
if (res.statusCode == 200) {
|
||||
// handle response
|
||||
}
|
||||
}
|
||||
|
||||
run();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
|
||||
| `config` | [AxiosRequestConfig](https://axios-http.com/docs/req_config) | :heavy_minus_sign: | Available config options for making requests. |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
**Promise<[operations.GetSiteResponse](../../sdk/models/operations/getsiteresponse.md)>**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
Reference in New Issue
Block a user