Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions 2026R1.2/speos_rpc-26-r1.2/GenDocu-template.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Reference documentation


{{range .Files}}
{{$short_name := .Name | replace "ansys/api/speos/" ""}} <!-- Remove base directory -->
<a name="{{.Name | anchor}}"></a>


## {{$short_name}} <!-- Use the cleaned file name here -->
{{.Description}}

{{range .Messages}}
<a name="{{.FullName | anchor}}"></a>

### {{.LongName}}
{{.Description}}

{{if .HasFields}}
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
{{range .Fields -}}
| {{.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}} |
{{end}}
{{end}}

{{if .HasExtensions}}
| Extension | Type | Base | Number | Description |
| --------- | ---- | ---- | ------ | ----------- |
{{range .Extensions -}}
| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
{{end}}
{{end}}

{{end}} <!-- end messages -->

{{range .Enums}}
<a name="{{.FullName | anchor}}"></a>

### {{.LongName}}
{{.Description}}

| Name | Number | Description |
| ---- | ------ | ----------- |
{{range .Values -}}
| {{.Name}} | {{.Number}} | {{nobr .Description}} |
{{end}}

{{end}} <!-- end enums -->

{{if .HasExtensions}}
<a name="{{$short_name | anchor}}-extensions"></a>

### File-level Extensions
| Extension | Type | Base | Number | Description |
| --------- | ---- | ---- | ------ | ----------- |
{{range .Extensions -}}
| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} |
{{end}}
{{end}} <!-- end HasExtensions -->

{{range .Services}}
<a name="{{.FullName | anchor}}"></a>

### {{.Name}}
{{.Description}}

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
{{range .Methods -}}
| {{.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}} |
{{end}}
{{end}} <!-- end services -->

{{end}}

## Scalar Value Types

| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
{{range .Scalars -}}
| <a name="{{.ProtoType | anchor}}" /> {{.ProtoType}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | {{.PythonType}} | {{.GoType}} | {{.CSharp}} | {{.PhpType}} | {{.RubyType}} |
{{end}}
23 changes: 23 additions & 0 deletions 2026R1.2/speos_rpc-26-r1.2/TOC.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
- name: Introduction
href: index.md
- name: Unsupported features and limitations
href: unsupported-features-limitations.md
- name: Reference documentation
href: api-reference.md
- name: Changelog
href: changelogs\speos_changelogs_rpc.md
items:
- name: Speos RPC Changelog 2026 R1 SP02
href: changelogs\speos_changelogs_rpc_2612.md
- name: Speos RPC Changelog 2026 R1 SP01
href: changelogs\speos_changelogs_rpc_2611.md
- name: Speos RPC Changelog 2026 R1
href: changelogs\speos_changelogs_rpc_261.md
- name: Speos RPC Changelog 2025 R2 SP03
href: changelogs\speos_changelogs_rpc_2523.md
- name: Speos RPC Changelog 2025 R2 SP01
href: changelogs\speos_changelogs_rpc_2521.md
- name: Speos RPC Changelog 2025 R2
href: changelogs\speos_changelogs_rpc_252.md
- name: Speos RPC Changelog 2025 R1 SP04
href: changelogs\speos_changelogs_rpc_2514.md
Loading