mirror of
https://github.com/grafana/grafana.git
synced 2025-07-30 15:02:33 +08:00
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.
3.7 KiB
3.7 KiB
+++
-----------------------------------------------------------------------
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
Signature
export interface DataSourceSettings<T extends DataSourceJsonData = DataSourceJsonData, S = {}>
Import
import { DataSourceSettings } from '@grafana/data';
Properties
| Property | Type | Description |
|---|---|---|
| access | string |
|
| basicAuth | boolean |
|
| basicAuthPassword | string |
|
| basicAuthUser | string |
|
| database | string |
|
| id | number |
|
| isDefault | boolean |
|
| jsonData | T |
|
| name | string |
|
| orgId | number |
|
| password | string |
|
| readOnly | boolean |
|
| secureJsonData | S |
|
| secureJsonFields | KeyValue<boolean> |
|
| type | string |
|
| typeLogoUrl | string |
|
| url | string |
|
| user | string |
|
| version | number |
|
| withCredentials | boolean |
access property
Signature
access: string;
basicAuth property
Signature
basicAuth: boolean;
basicAuthPassword property
Signature
basicAuthPassword: string;
basicAuthUser property
Signature
basicAuthUser: string;
database property
Signature
database: string;
id property
Signature
id: number;
isDefault property
Signature
isDefault: boolean;
jsonData property
Signature
jsonData: T;
name property
Signature
name: string;
orgId property
Signature
orgId: number;
password property
Signature
password: string;
readOnly property
Signature
readOnly: boolean;
secureJsonData property
Signature
secureJsonData?: S;
secureJsonFields property
Signature
secureJsonFields?: KeyValue<boolean>;
type property
Signature
type: string;
typeLogoUrl property
Signature
typeLogoUrl: string;
url property
Signature
url: string;
user property
Signature
user: string;
version property
Signature
version?: number;
withCredentials property
Signature
withCredentials: boolean;