Skip to content

Commit ac773fd

Browse files
authored
Merge pull request #484 from kinvolk/fix-default-class-names
Fix default class names
2 parents 490b989 + 5146e4f commit ac773fd

File tree

107 files changed

+1256
-970
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

107 files changed

+1256
-970
lines changed

docs/development/api/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ slug: "_index"
1515
- [lib/k8s/configMap](modules/lib_k8s_configMap.md)
1616
- [lib/k8s/crd](modules/lib_k8s_crd.md)
1717
- [lib/k8s/cronJob](modules/lib_k8s_cronJob.md)
18-
- [lib/k8s/customresource](modules/lib_k8s_customresource.md)
1918
- [lib/k8s/daemonSet](modules/lib_k8s_daemonSet.md)
2019
- [lib/k8s/deployment](modules/lib_k8s_deployment.md)
2120
- [lib/k8s/event](modules/lib_k8s_event.md)
2221
- [lib/k8s/ingress](modules/lib_k8s_ingress.md)
2322
- [lib/k8s/job](modules/lib_k8s_job.md)
2423
- [lib/k8s/namespace](modules/lib_k8s_namespace.md)
24+
- [lib/k8s/networkpolicy](modules/lib_k8s_networkpolicy.md)
2525
- [lib/k8s/node](modules/lib_k8s_node.md)
2626
- [lib/k8s/persistentVolume](modules/lib_k8s_persistentVolume.md)
2727
- [lib/k8s/persistentVolumeClaim](modules/lib_k8s_persistentVolumeClaim.md)

docs/development/api/classes/lib_k8s_clusterRole.default.md renamed to docs/development/api/classes/lib_k8s_clusterRole.ClusterRole.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
title: "Class: default"
3-
linkTitle: "default"
4-
slug: "lib_k8s_clusterRole.default"
2+
title: "Class: ClusterRole"
3+
linkTitle: "ClusterRole"
4+
slug: "lib_k8s_clusterRole.ClusterRole"
55
---
66

7-
[lib/k8s/clusterRole](../modules/lib_k8s_clusterRole.md).default
7+
[lib/k8s/clusterRole](../modules/lib_k8s_clusterRole.md).ClusterRole
88

99
## Hierarchy
1010

11-
- [`default`](lib_k8s_role.default.md)
11+
- [`Role`](lib_k8s_role.Role.md)
1212

13-
**`default`**
13+
**`ClusterRole`**
1414

1515
## Constructors
1616

1717
### constructor
1818

19-
**new default**(`json`)
19+
**new ClusterRole**(`json`)
2020

2121
#### Parameters
2222

@@ -26,11 +26,11 @@ slug: "lib_k8s_clusterRole.default"
2626

2727
#### Inherited from
2828

