6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
209 lines
3.7 KiB
Markdown
209 lines
3.7 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "DataSourceSettings"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## DataSourceSettings interface
|
|
|
|
Data Source instance edit model. This is returned from: /api/datasources
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface DataSourceSettings<T extends DataSourceJsonData = DataSourceJsonData, S = {}>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { DataSourceSettings } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [access](#access-property) | <code>string</code> | |
|
|
| [basicAuth](#basicauth-property) | <code>boolean</code> | |
|
|
| [basicAuthPassword](#basicauthpassword-property) | <code>string</code> | |
|
|
| [basicAuthUser](#basicauthuser-property) | <code>string</code> | |
|
|
| [database](#database-property) | <code>string</code> | |
|
|
| [id](#id-property) | <code>number</code> | |
|
|
| [isDefault](#isdefault-property) | <code>boolean</code> | |
|
|
| [jsonData](#jsondata-property) | <code>T</code> | |
|
|
| [name](#name-property) | <code>string</code> | |
|
|
| [orgId](#orgid-property) | <code>number</code> | |
|
|
| [password](#password-property) | <code>string</code> | |
|
|
| [readOnly](#readonly-property) | <code>boolean</code> | |
|
|
| [secureJsonData](#securejsondata-property) | <code>S</code> | |
|
|
| [secureJsonFields](#securejsonfields-property) | <code>KeyValue<boolean></code> | |
|
|
| [type](#type-property) | <code>string</code> | |
|
|
| [typeLogoUrl](#typelogourl-property) | <code>string</code> | |
|
|
| [url](#url-property) | <code>string</code> | |
|
|
| [user](#user-property) | <code>string</code> | |
|
|
| [version](#version-property) | <code>number</code> | |
|
|
| [withCredentials](#withcredentials-property) | <code>boolean</code> | |
|
|
|
|
### access property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
access: string;
|
|
```
|
|
|
|
### basicAuth property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
basicAuth: boolean;
|
|
```
|
|
|
|
### basicAuthPassword property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
basicAuthPassword: string;
|
|
```
|
|
|
|
### basicAuthUser property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
basicAuthUser: string;
|
|
```
|
|
|
|
### database property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
database: string;
|
|
```
|
|
|
|
### id property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
id: number;
|
|
```
|
|
|
|
### isDefault property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
isDefault: boolean;
|
|
```
|
|
|
|
### jsonData property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
jsonData: T;
|
|
```
|
|
|
|
### name property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
name: string;
|
|
```
|
|
|
|
### orgId property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
orgId: number;
|
|
```
|
|
|
|
### password property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
password: string;
|
|
```
|
|
|
|
### readOnly property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
readOnly: boolean;
|
|
```
|
|
|
|
### secureJsonData property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
secureJsonData?: S;
|
|
```
|
|
|
|
### secureJsonFields property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
secureJsonFields?: KeyValue<boolean>;
|
|
```
|
|
|
|
### type property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
type: string;
|
|
```
|
|
|
|
### typeLogoUrl property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
typeLogoUrl: string;
|
|
```
|
|
|
|
### url property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
url: string;
|
|
```
|
|
|
|
### user property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
user: string;
|
|
```
|
|
|
|
### version property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
version?: number;
|
|
```
|
|
|
|
### withCredentials property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
withCredentials: boolean;
|
|
```
|