-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
doctypes.go
63 lines (47 loc) · 1.51 KB
/
doctypes.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/*
Copyright 2019 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package main
// these should be kept in sync with the output from controller-tools
type DetailedHelp struct {
Summary string `json:"summary"`
Details string `json:"details"`
}
type Argument struct {
Type string `json:"type"`
Optional bool `json:"optional"`
ItemType *Argument `json:"itemType"`
}
type FieldHelp struct {
// definition
Name string `json:"name"`
Argument `json:",inline"`
// help
DetailedHelp `json:",inline"`
}
type MarkerDoc struct {
// definition
Name string `json:"name"`
Target string `json:"target"`
// help
DetailedHelp `json:",inline"`
Category string `json:"category"`
DeprecatedInFavorOf *string `json:"deprecatedInFavorOf"`
Fields []FieldHelp `json:"fields"`
}
type CategoryDoc struct {
Category string `json:"category"`
Markers []MarkerDoc `json:"markers"`
}
func (m MarkerDoc) Anonymous() bool {
return len(m.Fields) == 1 && m.Fields[0].Name == ""
}