29-
[default](lib_k8s_role.default.md).[constructor](lib_k8s_role.default.md#constructor)
29+
[Role](lib_k8s_role.Role.md).[constructor](lib_k8s_role.Role.md#constructor)
3030

3131
#### Defined in
3232

33-
[lib/k8s/cluster.ts:70](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L70)
33+
[lib/k8s/cluster.ts:76](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L76)
3434

3535
## Properties
3636

@@ -52,11 +52,11 @@ slug: "lib_k8s_clusterRole.default"
5252

5353
#### Overrides
5454

55-
[default](lib_k8s_role.default.md).[apiEndpoint](lib_k8s_role.default.md#apiendpoint)
55+
[Role](lib_k8s_role.Role.md).[apiEndpoint](lib_k8s_role.Role.md#apiendpoint)
5656

5757
#### Defined in
5858

59-
[lib/k8s/clusterRole.ts:5](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/clusterRole.ts#L5)
59+
[lib/k8s/clusterRole.ts:5](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/clusterRole.ts#L5)
6060

6161
___
6262

@@ -66,11 +66,11 @@ ___
6666

6767
#### Inherited from
6868

69-
[default](lib_k8s_role.default.md).[className](lib_k8s_role.default.md#classname)
69+
[Role](lib_k8s_role.Role.md).[className](lib_k8s_role.Role.md#classname)
7070

7171
#### Defined in
7272

73-
[lib/k8s/cluster.ts:71](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L71)
73+
[lib/k8s/cluster.ts:77](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L77)
7474

7575
## Accessors
7676

@@ -84,7 +84,7 @@ ___
8484

8585
#### Defined in
8686

87-
[lib/k8s/clusterRole.ts:7](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/clusterRole.ts#L7)
87+
[lib/k8s/clusterRole.ts:7](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/clusterRole.ts#L7)
8888

8989
___
9090

@@ -102,7 +102,7 @@ Role.rules
102102

103103
#### Defined in
104104

105-
[lib/k8s/role.ts:17](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/role.ts#L17)
105+
[lib/k8s/role.ts:17](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/role.ts#L17)
106106

107107
## Methods
108108

@@ -122,11 +122,11 @@ Role.rules
122122

123123
#### Inherited from
124124

125-
[default](lib_k8s_role.default.md).[apiList](lib_k8s_role.default.md#apilist)
125+
[Role](lib_k8s_role.Role.md).[apiList](lib_k8s_role.Role.md#apilist)
126126

127127
#### Defined in
128128

129-
[lib/k8s/cluster.ts:55](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L55)
129+
[lib/k8s/cluster.ts:60](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L60)
130130

131131
___
132132

@@ -146,11 +146,11 @@ ___
146146

147147
#### Inherited from
148148

149-
[default](lib_k8s_role.default.md).[getErrorMessage](lib_k8s_role.default.md#geterrormessage)
149+
[Role](lib_k8s_role.Role.md).[getErrorMessage](lib_k8s_role.Role.md#geterrormessage)
150150

151151
#### Defined in
152152

153-
[lib/k8s/cluster.ts:69](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L69)
153+
[lib/k8s/cluster.ts:75](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L75)
154154

155155
___
156156

@@ -173,57 +173,58 @@ ___
173173

174174
#### Inherited from
175175

176-
[default](lib_k8s_role.default.md).[useApiGet](lib_k8s_role.default.md#useapiget)
176+
[Role](lib_k8s_role.Role.md).[useApiGet](lib_k8s_role.Role.md#useapiget)
177177

178178
#### Defined in
179179

180-
[lib/k8s/cluster.ts:60](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L60)
180+
[lib/k8s/cluster.ts:66](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L66)
181181

182182
___
183183

184184
### useApiList
185185

186-
`Static` **useApiList**(`onList`, `onError?`): `any`
186+
`Static` **useApiList**(`onList`, `onError?`, `opts?`): `any`
187187

188188
#### Parameters
189189

190190
| Name | Type |
191191
| :------ | :------ |
192192
| `onList` | (`arg`: `any`[]) => `void` |
193193
| `onError?` | (`err`: [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md)) => `void` |
194+
| `opts?` | [`ApiListOptions`](../interfaces/lib_k8s_cluster.ApiListOptions.md) |
194195

195196
#### Returns
196197

197198
`any`
198199

199200
#### Inherited from
200201

201-
[default](lib_k8s_role.default.md).[useApiList](lib_k8s_role.default.md#useapilist)
202+
[Role](lib_k8s_role.Role.md).[useApiList](lib_k8s_role.Role.md#useapilist)
202203

203204
#### Defined in
204205

205-
[lib/k8s/cluster.ts:56](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L56)
206+
[lib/k8s/cluster.ts:61](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L61)
206207

207208
___
208209

209210
### useList
210211

211-
`Static` **useList**(`onList?`): [`any`[], ``null`` \| [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md), (`items`: `any`[]) => `void`, (`err`: ``null`` \| [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md)) => `void`]
212+
`Static` **useList**(`opts?`): [`any`[], ``null`` \| [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md), (`items`: `any`[]) => `void`, (`err`: ``null`` \| [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md)) => `void`]
212213

213214
#### Parameters
214215

215216
| Name | Type |
216217
| :------ | :------ |
217-
| `onList?` | (...`arg`: `any`[]) => `any` |
218+
| `opts?` | [`ApiListOptions`](../interfaces/lib_k8s_cluster.ApiListOptions.md) |
218219

219220
#### Returns
220221

221222
[`any`[], ``null`` \| [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md), (`items`: `any`[]) => `void`, (`err`: ``null`` \| [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md)) => `void`]
222223

223224
#### Inherited from
224225

225-
[default](lib_k8s_role.default.md).[useList](lib_k8s_role.default.md#uselist)
226+
[Role](lib_k8s_role.Role.md).[useList](lib_k8s_role.Role.md#uselist)
226227

227228
#### Defined in
228229

229-
[lib/k8s/cluster.ts:66](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L66)
230+
[lib/k8s/cluster.ts:72](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L72)

docs/development/api/classes/lib_k8s_clusterRoleBinding.default.md renamed to docs/development/api/classes/lib_k8s_clusterRoleBinding.ClusterRoleBinding.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
title: "Class: default"
3-
linkTitle: "default"
4-
slug: "lib_k8s_clusterRoleBinding.default"
2+
title: "Class: ClusterRoleBinding"
3+
linkTitle: "ClusterRoleBinding"
4+
slug: "lib_k8s_clusterRoleBinding.ClusterRoleBinding"
55
---
66

7-
[lib/k8s/clusterRoleBinding](../modules/lib_k8s_clusterRoleBinding.md).default
7+
[lib/k8s/clusterRoleBinding](../modules/lib_k8s_clusterRoleBinding.md).ClusterRoleBinding
88

99
## Hierarchy
1010

11-
- [`default`](lib_k8s_roleBinding.default.md)
11+
- [`RoleBinding`](lib_k8s_roleBinding.RoleBinding.md)
1212

13-
**`default`**
13+
**`ClusterRoleBinding`**
1414

1515
## Constructors
1616

1717
### constructor
1818

19-
**new default**(`json`)
19+
**new ClusterRoleBinding**(`json`)
2020

2121
#### Parameters
2222

@@ -26,11 +26,11 @@ slug: "lib_k8s_clusterRoleBinding.default"
2626

2727
#### Inherited from
2828

29-
[default](lib_k8s_roleBinding.default.md).[constructor](lib_k8s_roleBinding.default.md#constructor)
29+
[RoleBinding](lib_k8s_roleBinding.RoleBinding.md).[constructor](lib_k8s_roleBinding.RoleBinding.md#constructor)
3030

3131
#### Defined in
3232

33-
[lib/k8s/cluster.ts:70](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L70)
33+
[lib/k8s/cluster.ts:76](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L76)
3434

3535
## Properties
3636

@@ -52,11 +52,11 @@ slug: "lib_k8s_clusterRoleBinding.default"
5252

5353
#### Overrides
5454

55-
[default](lib_k8s_roleBinding.default.md).[apiEndpoint](lib_k8s_roleBinding.default.md#apiendpoint)
55+
[RoleBinding](lib_k8s_roleBinding.RoleBinding.md).[apiEndpoint](lib_k8s_roleBinding.RoleBinding.md#apiendpoint)
5656

5757
#### Defined in
5858

59-
[lib/k8s/clusterRoleBinding.ts:5](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/clusterRoleBinding.ts#L5)
59+
[lib/k8s/clusterRoleBinding.ts:5](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/clusterRoleBinding.ts#L5)
6060

6161
## Accessors
6262

@@ -70,7 +70,7 @@ slug: "lib_k8s_clusterRoleBinding.default"
7070

7171
#### Defined in
7272

73-
[lib/k8s/clusterRoleBinding.ts:11](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/clusterRoleBinding.ts#L11)
73+
[lib/k8s/clusterRoleBinding.ts:11](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/clusterRoleBinding.ts#L11)
7474

7575
___
7676

@@ -88,7 +88,7 @@ RoleBinding.roleRef
8888

8989
#### Defined in
9090

91-
[lib/k8s/roleBinding.ts:21](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/roleBinding.ts#L21)
91+
[lib/k8s/roleBinding.ts:21](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/roleBinding.ts#L21)
9292

9393
___
9494

@@ -106,7 +106,7 @@ RoleBinding.subjects
106106

107107
#### Defined in
108108

109-
[lib/k8s/roleBinding.ts:25](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/roleBinding.ts#L25)
109+
[lib/k8s/roleBinding.ts:25](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/roleBinding.ts#L25)
110110

111111
___
112112

@@ -124,7 +124,7 @@ RoleBinding.className
124124

125125
#### Defined in
126126

127-
[lib/k8s/clusterRoleBinding.ts:7](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/clusterRoleBinding.ts#L7)
127+
[lib/k8s/clusterRoleBinding.ts:7](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/clusterRoleBinding.ts#L7)
128128

129129
## Methods
130130

@@ -144,11 +144,11 @@ RoleBinding.className
144144

145145
#### Inherited from
146146

147-
[default](lib_k8s_roleBinding.default.md).[apiList](lib_k8s_roleBinding.default.md#apilist)
147+
[RoleBinding](lib_k8s_roleBinding.RoleBinding.md).[apiList](lib_k8s_roleBinding.RoleBinding.md#apilist)
148148

149149
#### Defined in
150150

151-
[lib/k8s/cluster.ts:55](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L55)
151+
[lib/k8s/cluster.ts:60](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L60)
152152

153153
___
154154

@@ -168,11 +168,11 @@ ___
168168

169169
#### Inherited from
170170

171-
[default](lib_k8s_roleBinding.default.md).[getErrorMessage](lib_k8s_roleBinding.default.md#geterrormessage)
171+
[RoleBinding](lib_k8s_roleBinding.RoleBinding.md).[getErrorMessage](lib_k8s_roleBinding.RoleBinding.md#geterrormessage)
172172

173173
#### Defined in
174174

175-
[lib/k8s/cluster.ts:69](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L69)
175+
[lib/k8s/cluster.ts:75](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L75)
176176

177177
___
178178

@@ -195,57 +195,58 @@ ___
195195

196196
#### Inherited from
197197

198-
[default](lib_k8s_roleBinding.default.md).[useApiGet](lib_k8s_roleBinding.default.md#useapiget)
198+
[RoleBinding](lib_k8s_roleBinding.RoleBinding.md).[useApiGet](lib_k8s_roleBinding.RoleBinding.md#useapiget)
199199

200200
#### Defined in
201201

202-
[lib/k8s/cluster.ts:60](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L60)
202+
[lib/k8s/cluster.ts:66](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L66)
203203

204204
___
205205

206206
### useApiList
207207

208-
`Static` **useApiList**(`onList`, `onError?`): `any`
208+
`Static` **useApiList**(`onList`, `onError?`, `opts?`): `any`
209209

210210
#### Parameters
211211

212212
| Name | Type |
213213
| :------ | :------ |
214214
| `onList` | (`arg`: `any`[]) => `void` |
215215
| `onError?` | (`err`: [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md)) => `void` |
216+
| `opts?` | [`ApiListOptions`](../interfaces/lib_k8s_cluster.ApiListOptions.md) |
216217

217218
#### Returns
218219

219220
`any`
220221

221222
#### Inherited from
222223

223-
[default](lib_k8s_roleBinding.default.md).[useApiList](lib_k8s_roleBinding.default.md#useapilist)
224+
[RoleBinding](lib_k8s_roleBinding.RoleBinding.md).[useApiList](lib_k8s_roleBinding.RoleBinding.md#useapilist)
224225

225226
#### Defined in
226227

227-
[lib/k8s/cluster.ts:56](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L56)
228+
[lib/k8s/cluster.ts:61](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L61)
228229

229230
___
230231

231232
### useList
232233

233-
`Static` **useList**(`onList?`): [`any`[], ``null`` \| [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md), (`items`: `any`[]) => `void`, (`err`: ``null`` \| [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md)) => `void`]
234+
`Static` **useList**(`opts?`): [`any`[], ``null`` \| [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md), (`items`: `any`[]) => `void`, (`err`: ``null`` \| [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md)) => `void`]
234235

235236
#### Parameters
236237

237238
| Name | Type |
238239
| :------ | :------ |
239-
| `onList?` | (...`arg`: `any`[]) => `any` |
240+
| `opts?` | [`ApiListOptions`](../interfaces/lib_k8s_cluster.ApiListOptions.md) |
240241

241242
#### Returns
242243

243244
[`any`[], ``null`` \| [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md), (`items`: `any`[]) => `void`, (`err`: ``null`` \| [`ApiError`](../interfaces/lib_k8s_apiProxy.ApiError.md)) => `void`]
244245

245246
#### Inherited from
246247

247-
[default](lib_k8s_roleBinding.default.md).[useList](lib_k8s_roleBinding.default.md#uselist)
248+
[RoleBinding](lib_k8s_roleBinding.RoleBinding.md).[useList](lib_k8s_roleBinding.RoleBinding.md#uselist)
248249

249250
#### Defined in
250251

251-
[lib/k8s/cluster.ts:66](https://github.com/kinvolk/headlamp/blob/168f394/frontend/src/lib/k8s/cluster.ts#L66)
252+
[lib/k8s/cluster.ts:72](https://github.com/kinvolk/headlamp/blob/490b989/frontend/src/lib/k8s/cluster.ts#L72)

0 commit comments

Comments
 (0)