1+ # Reference documentation
2+
3+
4+ {{range .Files}}
5+ {{$short_name := .Name | replace "ansys/api/speos/" ""}} <!-- Remove base directory -->
6+ <a name="{{.Name | anchor}}"></a>
7+
8+
9+ ## {{$short_name}} <!-- Use the cleaned file name here -->
10+ {{.Description}}
11+
12+ {{range .Messages}}
13+ <a name="{{.FullName | anchor}}"></a>
14+
15+ ### {{.LongName}}
16+ {{.Description}}
17+
18+ {{if .HasFields}}
19+ | Field | Type | Label | Description |
20+ | ----- | ---- | ----- | ----------- |
21+ {{range .Fields -}}
22+ | {{.Name}} | [{{.LongType | replace "ansys.api.speos." ""}}](#{{.FullType | anchor}}) | {{.Label}} | {{if (index .Options "deprecated"|default false)}}**Deprecated.** {{end}}{{.Description | replace "\n" "<br>" | nobr}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
23+ {{end}}
24+ {{end}}
25+
26+ {{if .HasExtensions}}
27+ | Extension | Type | Base | Number | Description |
28+ | --------- | ---- | ---- | ------ | ----------- |
29+ {{range .Extensions -}}
30+ | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
31+ {{end}}
32+ {{end}}
33+
34+ {{end}} <!-- end messages -->
35+
36+ {{range .Enums}}
37+ <a name="{{.FullName | anchor}}"></a>
38+
39+ ### {{.LongName}}
40+ {{.Description}}
41+
42+ | Name | Number | Description |
43+ | ---- | ------ | ----------- |
44+ {{range .Values -}}
45+ | {{.Name}} | {{.Number}} | {{nobr .Description}} |
46+ {{end}}
47+
48+ {{end}} <!-- end enums -->
49+
50+ {{if .HasExtensions}}
51+ <a name="{{$short_name | anchor}}-extensions"></a>
52+
53+ ### File-level Extensions
54+ | Extension | Type | Base | Number | Description |
55+ | --------- | ---- | ---- | ------ | ----------- |
56+ {{range .Extensions -}}
57+ | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} |
58+ {{end}}
59+ {{end}} <!-- end HasExtensions -->
60+
61+ {{range .Services}}
62+ <a name="{{.FullName | anchor}}"></a>
63+
64+ ### {{.Name}}
65+ {{.Description}}
66+
67+ | Method Name | Request Type | Response Type | Description |
68+ | ----------- | ------------ | ------------- | ------------|
69+ {{range .Methods -}}
70+ | {{.Name}} | [{{.RequestLongType | replace ".ansys.api.speos." "" | replace "ansys.api.speos." ""}}](#{{.RequestFullType | anchor}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType | replace ".ansys.api.speos." "" | replace "ansys.api.speos." ""}}](#{{.ResponseFullType | anchor}}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} |
71+ {{end}}
72+ {{end}} <!-- end services -->
73+
74+ {{end}}
75+
76+ ## Scalar Value Types
77+
78+ | .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
79+ | ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
80+ {{range .Scalars -}}
81+ | <a name="{{.ProtoType | anchor}}" /> {{.ProtoType}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | {{.PythonType}} | {{.GoType}} | {{.CSharp}} | {{.PhpType}} | {{.RubyType}} |
82+ {{end}}
0 commit comments