mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-01-21 12:00:33 -06:00
113 lines
3.1 KiB
Cheetah
113 lines
3.1 KiB
Cheetah
---
|
|
title: "GRPC API"
|
|
date: 2018-05-02T00:00:00+00:00
|
|
weight: 40
|
|
geekdocRepo: https://github.com/owncloud/ocis-thumbnails
|
|
geekdocEditPath: edit/master/docs
|
|
geekdocFilePath: grpc.md
|
|
---
|
|
|
|
<a name="top"></a>
|
|
|
|
## Table of Contents
|
|
{{range .Files}}
|
|
{{$file_name := .Name}}- [{{.Name}}](#{{.Name}})
|
|
{{- if .Messages }}
|
|
{{range .Messages}} - [{{.LongName}}](#{{.FullName}})
|
|
{{end}}
|
|
{{- end -}}
|
|
{{- if .Enums }}
|
|
{{range .Enums}} - [{{.LongName}}](#{{.FullName}})
|
|
{{end}}
|
|
{{- end -}}
|
|
{{- if .Extensions }}
|
|
{{range .Extensions}} - [File-level Extensions](#{{$file_name}}-extensions)
|
|
{{end}}
|
|
{{- end -}}
|
|
{{- if .Services }}
|
|
{{range .Services}} - [{{.Name}}](#{{.FullName}})
|
|
{{end}}
|
|
{{- end -}}
|
|
{{end}}
|
|
- [Scalar Value Types](#scalar-value-types)
|
|
|
|
{{range .Files}}
|
|
{{$file_name := .Name}}
|
|
<a name="{{.Name}}"></a>
|
|
<p align="right"><a href="#top">Top</a></p>
|
|
|
|
## {{.Name}}
|
|
{{.Description}}
|
|
|
|
{{range .Messages}}
|
|
<a name="{{.FullName}}"></a>
|
|
|
|
### {{.LongName}}
|
|
{{.Description}}
|
|
|
|
{{if .HasFields}}
|
|
| Field | Type | Label | Description |
|
|
| ----- | ---- | ----- | ----------- |
|
|
{{range .Fields -}}
|
|
| {{.Name}} | [{{.LongType}}](#{{.FullType}}) | {{.Label}} | {{nobr .Description}}{{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}}"></a>
|
|
|
|
### {{.LongName}}
|
|
{{.Description}}
|
|
|
|
| Name | Number | Description |
|
|
| ---- | ------ | ----------- |
|
|
{{range .Values -}}
|
|
| {{.Name}} | {{.Number}} | {{nobr .Description}} |
|
|
{{end}}
|
|
|
|
{{end}} <!-- end enums -->
|
|
|
|
{{if .HasExtensions}}
|
|
<a name="{{$file_name}}-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}}"></a>
|
|
|
|
### {{.Name}}
|
|
{{.Description}}
|
|
|
|
| Method Name | Request Type | Response Type | Description |
|
|
| ----------- | ------------ | ------------- | ------------|
|
|
{{range .Methods -}}
|
|
| {{.Name}} | [{{.RequestLongType}}](#{{.RequestFullType}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseFullType}}){{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}}" /> {{.ProtoType}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | {{.PythonType}} | {{.GoType}} | {{.CSharp}} | {{.PhpType}} | {{.RubyType}} |
|
|
{{end}}
|