mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2025-12-30 17:00:57 -06:00
Merge pull request #506 from opencloud-eu/update-generated-code
update generated code
This commit is contained in:
Jörn Friedrich Dreyer
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: "opencloud.messages.eventhistory.v0"
|
||||
url: /apis/grpc_apis/opencloud_messages_eventhistory_v0
|
||||
date: 2025-03-27T14:44:40+01:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/opencloud-eu/opencloud
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
|
||||
|
||||
## opencloud/messages/eventhistory/v0/eventhistory.proto
|
||||
|
||||
### Event
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| type | [string](#string) | | REQUIRED. |
|
||||
| id | [string](#string) | | REQUIRED. |
|
||||
| event | [bytes](#bytes) | | REQUIRED |
|
||||
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
|
||||
104
docs/apis/grpc_apis/opencloud/messages/policies/v0/grpc.md
Normal file
104
docs/apis/grpc_apis/opencloud/messages/policies/v0/grpc.md
Normal file
@@ -0,0 +1,104 @@
|
||||
---
|
||||
title: "opencloud.messages.policies.v0"
|
||||
url: /apis/grpc_apis/opencloud_messages_policies_v0
|
||||
date: 2025-03-27T14:44:40+01:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/opencloud-eu/opencloud
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
|
||||
|
||||
## opencloud/messages/policies/v0/policies.proto
|
||||
|
||||
### Environment
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| stage | [Stage](#stage) | | |
|
||||
| user | [User](#user) | | |
|
||||
| request | [Request](#request) | | |
|
||||
| resource | [Resource](#resource) | | |
|
||||
|
||||
### Request
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| method | [string](#string) | | |
|
||||
| path | [string](#string) | | |
|
||||
|
||||
### Resource
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| id | [Resource.ID](#resourceid) | | |
|
||||
| name | [string](#string) | | |
|
||||
| size | [uint64](#uint64) | | |
|
||||
| url | [string](#string) | | |
|
||||
|
||||
### Resource.ID
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| storage_id | [string](#string) | | |
|
||||
| opaque_id | [string](#string) | | |
|
||||
| space_id | [string](#string) | | |
|
||||
|
||||
### User
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| id | [User.ID](#userid) | | |
|
||||
| username | [string](#string) | | |
|
||||
| mail | [string](#string) | | |
|
||||
| display_name | [string](#string) | | |
|
||||
| groups | [string](#string) | repeated | |
|
||||
|
||||
### User.ID
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| opaque_id | [string](#string) | | |
|
||||
|
||||
### Stage
|
||||
|
||||
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| STAGE_PP | 0 | |
|
||||
| STAGE_HTTP | 1 | |
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
|
||||
147
docs/apis/grpc_apis/opencloud/messages/search/v0/grpc.md
Normal file
147
docs/apis/grpc_apis/opencloud/messages/search/v0/grpc.md
Normal file
@@ -0,0 +1,147 @@
|
||||
---
|
||||
title: "opencloud.messages.search.v0"
|
||||
url: /apis/grpc_apis/opencloud_messages_search_v0
|
||||
date: 2025-03-27T14:44:40+01:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/opencloud-eu/opencloud
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
|
||||
|
||||
## opencloud/messages/search/v0/search.proto
|
||||
|
||||
### Audio
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| album | [string](#string) | optional | |
|
||||
| albumArtist | [string](#string) | optional | |
|
||||
| artist | [string](#string) | optional | |
|
||||
| bitrate | [int64](#int64) | optional | |
|
||||
| composers | [string](#string) | optional | |
|
||||
| copyright | [string](#string) | optional | |
|
||||
| disc | [int32](#int32) | optional | |
|
||||
| discCount | [int32](#int32) | optional | |
|
||||
| duration | [int64](#int64) | optional | |
|
||||
| genre | [string](#string) | optional | |
|
||||
| hasDrm | [bool](#bool) | optional | |
|
||||
| isVariableBitrate | [bool](#bool) | optional | |
|
||||
| title | [string](#string) | optional | |
|
||||
| track | [int32](#int32) | optional | |
|
||||
| trackCount | [int32](#int32) | optional | |
|
||||
| year | [int32](#int32) | optional | |
|
||||
|
||||
### Entity
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| ref | [Reference](#reference) | | |
|
||||
| id | [ResourceID](#resourceid) | | |
|
||||
| name | [string](#string) | | |
|
||||
| etag | [string](#string) | | |
|
||||
| size | [uint64](#uint64) | | |
|
||||
| last_modified_time | [google.protobuf.Timestamp](#googleprotobuftimestamp) | | |
|
||||
| mime_type | [string](#string) | | |
|
||||
| permissions | [string](#string) | | |
|
||||
| type | [uint64](#uint64) | | |
|
||||
| deleted | [bool](#bool) | | |
|
||||
| shareRootName | [string](#string) | | |
|
||||
| parent_id | [ResourceID](#resourceid) | | |
|
||||
| tags | [string](#string) | repeated | |
|
||||
| highlights | [string](#string) | | |
|
||||
| audio | [Audio](#audio) | | |
|
||||
| location | [GeoCoordinates](#geocoordinates) | | |
|
||||
| remote_item_id | [ResourceID](#resourceid) | | |
|
||||
| image | [Image](#image) | | |
|
||||
| photo | [Photo](#photo) | | |
|
||||
|
||||
### GeoCoordinates
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| altitude | [double](#double) | optional | |
|
||||
| latitude | [double](#double) | optional | |
|
||||
| longitude | [double](#double) | optional | |
|
||||
|
||||
### Image
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| width | [int32](#int32) | optional | |
|
||||
| height | [int32](#int32) | optional | |
|
||||
|
||||
### Match
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| entity | [Entity](#entity) | | the matched entity |
|
||||
| score | [float](#float) | | the match score |
|
||||
|
||||
### Photo
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| cameraMake | [string](#string) | optional | |
|
||||
| cameraModel | [string](#string) | optional | |
|
||||
| exposureDenominator | [float](#float) | optional | |
|
||||
| exposureNumerator | [float](#float) | optional | |
|
||||
| fNumber | [float](#float) | optional | |
|
||||
| focalLength | [float](#float) | optional | |
|
||||
| iso | [int32](#int32) | optional | |
|
||||
| orientation | [int32](#int32) | optional | |
|
||||
| takenDateTime | [google.protobuf.Timestamp](#googleprotobuftimestamp) | optional | |
|
||||
|
||||
### Reference
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| resource_id | [ResourceID](#resourceid) | | |
|
||||
| path | [string](#string) | | |
|
||||
|
||||
### ResourceID
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| storage_id | [string](#string) | | |
|
||||
| opaque_id | [string](#string) | | |
|
||||
| space_id | [string](#string) | | |
|
||||
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
|
||||
322
docs/apis/grpc_apis/opencloud/messages/settings/v0/grpc.md
Normal file
322
docs/apis/grpc_apis/opencloud/messages/settings/v0/grpc.md
Normal file
@@ -0,0 +1,322 @@
|
||||
---
|
||||
title: "opencloud.messages.settings.v0"
|
||||
url: /apis/grpc_apis/opencloud_messages_settings_v0
|
||||
date: 2025-03-27T14:44:40+01:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/opencloud-eu/opencloud
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
|
||||
|
||||
## opencloud/messages/settings/v0/settings.proto
|
||||
|
||||
### Bool
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| default | [bool](#bool) | | @gotags: yaml:"default" |
|
||||
| label | [string](#string) | | @gotags: yaml:"label" |
|
||||
|
||||
### Bundle
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| id | [string](#string) | | @gotags: yaml:"id" |
|
||||
| name | [string](#string) | | @gotags: yaml:"name" |
|
||||
| type | [Bundle.Type](#bundletype) | | @gotags: yaml:"type" |
|
||||
| extension | [string](#string) | | @gotags: yaml:"extension" |
|
||||
| display_name | [string](#string) | | @gotags: yaml:"display_name" |
|
||||
| settings | [Setting](#setting) | repeated | @gotags: yaml:"settings" |
|
||||
| resource | [Resource](#resource) | | @gotags: yaml:"resource" |
|
||||
|
||||
### CollectionOption
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| key | [string](#string) | | required<br><br>@gotags: yaml:"key" |
|
||||
| int_value | [int64](#int64) | | @gotags: yaml:"int_value" |
|
||||
| string_value | [string](#string) | | @gotags: yaml:"string_value" |
|
||||
| bool_value | [bool](#bool) | | @gotags: yaml:"bool_value" |
|
||||
|
||||
### CollectionValue
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| values | [CollectionOption](#collectionoption) | repeated | @gotags: yaml:"values" |
|
||||
|
||||
### Identifier
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| extension | [string](#string) | | |
|
||||
| bundle | [string](#string) | | |
|
||||
| setting | [string](#string) | | |
|
||||
|
||||
### Int
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| default | [int64](#int64) | | @gotags: yaml:"default" |
|
||||
| min | [int64](#int64) | | @gotags: yaml:"min" |
|
||||
| max | [int64](#int64) | | @gotags: yaml:"max" |
|
||||
| step | [int64](#int64) | | @gotags: yaml:"step" |
|
||||
| placeholder | [string](#string) | | @gotags: yaml:"placeholder" |
|
||||
|
||||
### ListOption
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| value | [ListOptionValue](#listoptionvalue) | | @gotags: yaml:"value" |
|
||||
| default | [bool](#bool) | | @gotags: yaml:"default" |
|
||||
| display_value | [string](#string) | | @gotags: yaml:"display_value" |
|
||||
|
||||
### ListOptionValue
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| string_value | [string](#string) | | @gotags: yaml:"string_value" |
|
||||
| int_value | [int64](#int64) | | @gotags: yaml:"int_value" |
|
||||
| bool_value | [bool](#bool) | | @gotags: yaml:"bool_value" |
|
||||
|
||||
### ListValue
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| values | [ListOptionValue](#listoptionvalue) | repeated | @gotags: yaml:"values" |
|
||||
|
||||
### MultiChoiceCollection
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| options | [MultiChoiceCollectionOption](#multichoicecollectionoption) | repeated | @gotags: yaml:"options" |
|
||||
|
||||
### MultiChoiceCollectionOption
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| value | [MultiChoiceCollectionOptionValue](#multichoicecollectionoptionvalue) | | @gotags: yaml:"value" |
|
||||
| key | [string](#string) | | @gotags: yaml:"key" |
|
||||
| attribute | [string](#string) | | @gotags: yaml:"attribute" |
|
||||
| display_value | [string](#string) | | @gotags: yaml:"display_value" |
|
||||
|
||||
### MultiChoiceCollectionOptionValue
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| int_value | [Int](#int) | | @gotags: yaml:"int_value" |
|
||||
| string_value | [String](#string) | | @gotags: yaml:"string_value" |
|
||||
| bool_value | [Bool](#bool) | | @gotags: yaml:"bool_value" |
|
||||
|
||||
### MultiChoiceList
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| options | [ListOption](#listoption) | repeated | @gotags: yaml:"options" |
|
||||
|
||||
### Permission
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| operation | [Permission.Operation](#permissionoperation) | | @gotags: yaml:"operation" |
|
||||
| constraint | [Permission.Constraint](#permissionconstraint) | | @gotags: yaml:"constraint" |
|
||||
|
||||
### Resource
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| type | [Resource.Type](#resourcetype) | | |
|
||||
| id | [string](#string) | | |
|
||||
|
||||
### Setting
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| id | [string](#string) | | @gotags: yaml:"id" |
|
||||
| name | [string](#string) | | @gotags: yaml:"name" |
|
||||
| display_name | [string](#string) | | @gotags: yaml:"display_name" |
|
||||
| description | [string](#string) | | @gotags: yaml:"description" |
|
||||
| int_value | [Int](#int) | | @gotags: yaml:"int_value" |
|
||||
| string_value | [String](#string) | | @gotags: yaml:"string_value" |
|
||||
| bool_value | [Bool](#bool) | | @gotags: yaml:"bool_value" |
|
||||
| single_choice_value | [SingleChoiceList](#singlechoicelist) | | @gotags: yaml:"single_choice_value" |
|
||||
| multi_choice_value | [MultiChoiceList](#multichoicelist) | | @gotags: yaml:"multi_choice_value" |
|
||||
| permission_value | [Permission](#permission) | | @gotags: yaml:"permission_value" |
|
||||
| multi_choice_collection_value | [MultiChoiceCollection](#multichoicecollection) | | @gotags: yaml:"multi_choice_collection_value" |
|
||||
| resource | [Resource](#resource) | | @gotags: yaml:"resource" |
|
||||
|
||||
### SingleChoiceList
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| options | [ListOption](#listoption) | repeated | @gotags: yaml:"options" |
|
||||
|
||||
### String
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| default | [string](#string) | | @gotags: yaml:"default" |
|
||||
| required | [bool](#bool) | | @gotags: yaml:"required" |
|
||||
| min_length | [int32](#int32) | | @gotags: yaml:"min_length" |
|
||||
| max_length | [int32](#int32) | | @gotags: yaml:"max_length" |
|
||||
| placeholder | [string](#string) | | @gotags: yaml:"placeholder" |
|
||||
|
||||
### UserRoleAssignment
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| id | [string](#string) | | id is generated upon saving the assignment |
|
||||
| account_uuid | [string](#string) | | |
|
||||
| role_id | [string](#string) | | the role_id is a bundle_id internally |
|
||||
|
||||
### UserRoleAssignmentFilter
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| type | [UserRoleAssignmentFilter.Type](#userroleassignmentfiltertype) | | |
|
||||
| account_uuid | [string](#string) | | |
|
||||
| role_id | [string](#string) | | |
|
||||
|
||||
### Value
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| id | [string](#string) | | id is the id of the Value. It is generated on saving it.<br><br>@gotags: yaml:"id" |
|
||||
| bundle_id | [string](#string) | | @gotags: yaml:"bundle_id" |
|
||||
| setting_id | [string](#string) | | setting_id is the id of the setting from within its bundle.<br><br>@gotags: yaml:"setting_id" |
|
||||
| account_uuid | [string](#string) | | @gotags: yaml:"account_uuid" |
|
||||
| resource | [Resource](#resource) | | @gotags: yaml:"resource" |
|
||||
| bool_value | [bool](#bool) | | @gotags: yaml:"bool_value" |
|
||||
| int_value | [int64](#int64) | | @gotags: yaml:"int_value" |
|
||||
| string_value | [string](#string) | | @gotags: yaml:"string_value" |
|
||||
| list_value | [ListValue](#listvalue) | | @gotags: yaml:"list_value" |
|
||||
| collection_value | [CollectionValue](#collectionvalue) | | @gotags: yaml:"collection_value" |
|
||||
|
||||
### ValueWithIdentifier
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| identifier | [Identifier](#identifier) | | |
|
||||
| value | [Value](#value) | | |
|
||||
|
||||
### Bundle.Type
|
||||
|
||||
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| TYPE_UNKNOWN | 0 | |
|
||||
| TYPE_DEFAULT | 1 | |
|
||||
| TYPE_ROLE | 2 | |
|
||||
### Permission.Constraint
|
||||
|
||||
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| CONSTRAINT_UNKNOWN | 0 | |
|
||||
| CONSTRAINT_OWN | 1 | |
|
||||
| CONSTRAINT_SHARED | 2 | |
|
||||
| CONSTRAINT_ALL | 3 | |
|
||||
### Permission.Operation
|
||||
|
||||
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| OPERATION_UNKNOWN | 0 | |
|
||||
| OPERATION_CREATE | 1 | |
|
||||
| OPERATION_READ | 2 | |
|
||||
| OPERATION_UPDATE | 3 | |
|
||||
| OPERATION_DELETE | 4 | |
|
||||
| OPERATION_WRITE | 5 | WRITE is a combination of CREATE and UPDATE |
|
||||
| OPERATION_READWRITE | 6 | READWRITE is a combination of READ and WRITE |
|
||||
### Resource.Type
|
||||
|
||||
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| TYPE_UNKNOWN | 0 | |
|
||||
| TYPE_SYSTEM | 1 | |
|
||||
| TYPE_FILE | 2 | |
|
||||
| TYPE_SHARE | 3 | |
|
||||
| TYPE_SETTING | 4 | |
|
||||
| TYPE_BUNDLE | 5 | |
|
||||
| TYPE_USER | 6 | |
|
||||
| TYPE_GROUP | 7 | |
|
||||
### UserRoleAssignmentFilter.Type
|
||||
|
||||
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| TYPE_UNKNOWN | 0 | |
|
||||
| TYPE_ACCOUNT | 1 | |
|
||||
| TYPE_ROLE | 2 | |
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
|
||||
120
docs/apis/grpc_apis/opencloud/messages/store/v0/grpc.md
Normal file
120
docs/apis/grpc_apis/opencloud/messages/store/v0/grpc.md
Normal file
@@ -0,0 +1,120 @@
|
||||
---
|
||||
title: "opencloud.messages.store.v0"
|
||||
url: /apis/grpc_apis/opencloud_messages_store_v0
|
||||
date: 2025-03-27T14:44:40+01:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/opencloud-eu/opencloud
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
|
||||
|
||||
## opencloud/messages/store/v0/store.proto
|
||||
|
||||
### DeleteOptions
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| database | [string](#string) | | |
|
||||
| table | [string](#string) | | |
|
||||
|
||||
### Field
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| type | [string](#string) | | type of value e.g string, int, int64, bool, float64 |
|
||||
| value | [string](#string) | | the actual value |
|
||||
|
||||
### ListOptions
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| database | [string](#string) | | |
|
||||
| table | [string](#string) | | |
|
||||
| prefix | [string](#string) | | |
|
||||
| suffix | [string](#string) | | |
|
||||
| limit | [uint64](#uint64) | | |
|
||||
| offset | [uint64](#uint64) | | |
|
||||
|
||||
### ReadOptions
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| database | [string](#string) | | |
|
||||
| table | [string](#string) | | |
|
||||
| prefix | [bool](#bool) | | |
|
||||
| suffix | [bool](#bool) | | |
|
||||
| limit | [uint64](#uint64) | | |
|
||||
| offset | [uint64](#uint64) | | |
|
||||
| where | [ReadOptions.WhereEntry](#readoptionswhereentry) | repeated | |
|
||||
|
||||
### ReadOptions.WhereEntry
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| key | [string](#string) | | |
|
||||
| value | [Field](#field) | | |
|
||||
|
||||
### Record
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| key | [string](#string) | | key of the recorda |
|
||||
| value | [bytes](#bytes) | | value in the record |
|
||||
| expiry | [int64](#int64) | | time.Duration (signed int64 nanoseconds) |
|
||||
| metadata | [Record.MetadataEntry](#recordmetadataentry) | repeated | the associated metadata |
|
||||
|
||||
### Record.MetadataEntry
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| key | [string](#string) | | |
|
||||
| value | [Field](#field) | | |
|
||||
|
||||
### WriteOptions
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| database | [string](#string) | | |
|
||||
| table | [string](#string) | | |
|
||||
| expiry | [int64](#int64) | | time.Time |
|
||||
| ttl | [int64](#int64) | | time.Duration |
|
||||
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
|
||||
65
docs/apis/grpc_apis/opencloud/messages/thumbnails/v0/grpc.md
Normal file
65
docs/apis/grpc_apis/opencloud/messages/thumbnails/v0/grpc.md
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
title: "opencloud.messages.thumbnails.v0"
|
||||
url: /apis/grpc_apis/opencloud_messages_thumbnails_v0
|
||||
date: 2025-03-27T14:44:40+01:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/opencloud-eu/opencloud
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
|
||||
|
||||
## opencloud/messages/thumbnails/v0/thumbnails.proto
|
||||
|
||||
### CS3Source
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| path | [string](#string) | | |
|
||||
| authorization | [string](#string) | | |
|
||||
|
||||
### WebdavSource
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| url | [string](#string) | | REQUIRED. |
|
||||
| is_public_link | [bool](#bool) | | REQUIRED. |
|
||||
| webdav_authorization | [string](#string) | | OPTIONAL. |
|
||||
| reva_authorization | [string](#string) | | OPTIONAL. |
|
||||
| public_link_token | [string](#string) | | OPTIONAL. |
|
||||
|
||||
### ThumbnailType
|
||||
|
||||
The file types to which the thumbnail can be encoded to.
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| PNG | 0 | Represents PNG type |
|
||||
| JPG | 1 | Represents JPG type |
|
||||
| GIF | 2 | Represents GIF type |
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
title: "opencloud.services.eventhistory.v0"
|
||||
url: /apis/grpc_apis/opencloud_services_eventhistory_v0
|
||||
date: 2025-03-27T14:44:40+01:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/opencloud-eu/opencloud
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
|
||||
|
||||
## opencloud/services/eventhistory/v0/eventhistory.proto
|
||||
|
||||
### GetEventsForUserRequest
|
||||
|
||||
A request to retrieve events belonging to a userID
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| userID | [string](#string) | | the userID of the events we want to get |
|
||||
|
||||
### GetEventsRequest
|
||||
|
||||
A request to retrieve events
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| ids | [string](#string) | repeated | the ids of the events we want to get |
|
||||
|
||||
### GetEventsResponse
|
||||
|
||||
The service response
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| events | [opencloud.messages.eventhistory.v0.Event](/apis/grpc_apis/opencloud_messages_eventhistory_v0/#event) | repeated | |
|
||||
|
||||
|
||||
### EventHistoryService
|
||||
|
||||
A Service for storing events
|
||||
|
||||
| Method Name | Request Type | Response Type | Description |
|
||||
| ----------- | ------------ | ------------- | ------------|
|
||||
| GetEvents | [GetEventsRequest](#geteventsrequest) | [GetEventsResponse](#geteventsresponse) | returns the specified events |
|
||||
| GetEventsForUser | [GetEventsForUserRequest](#geteventsforuserrequest) | [GetEventsResponse](#geteventsresponse) | returns all events for the specified userID |
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
|
||||
60
docs/apis/grpc_apis/opencloud/services/policies/v0/grpc.md
Normal file
60
docs/apis/grpc_apis/opencloud/services/policies/v0/grpc.md
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: "opencloud.services.policies.v0"
|
||||
url: /apis/grpc_apis/opencloud_services_policies_v0
|
||||
date: 2025-03-27T14:44:40+01:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/opencloud-eu/opencloud
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
|
||||
|
||||
## opencloud/services/policies/v0/policies.proto
|
||||
|
||||
### EvaluateRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| query | [string](#string) | | |
|
||||
| environment | [opencloud.messages.policies.v0.Environment](/apis/grpc_apis/opencloud_messages_policies_v0/#environment) | | |
|
||||
|
||||
### EvaluateResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| result | [bool](#bool) | | |
|
||||
|
||||
|
||||
### policiesProvider
|
||||
|
||||
|
||||
|
||||
| Method Name | Request Type | Response Type | Description |
|
||||
| ----------- | ------------ | ------------- | ------------|
|
||||
| Evaluate | [EvaluateRequest](#evaluaterequest) | [EvaluateResponse](#evaluateresponse) | |
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
|
||||
108
docs/apis/grpc_apis/opencloud/services/search/v0/grpc.md
Normal file
108
docs/apis/grpc_apis/opencloud/services/search/v0/grpc.md
Normal file
@@ -0,0 +1,108 @@
|
||||
---
|
||||
title: "opencloud.services.search.v0"
|
||||
url: /apis/grpc_apis/opencloud_services_search_v0
|
||||
date: 2025-03-27T14:44:40+01:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/opencloud-eu/opencloud
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
|
||||
|
||||
## opencloud/services/search/v0/search.proto
|
||||
|
||||
### IndexSpaceRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| space_id | [string](#string) | | |
|
||||
| user_id | [string](#string) | | |
|
||||
|
||||
### IndexSpaceResponse
|
||||
|
||||
|
||||
|
||||
|
||||
### SearchIndexRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| page_size | [int32](#int32) | | Optional. The maximum number of entries to return in the response |
|
||||
| page_token | [string](#string) | | Optional. A pagination token returned from a previous call to `Get`<br>that indicates from where search should continue |
|
||||
| query | [string](#string) | | |
|
||||
| ref | [opencloud.messages.search.v0.Reference](/apis/grpc_apis/opencloud_messages_search_v0/#reference) | | |
|
||||
|
||||
### SearchIndexResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| matches | [opencloud.messages.search.v0.Match](/apis/grpc_apis/opencloud_messages_search_v0/#match) | repeated | |
|
||||
| next_page_token | [string](#string) | | Token to retrieve the next page of results, or empty if there are no<br>more results in the list |
|
||||
| total_matches | [int32](#int32) | | |
|
||||
|
||||
### SearchRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| page_size | [int32](#int32) | | Optional. The maximum number of entries to return in the response |
|
||||
| page_token | [string](#string) | | Optional. A pagination token returned from a previous call to `Get`<br>that indicates from where search should continue |
|
||||
| query | [string](#string) | | |
|
||||
| ref | [opencloud.messages.search.v0.Reference](/apis/grpc_apis/opencloud_messages_search_v0/#reference) | | |
|
||||
|
||||
### SearchResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| matches | [opencloud.messages.search.v0.Match](/apis/grpc_apis/opencloud_messages_search_v0/#match) | repeated | |
|
||||
| next_page_token | [string](#string) | | Token to retrieve the next page of results, or empty if there are no<br>more results in the list |
|
||||
| total_matches | [int32](#int32) | | |
|
||||
|
||||
|
||||
### IndexProvider
|
||||
|
||||
|
||||
|
||||
| Method Name | Request Type | Response Type | Description |
|
||||
| ----------- | ------------ | ------------- | ------------|
|
||||
| Search | [SearchIndexRequest](#searchindexrequest) | [SearchIndexResponse](#searchindexresponse) | |
|
||||
|
||||
### SearchProvider
|
||||
|
||||
|
||||
|
||||
| Method Name | Request Type | Response Type | Description |
|
||||
| ----------- | ------------ | ------------- | ------------|
|
||||
| Search | [SearchRequest](#searchrequest) | [SearchResponse](#searchresponse) | |
|
||||
| IndexSpace | [IndexSpaceRequest](#indexspacerequest) | [IndexSpaceResponse](#indexspaceresponse) | |
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
|
||||
312
docs/apis/grpc_apis/opencloud/services/settings/v0/grpc.md
Normal file
312
docs/apis/grpc_apis/opencloud/services/settings/v0/grpc.md
Normal file
@@ -0,0 +1,312 @@
|
||||
---
|
||||
title: "opencloud.services.settings.v0"
|
||||
url: /apis/grpc_apis/opencloud_services_settings_v0
|
||||
date: 2025-03-27T14:44:40+01:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/opencloud-eu/opencloud
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
|
||||
|
||||
## opencloud/services/settings/v0/settings.proto
|
||||
|
||||
### AddSettingToBundleRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| bundle_id | [string](#string) | | |
|
||||
| setting | [opencloud.messages.settings.v0.Setting](/apis/grpc_apis/opencloud_messages_settings_v0/#setting) | | |
|
||||
|
||||
### AddSettingToBundleResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| setting | [opencloud.messages.settings.v0.Setting](/apis/grpc_apis/opencloud_messages_settings_v0/#setting) | | |
|
||||
|
||||
### AssignRoleToUserRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| account_uuid | [string](#string) | | |
|
||||
| role_id | [string](#string) | | the role_id is a bundle_id internally |
|
||||
|
||||
### AssignRoleToUserResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| assignment | [opencloud.messages.settings.v0.UserRoleAssignment](/apis/grpc_apis/opencloud_messages_settings_v0/#userroleassignment) | | |
|
||||
|
||||
### GetBundleRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| bundle_id | [string](#string) | | |
|
||||
|
||||
### GetBundleResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| bundle | [opencloud.messages.settings.v0.Bundle](/apis/grpc_apis/opencloud_messages_settings_v0/#bundle) | | |
|
||||
|
||||
### GetPermissionByIDRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| permission_id | [string](#string) | | |
|
||||
|
||||
### GetPermissionByIDResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| permission | [opencloud.messages.settings.v0.Permission](/apis/grpc_apis/opencloud_messages_settings_v0/#permission) | | |
|
||||
|
||||
### GetValueByUniqueIdentifiersRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| account_uuid | [string](#string) | | |
|
||||
| setting_id | [string](#string) | | |
|
||||
|
||||
### GetValueRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| id | [string](#string) | | |
|
||||
|
||||
### GetValueResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| value | [opencloud.messages.settings.v0.ValueWithIdentifier](/apis/grpc_apis/opencloud_messages_settings_v0/#valuewithidentifier) | | |
|
||||
|
||||
### ListBundlesRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| bundle_ids | [string](#string) | repeated | |
|
||||
| locale | [string](#string) | | |
|
||||
|
||||
### ListBundlesResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| bundles | [opencloud.messages.settings.v0.Bundle](/apis/grpc_apis/opencloud_messages_settings_v0/#bundle) | repeated | |
|
||||
|
||||
### ListPermissionsByResourceRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| resource | [opencloud.messages.settings.v0.Resource](/apis/grpc_apis/opencloud_messages_settings_v0/#resource) | | |
|
||||
|
||||
### ListPermissionsByResourceResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| permissions | [opencloud.messages.settings.v0.Permission](/apis/grpc_apis/opencloud_messages_settings_v0/#permission) | repeated | |
|
||||
|
||||
### ListPermissionsRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| account_uuid | [string](#string) | | |
|
||||
|
||||
### ListPermissionsResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| permissions | [string](#string) | repeated | |
|
||||
|
||||
### ListRoleAssignmentsFilteredRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| filters | [opencloud.messages.settings.v0.UserRoleAssignmentFilter](/apis/grpc_apis/opencloud_messages_settings_v0/#userroleassignmentfilter) | repeated | |
|
||||
|
||||
### ListRoleAssignmentsRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| account_uuid | [string](#string) | | |
|
||||
|
||||
### ListRoleAssignmentsResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| assignments | [opencloud.messages.settings.v0.UserRoleAssignment](/apis/grpc_apis/opencloud_messages_settings_v0/#userroleassignment) | repeated | |
|
||||
|
||||
### ListValuesRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| bundle_id | [string](#string) | | |
|
||||
| account_uuid | [string](#string) | | |
|
||||
|
||||
### ListValuesResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| values | [opencloud.messages.settings.v0.ValueWithIdentifier](/apis/grpc_apis/opencloud_messages_settings_v0/#valuewithidentifier) | repeated | |
|
||||
|
||||
### RemoveRoleFromUserRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| id | [string](#string) | | |
|
||||
|
||||
### RemoveSettingFromBundleRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| bundle_id | [string](#string) | | |
|
||||
| setting_id | [string](#string) | | |
|
||||
|
||||
### SaveBundleRequest
|
||||
|
||||
---
|
||||
requests and responses for settings bundles
|
||||
---
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| bundle | [opencloud.messages.settings.v0.Bundle](/apis/grpc_apis/opencloud_messages_settings_v0/#bundle) | | |
|
||||
|
||||
### SaveBundleResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| bundle | [opencloud.messages.settings.v0.Bundle](/apis/grpc_apis/opencloud_messages_settings_v0/#bundle) | | |
|
||||
|
||||
### SaveValueRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| value | [opencloud.messages.settings.v0.Value](/apis/grpc_apis/opencloud_messages_settings_v0/#value) | | |
|
||||
|
||||
### SaveValueResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| value | [opencloud.messages.settings.v0.ValueWithIdentifier](/apis/grpc_apis/opencloud_messages_settings_v0/#valuewithidentifier) | | |
|
||||
|
||||
|
||||
### BundleService
|
||||
|
||||
|
||||
|
||||
| Method Name | Request Type | Response Type | Description |
|
||||
| ----------- | ------------ | ------------- | ------------|
|
||||
| SaveBundle | [SaveBundleRequest](#savebundlerequest) | [SaveBundleResponse](#savebundleresponse) | |
|
||||
| GetBundle | [GetBundleRequest](#getbundlerequest) | [GetBundleResponse](#getbundleresponse) | |
|
||||
| ListBundles | [ListBundlesRequest](#listbundlesrequest) | [ListBundlesResponse](#listbundlesresponse) | |
|
||||
| AddSettingToBundle | [AddSettingToBundleRequest](#addsettingtobundlerequest) | [AddSettingToBundleResponse](#addsettingtobundleresponse) | |
|
||||
| RemoveSettingFromBundle | [RemoveSettingFromBundleRequest](#removesettingfrombundlerequest) | [.google.protobuf.Empty](#googleprotobufempty) | |
|
||||
|
||||
### PermissionService
|
||||
|
||||
|
||||
|
||||
| Method Name | Request Type | Response Type | Description |
|
||||
| ----------- | ------------ | ------------- | ------------|
|
||||
| ListPermissions | [ListPermissionsRequest](#listpermissionsrequest) | [ListPermissionsResponse](#listpermissionsresponse) | |
|
||||
| ListPermissionsByResource | [ListPermissionsByResourceRequest](#listpermissionsbyresourcerequest) | [ListPermissionsByResourceResponse](#listpermissionsbyresourceresponse) | |
|
||||
| GetPermissionByID | [GetPermissionByIDRequest](#getpermissionbyidrequest) | [GetPermissionByIDResponse](#getpermissionbyidresponse) | |
|
||||
|
||||
### RoleService
|
||||
|
||||
|
||||
|
||||
| Method Name | Request Type | Response Type | Description |
|
||||
| ----------- | ------------ | ------------- | ------------|
|
||||
| ListRoles | [ListBundlesRequest](#listbundlesrequest) | [ListBundlesResponse](#listbundlesresponse) | |
|
||||
| ListRoleAssignments | [ListRoleAssignmentsRequest](#listroleassignmentsrequest) | [ListRoleAssignmentsResponse](#listroleassignmentsresponse) | |
|
||||
| ListRoleAssignmentsFiltered | [ListRoleAssignmentsFilteredRequest](#listroleassignmentsfilteredrequest) | [ListRoleAssignmentsResponse](#listroleassignmentsresponse) | |
|
||||
| AssignRoleToUser | [AssignRoleToUserRequest](#assignroletouserrequest) | [AssignRoleToUserResponse](#assignroletouserresponse) | |
|
||||
| RemoveRoleFromUser | [RemoveRoleFromUserRequest](#removerolefromuserrequest) | [.google.protobuf.Empty](#googleprotobufempty) | |
|
||||
|
||||
### ValueService
|
||||
|
||||
|
||||
|
||||
| Method Name | Request Type | Response Type | Description |
|
||||
| ----------- | ------------ | ------------- | ------------|
|
||||
| SaveValue | [SaveValueRequest](#savevaluerequest) | [SaveValueResponse](#savevalueresponse) | |
|
||||
| GetValue | [GetValueRequest](#getvaluerequest) | [GetValueResponse](#getvalueresponse) | |
|
||||
| ListValues | [ListValuesRequest](#listvaluesrequest) | [ListValuesResponse](#listvaluesresponse) | |
|
||||
| GetValueByUniqueIdentifiers | [GetValueByUniqueIdentifiersRequest](#getvaluebyuniqueidentifiersrequest) | [GetValueResponse](#getvalueresponse) | |
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
|
||||
138
docs/apis/grpc_apis/opencloud/services/store/v0/grpc.md
Normal file
138
docs/apis/grpc_apis/opencloud/services/store/v0/grpc.md
Normal file
@@ -0,0 +1,138 @@
|
||||
---
|
||||
title: "opencloud.services.store.v0"
|
||||
url: /apis/grpc_apis/opencloud_services_store_v0
|
||||
date: 2025-03-27T14:44:40+01:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/opencloud-eu/opencloud
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
|
||||
|
||||
## opencloud/services/store/v0/store.proto
|
||||
|
||||
### DatabasesRequest
|
||||
|
||||
|
||||
|
||||
|
||||
### DatabasesResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| databases | [string](#string) | repeated | |
|
||||
|
||||
### DeleteRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| key | [string](#string) | | |
|
||||
| options | [opencloud.messages.store.v0.DeleteOptions](/apis/grpc_apis/opencloud_messages_store_v0/#deleteoptions) | | |
|
||||
|
||||
### DeleteResponse
|
||||
|
||||
|
||||
|
||||
|
||||
### ListRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| options | [opencloud.messages.store.v0.ListOptions](/apis/grpc_apis/opencloud_messages_store_v0/#listoptions) | | |
|
||||
|
||||
### ListResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| keys | [string](#string) | repeated | |
|
||||
|
||||
### ReadRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| key | [string](#string) | | |
|
||||
| options | [opencloud.messages.store.v0.ReadOptions](/apis/grpc_apis/opencloud_messages_store_v0/#readoptions) | | |
|
||||
|
||||
### ReadResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| records | [opencloud.messages.store.v0.Record](/apis/grpc_apis/opencloud_messages_store_v0/#record) | repeated | |
|
||||
|
||||
### TablesRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| database | [string](#string) | | |
|
||||
|
||||
### TablesResponse
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| tables | [string](#string) | repeated | |
|
||||
|
||||
### WriteRequest
|
||||
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| record | [opencloud.messages.store.v0.Record](/apis/grpc_apis/opencloud_messages_store_v0/#record) | | |
|
||||
| options | [opencloud.messages.store.v0.WriteOptions](/apis/grpc_apis/opencloud_messages_store_v0/#writeoptions) | | |
|
||||
|
||||
### WriteResponse
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Store
|
||||
|
||||
|
||||
|
||||
| Method Name | Request Type | Response Type | Description |
|
||||
| ----------- | ------------ | ------------- | ------------|
|
||||
| Read | [ReadRequest](#readrequest) | [ReadResponse](#readresponse) | |
|
||||
| Write | [WriteRequest](#writerequest) | [WriteResponse](#writeresponse) | |
|
||||
| Delete | [DeleteRequest](#deleterequest) | [DeleteResponse](#deleteresponse) | |
|
||||
| List | [ListRequest](#listrequest) | [ListResponse](#listresponse) stream | |
|
||||
| Databases | [DatabasesRequest](#databasesrequest) | [DatabasesResponse](#databasesresponse) | |
|
||||
| Tables | [TablesRequest](#tablesrequest) | [TablesResponse](#tablesresponse) | |
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
|
||||
67
docs/apis/grpc_apis/opencloud/services/thumbnails/v0/grpc.md
Normal file
67
docs/apis/grpc_apis/opencloud/services/thumbnails/v0/grpc.md
Normal file
@@ -0,0 +1,67 @@
|
||||
---
|
||||
title: "opencloud.services.thumbnails.v0"
|
||||
url: /apis/grpc_apis/opencloud_services_thumbnails_v0
|
||||
date: 2025-03-27T14:44:40+01:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/opencloud-eu/opencloud
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
|
||||
|
||||
## opencloud/services/thumbnails/v0/thumbnails.proto
|
||||
|
||||
### GetThumbnailRequest
|
||||
|
||||
A request to retrieve a thumbnail
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| filepath | [string](#string) | | The path to the source image |
|
||||
| thumbnail_type | [opencloud.messages.thumbnails.v0.ThumbnailType](/apis/grpc_apis/opencloud_messages_thumbnails_v0/#thumbnailtype) | | The type to which the thumbnail should get encoded to. |
|
||||
| width | [int32](#int32) | | The width of the thumbnail |
|
||||
| height | [int32](#int32) | | The height of the thumbnail |
|
||||
| processor | [string](#string) | | Indicates which image processor to use |
|
||||
| webdav_source | [opencloud.messages.thumbnails.v0.WebdavSource](/apis/grpc_apis/opencloud_messages_thumbnails_v0/#webdavsource) | | |
|
||||
| cs3_source | [opencloud.messages.thumbnails.v0.CS3Source](/apis/grpc_apis/opencloud_messages_thumbnails_v0/#cs3source) | | |
|
||||
|
||||
### GetThumbnailResponse
|
||||
|
||||
The service response
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| data_endpoint | [string](#string) | | The endpoint where the thumbnail can be downloaded. |
|
||||
| transfer_token | [string](#string) | | The transfer token to be able to download the thumbnail. |
|
||||
| mimetype | [string](#string) | | The mimetype of the thumbnail |
|
||||
|
||||
|
||||
### ThumbnailService
|
||||
|
||||
A Service for handling thumbnail generation
|
||||
|
||||
| Method Name | Request Type | Response Type | Description |
|
||||
| ----------- | ------------ | ------------- | ------------|
|
||||
| GetThumbnail | [GetThumbnailRequest](#getthumbnailrequest) | [GetThumbnailResponse](#getthumbnailresponse) | Generates the thumbnail and returns it. |
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
|
||||
@@ -2716,7 +2716,7 @@ var (
|
||||
|
||||
// errMaxExprCnt is used to signal that the maximum number of
|
||||
// expressions have been parsed.
|
||||
errMaxExprCnt = errors.New("max number of expresssions parsed")
|
||||
errMaxExprCnt = errors.New("max number of expressions parsed")
|
||||
)
|
||||
|
||||
// Option is a function that can set an option on the parser. It returns
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Code generated by mockery v2.53.0. DO NOT EDIT.
|
||||
// Code generated by mockery v2.53.2. DO NOT EDIT.
|
||||
|
||||
package mocks
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Code generated by mockery v2.53.0. DO NOT EDIT.
|
||||
// Code generated by mockery v2.53.2. DO NOT EDIT.
|
||||
|
||||
package mocks
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Code generated by mockery v2.53.0. DO NOT EDIT.
|
||||
// Code generated by mockery v2.53.2. DO NOT EDIT.
|
||||
|
||||
package mocks
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Code generated by mockery v2.53.0. DO NOT EDIT.
|
||||
// Code generated by mockery v2.53.2. DO NOT EDIT.
|
||||
|
||||
package mocks
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Code generated by mockery v2.53.0. DO NOT EDIT.
|
||||
// Code generated by mockery v2.53.2. DO NOT EDIT.
|
||||
|
||||
package mocks
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Code generated by mockery v2.53.0. DO NOT EDIT.
|
||||
// Code generated by mockery v2.53.2. DO NOT EDIT.
|
||||
|
||||
package mocks
|
||||
|
||||
|
||||
Reference in New Issue
Block a user