Documentation ¶
Index ¶
- Variables
- type Enum
- func (*Enum) Descriptor() ([]byte, []int)deprecated
- func (x *Enum) GetDescription() string
- func (x *Enum) GetExtensions() map[string]*anypb.Any
- func (x *Enum) GetLifecycle() *Lifecycle
- func (x *Enum) GetType() string
- func (x *Enum) GetValues() map[string]int32
- func (x *Enum) GetXProto() *Enumproto
- func (*Enum) ProtoMessage()
- func (x *Enum) ProtoReflect() protoreflect.Message
- func (x *Enum) Reset()
- func (x *Enum) String() string
- type Enumproto
- func (*Enumproto) Descriptor() ([]byte, []int)deprecated
- func (x *Enumproto) GetAllowAlias() bool
- func (x *Enumproto) GetImports() []string
- func (x *Enumproto) GetOptions() map[string]string
- func (x *Enumproto) GetPackage() string
- func (x *Enumproto) GetTargetfile() string
- func (*Enumproto) ProtoMessage()
- func (x *Enumproto) ProtoReflect() protoreflect.Message
- func (x *Enumproto) Reset()
- func (x *Enumproto) String() string
- type Field
- func (*Field) Descriptor() ([]byte, []int)deprecated
- func (x *Field) GetConstraints() map[string]*FieldConstraint
- func (x *Field) GetDescription() string
- func (x *Field) GetExtensions() map[string]*anypb.Any
- func (x *Field) GetMeta() *FieldMeta
- func (x *Field) GetType() string
- func (x *Field) GetXProto() *Fieldproto
- func (x *Field) GetXUi() *Uiextension
- func (*Field) ProtoMessage()
- func (x *Field) ProtoReflect() protoreflect.Message
- func (x *Field) Reset()
- func (x *Field) String() string
- type FieldConstraint
- func (*FieldConstraint) Descriptor() ([]byte, []int)deprecated
- func (x *FieldConstraint) GetIs() string
- func (x *FieldConstraint) GetMessage() string
- func (*FieldConstraint) ProtoMessage()
- func (x *FieldConstraint) ProtoReflect() protoreflect.Message
- func (x *FieldConstraint) Reset()
- func (x *FieldConstraint) String() string
- type FieldMeta
- func (*FieldMeta) Descriptor() ([]byte, []int)deprecated
- func (x *FieldMeta) GetDefault() string
- func (x *FieldMeta) GetHint() string
- func (x *FieldMeta) GetLabel() string
- func (x *FieldMeta) GetOptions() *Fieldoption
- func (x *FieldMeta) GetPlaceholder() string
- func (x *FieldMeta) GetReadonly() bool
- func (x *FieldMeta) GetRepeated() bool
- func (x *FieldMeta) GetTypespecific() *anypb.Any
- func (*FieldMeta) ProtoMessage()
- func (x *FieldMeta) ProtoReflect() protoreflect.Message
- func (x *FieldMeta) Reset()
- func (x *FieldMeta) String() string
- type Fieldoption
- func (*Fieldoption) Descriptor() ([]byte, []int)deprecated
- func (x *Fieldoption) GetFlags() []string
- func (x *Fieldoption) GetList() []*anypb.Any
- func (*Fieldoption) ProtoMessage()
- func (x *Fieldoption) ProtoReflect() protoreflect.Message
- func (x *Fieldoption) Reset()
- func (x *Fieldoption) String() string
- type Fieldproto
- type Lifecycle
- type Optionitem
- func (*Optionitem) Descriptor() ([]byte, []int)deprecated
- func (x *Optionitem) GetDisplayName() string
- func (x *Optionitem) GetId() string
- func (x *Optionitem) GetSelected() bool
- func (*Optionitem) ProtoMessage()
- func (x *Optionitem) ProtoReflect() protoreflect.Message
- func (x *Optionitem) Reset()
- func (x *Optionitem) String() string
- type Queryparam
- func (*Queryparam) Descriptor() ([]byte, []int)deprecated
- func (x *Queryparam) GetConstraints() map[string]*FieldConstraint
- func (x *Queryparam) GetDescription() string
- func (x *Queryparam) GetMeta() *FieldMeta
- func (x *Queryparam) GetType() string
- func (*Queryparam) ProtoMessage()
- func (x *Queryparam) ProtoReflect() protoreflect.Message
- func (x *Queryparam) Reset()
- func (x *Queryparam) String() string
- type Rpc
- func (*Rpc) Descriptor() ([]byte, []int)deprecated
- func (x *Rpc) GetData() *Servicereqres
- func (x *Rpc) GetDeeplink() *Servicedeeplink
- func (x *Rpc) GetDescription() string
- func (x *Rpc) GetExtensions() map[string]*anypb.Any
- func (x *Rpc) GetQuery() map[string]*Queryparam
- func (x *Rpc) GetRpcName() string
- func (*Rpc) ProtoMessage()
- func (x *Rpc) ProtoReflect() protoreflect.Message
- func (x *Rpc) Reset()
- func (x *Rpc) String() string
- type Service
- func (*Service) Descriptor() ([]byte, []int)deprecated
- func (x *Service) GetDescription() string
- func (x *Service) GetExtensions() map[string]*anypb.Any
- func (x *Service) GetLifecycle() *Lifecycle
- func (x *Service) GetName() string
- func (x *Service) GetServices() map[string]*Rpc
- func (x *Service) GetVersion() string
- func (x *Service) GetXProto() *Typeproto
- func (*Service) ProtoMessage()
- func (x *Service) ProtoReflect() protoreflect.Message
- func (x *Service) Reset()
- func (x *Service) String() string
- type Servicedeeplink
- func (*Servicedeeplink) Descriptor() ([]byte, []int)deprecated
- func (x *Servicedeeplink) GetDescription() string
- func (x *Servicedeeplink) GetHref() string
- func (x *Servicedeeplink) GetMethod() string
- func (x *Servicedeeplink) GetRel() string
- func (*Servicedeeplink) ProtoMessage()
- func (x *Servicedeeplink) ProtoReflect() protoreflect.Message
- func (x *Servicedeeplink) Reset()
- func (x *Servicedeeplink) String() string
- type Servicereqres
- func (*Servicereqres) Descriptor() ([]byte, []int)deprecated
- func (x *Servicereqres) GetBodyfield() string
- func (x *Servicereqres) GetRequest() string
- func (x *Servicereqres) GetResponse() string
- func (*Servicereqres) ProtoMessage()
- func (x *Servicereqres) ProtoReflect() protoreflect.Message
- func (x *Servicereqres) Reset()
- func (x *Servicereqres) String() string
- type Type
- func (*Type) Descriptor() ([]byte, []int)deprecated
- func (x *Type) GetDescription() string
- func (x *Type) GetExtensions() map[string]*anypb.Any
- func (x *Type) GetFields() map[string]*Field
- func (x *Type) GetLifecycle() *Lifecycle
- func (x *Type) GetName() string
- func (x *Type) GetType() string
- func (x *Type) GetXProto() *Typeproto
- func (*Type) ProtoMessage()
- func (x *Type) ProtoReflect() protoreflect.Message
- func (x *Type) Reset()
- func (x *Type) String() string
- type Typeproto
- func (*Typeproto) Descriptor() ([]byte, []int)deprecated
- func (x *Typeproto) GetImports() []string
- func (x *Typeproto) GetOptions() map[string]string
- func (x *Typeproto) GetPackage() string
- func (x *Typeproto) GetTargetfile() string
- func (*Typeproto) ProtoMessage()
- func (x *Typeproto) ProtoReflect() protoreflect.Message
- func (x *Typeproto) Reset()
- func (x *Typeproto) String() string
- type Uiextension
- func (*Uiextension) Descriptor() ([]byte, []int)deprecated
- func (x *Uiextension) GetComponent() string
- func (x *Uiextension) GetFlags() []string
- func (x *Uiextension) GetNoInit() bool
- func (x *Uiextension) GetNoSkip() bool
- func (*Uiextension) ProtoMessage()
- func (x *Uiextension) ProtoReflect() protoreflect.Message
- func (x *Uiextension) Reset()
- func (x *Uiextension) String() string
Constants ¶
This section is empty.
Variables ¶
var File_descriptor_descriptor_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Enum ¶ added in v1.33.0
type Enum struct { // This is the Typename Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"` // the type description Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` // Type lifecycle information, setting deprecated to true will log a warning when running furo Lifecycle *Lifecycle `protobuf:"bytes,7,opt,name=lifecycle,proto3" json:"lifecycle,omitempty"` // information for the proto generator, should be removed for the client spec XProto *Enumproto `protobuf:"bytes,4,opt,name=__proto,json=Proto,proto3" json:"__proto,omitempty"` // Value of a enum Values map[string]int32 `` /* 154-byte string literal not displayed */ // Custom extension Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */ // contains filtered or unexported fields }
Defines a type in the furo spec
func (*Enum) Descriptor
deprecated
added in
v1.33.0
func (*Enum) GetDescription ¶ added in v1.33.0
func (*Enum) GetLifecycle ¶ added in v1.33.0
func (*Enum) ProtoMessage ¶ added in v1.33.0
func (*Enum) ProtoMessage()
func (*Enum) ProtoReflect ¶ added in v1.33.0
func (x *Enum) ProtoReflect() protoreflect.Message
type Enumproto ¶ added in v1.33.0
type Enumproto struct { // the package this type belogs to Package string `protobuf:"bytes,1,opt,name=package,proto3" json:"package,omitempty"` // the target proto file for this type Targetfile string `protobuf:"bytes,3,opt,name=targetfile,proto3" json:"targetfile,omitempty"` // needed imports like [ "spec/descriptor.proto", "google/protobuf/empty.proto" ] Imports []string `protobuf:"bytes,2,rep,name=imports,proto3" json:"imports,omitempty"` // Proto options Todo: find a solution for boolean options Options map[string]string `` /* 155-byte string literal not displayed */ // Allow aliases on enums (different names same value) AllowAlias bool `protobuf:"varint,5,opt,name=allow_alias,json=allowAlias,proto3" json:"allow_alias,omitempty"` // contains filtered or unexported fields }
Main proto for a type
func (*Enumproto) Descriptor
deprecated
added in
v1.33.0
func (*Enumproto) GetAllowAlias ¶ added in v1.33.0
func (*Enumproto) GetImports ¶ added in v1.33.0
func (*Enumproto) GetOptions ¶ added in v1.33.0
func (*Enumproto) GetPackage ¶ added in v1.33.0
func (*Enumproto) GetTargetfile ¶ added in v1.33.0
func (*Enumproto) ProtoMessage ¶ added in v1.33.0
func (*Enumproto) ProtoMessage()
func (*Enumproto) ProtoReflect ¶ added in v1.33.0
func (x *Enumproto) ProtoReflect() protoreflect.Message
type Field ¶
type Field struct { // the field type, https://developers.google.com/protocol-buffers/docs/proto3#scalar Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"` // the field description Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` // information for the proto generator, like number, type XProto *Fieldproto `protobuf:"bytes,6,opt,name=__proto,json=Proto,proto3" json:"__proto,omitempty"` XUi *Uiextension `protobuf:"bytes,7,opt,name=__ui,json=Ui,proto3" json:"__ui,omitempty"` // meta information for the client, like label, default, repeated, options... Meta *FieldMeta `protobuf:"bytes,3,opt,name=meta,proto3" json:"meta,omitempty"` // constraints for a field, like min{}, max{}, step{} Constraints map[string]*FieldConstraint `` /* 163-byte string literal not displayed */ // Custom extension Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */ // contains filtered or unexported fields }
Defines a field in the furo spec
func (*Field) Descriptor
deprecated
func (*Field) GetConstraints ¶
func (x *Field) GetConstraints() map[string]*FieldConstraint
func (*Field) GetDescription ¶
func (*Field) GetXProto ¶
func (x *Field) GetXProto() *Fieldproto
func (*Field) GetXUi ¶
func (x *Field) GetXUi() *Uiextension
func (*Field) ProtoMessage ¶
func (*Field) ProtoMessage()
func (*Field) ProtoReflect ¶
func (x *Field) ProtoReflect() protoreflect.Message
type FieldConstraint ¶
type FieldConstraint struct { // the constraint value as string, even it is a number Is string `protobuf:"bytes,1,opt,name=is,proto3" json:"is,omitempty"` // The message to display on constraint violation Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"` // contains filtered or unexported fields }
a single fieldconstraint
func (*FieldConstraint) Descriptor
deprecated
func (*FieldConstraint) Descriptor() ([]byte, []int)
Deprecated: Use FieldConstraint.ProtoReflect.Descriptor instead.
func (*FieldConstraint) GetIs ¶
func (x *FieldConstraint) GetIs() string
func (*FieldConstraint) GetMessage ¶
func (x *FieldConstraint) GetMessage() string
func (*FieldConstraint) ProtoMessage ¶
func (*FieldConstraint) ProtoMessage()
func (*FieldConstraint) ProtoReflect ¶
func (x *FieldConstraint) ProtoReflect() protoreflect.Message
func (*FieldConstraint) Reset ¶
func (x *FieldConstraint) Reset()
func (*FieldConstraint) String ¶
func (x *FieldConstraint) String() string
type FieldMeta ¶
type FieldMeta struct { // The default value as JSON string, this must match with the data structure of your type Default string `protobuf:"bytes,3,opt,name=default,proto3" json:"default,omitempty"` // Informative text which can be displayed on the ui Placeholder string `protobuf:"bytes,8,opt,name=placeholder,proto3" json:"placeholder,omitempty"` // A hint Hint string `protobuf:"bytes,2,opt,name=hint,proto3" json:"hint,omitempty"` // Informative text which can be displayed on the ui Label string `protobuf:"bytes,1,opt,name=label,proto3" json:"label,omitempty"` // Fieldoptions Options *Fieldoption `protobuf:"bytes,6,opt,name=options,proto3" json:"options,omitempty"` // Marks the field as readonly. Used for validations. Readonly bool `protobuf:"varint,4,opt,name=readonly,proto3" json:"readonly,omitempty"` // repeated Repeated bool `protobuf:"varint,5,opt,name=repeated,proto3" json:"repeated,omitempty"` // Put in type specific metas for your fields here Typespecific *anypb.Any `protobuf:"bytes,7,opt,name=typespecific,proto3" json:"typespecific,omitempty"` // contains filtered or unexported fields }
Metas for a field
func (*FieldMeta) Descriptor
deprecated
func (*FieldMeta) GetDefault ¶
func (*FieldMeta) GetOptions ¶
func (x *FieldMeta) GetOptions() *Fieldoption
func (*FieldMeta) GetPlaceholder ¶
func (*FieldMeta) GetReadonly ¶
func (*FieldMeta) GetRepeated ¶
func (*FieldMeta) GetTypespecific ¶
func (*FieldMeta) ProtoMessage ¶
func (*FieldMeta) ProtoMessage()
func (*FieldMeta) ProtoReflect ¶
func (x *FieldMeta) ProtoReflect() protoreflect.Message
type Fieldoption ¶
type Fieldoption struct { // Add flags for your field. This can be something like "searchable". // //The flags can be used by generators, ui components,... // Flags []string `protobuf:"bytes,2,rep,name=flags,proto3" json:"flags,omitempty"` // a list with options, use descriptor.Optionitem or your own List []*anypb.Any `protobuf:"bytes,1,rep,name=list,proto3" json:"list,omitempty"` // contains filtered or unexported fields }
Options like flags and list
func (*Fieldoption) Descriptor
deprecated
func (*Fieldoption) Descriptor() ([]byte, []int)
Deprecated: Use Fieldoption.ProtoReflect.Descriptor instead.
func (*Fieldoption) GetFlags ¶
func (x *Fieldoption) GetFlags() []string
func (*Fieldoption) GetList ¶
func (x *Fieldoption) GetList() []*anypb.Any
func (*Fieldoption) ProtoMessage ¶
func (*Fieldoption) ProtoMessage()
func (*Fieldoption) ProtoReflect ¶
func (x *Fieldoption) ProtoReflect() protoreflect.Message
func (*Fieldoption) Reset ¶
func (x *Fieldoption) Reset()
func (*Fieldoption) String ¶
func (x *Fieldoption) String() string
type Fieldproto ¶
type Fieldproto struct { // The field numbers are used to identify your fields in the message binary format, and should not be changed once your message type is in use. Number int32 `protobuf:"varint,2,opt,name=number,proto3" json:"number,omitempty"` // Assign field to a protobuf oneof group. Oneof string `protobuf:"bytes,3,opt,name=oneof,proto3" json:"oneof,omitempty"` // contains filtered or unexported fields }
Proto options for a field
func (*Fieldproto) Descriptor
deprecated
func (*Fieldproto) Descriptor() ([]byte, []int)
Deprecated: Use Fieldproto.ProtoReflect.Descriptor instead.
func (*Fieldproto) GetNumber ¶
func (x *Fieldproto) GetNumber() int32
func (*Fieldproto) GetOneof ¶
func (x *Fieldproto) GetOneof() string
func (*Fieldproto) ProtoMessage ¶
func (*Fieldproto) ProtoMessage()
func (*Fieldproto) ProtoReflect ¶
func (x *Fieldproto) ProtoReflect() protoreflect.Message
func (*Fieldproto) Reset ¶
func (x *Fieldproto) Reset()
func (*Fieldproto) String ¶
func (x *Fieldproto) String() string
type Lifecycle ¶
type Lifecycle struct { // Is this version deprecated Deprecated bool `protobuf:"varint,1,opt,name=deprecated,proto3" json:"deprecated,omitempty"` // Inform about the replacement here, if you have one Info string `protobuf:"bytes,2,opt,name=info,proto3" json:"info,omitempty"` // contains filtered or unexported fields }
Lifecycle information for a type or a service
func (*Lifecycle) Descriptor
deprecated
func (*Lifecycle) GetDeprecated ¶
func (*Lifecycle) ProtoMessage ¶
func (*Lifecycle) ProtoMessage()
func (*Lifecycle) ProtoReflect ¶
func (x *Lifecycle) ProtoReflect() protoreflect.Message
type Optionitem ¶
type Optionitem struct { // Id Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // String representation DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"` // is the item selected Selected bool `protobuf:"varint,3,opt,name=selected,proto3" json:"selected,omitempty"` // contains filtered or unexported fields }
Items for fieldoption.list
func (*Optionitem) Descriptor
deprecated
func (*Optionitem) Descriptor() ([]byte, []int)
Deprecated: Use Optionitem.ProtoReflect.Descriptor instead.
func (*Optionitem) GetDisplayName ¶
func (x *Optionitem) GetDisplayName() string
func (*Optionitem) GetId ¶
func (x *Optionitem) GetId() string
func (*Optionitem) GetSelected ¶
func (x *Optionitem) GetSelected() bool
func (*Optionitem) ProtoMessage ¶
func (*Optionitem) ProtoMessage()
func (*Optionitem) ProtoReflect ¶
func (x *Optionitem) ProtoReflect() protoreflect.Message
func (*Optionitem) Reset ¶
func (x *Optionitem) Reset()
func (*Optionitem) String ¶
func (x *Optionitem) String() string
type Queryparam ¶
type Queryparam struct { // constraints for a field, like min{}, max{}, step{}. Not used at the moment Constraints map[string]*FieldConstraint `` /* 163-byte string literal not displayed */ // the field description Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` // meta information for the client, like label, default, repeated, options... Meta *FieldMeta `protobuf:"bytes,3,opt,name=meta,proto3" json:"meta,omitempty"` // the field type, https://developers.google.com/protocol-buffers/docs/proto3#scalar Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"` // contains filtered or unexported fields }
Defines a queryparam field (for rpc type)
func (*Queryparam) Descriptor
deprecated
func (*Queryparam) Descriptor() ([]byte, []int)
Deprecated: Use Queryparam.ProtoReflect.Descriptor instead.
func (*Queryparam) GetConstraints ¶
func (x *Queryparam) GetConstraints() map[string]*FieldConstraint
func (*Queryparam) GetDescription ¶
func (x *Queryparam) GetDescription() string
func (*Queryparam) GetMeta ¶
func (x *Queryparam) GetMeta() *FieldMeta
func (*Queryparam) GetType ¶
func (x *Queryparam) GetType() string
func (*Queryparam) ProtoMessage ¶
func (*Queryparam) ProtoMessage()
func (*Queryparam) ProtoReflect ¶
func (x *Queryparam) ProtoReflect() protoreflect.Message
func (*Queryparam) Reset ¶
func (x *Queryparam) Reset()
func (*Queryparam) String ¶
func (x *Queryparam) String() string
type Rpc ¶
type Rpc struct { // the service description Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` // Request and response types for the service Data *Servicereqres `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"` // This data is needed for... Deeplink *Servicedeeplink `protobuf:"bytes,5,opt,name=deeplink,proto3" json:"deeplink,omitempty"` // Query params, it is recomended to use string types Query map[string]*Queryparam `` /* 151-byte string literal not displayed */ // RPC name https://developers.google.com/protocol-buffers/docs/proto3#services RpcName string `protobuf:"bytes,2,opt,name=rpc_name,json=rpcName,proto3" json:"rpc_name,omitempty"` // Custom extension Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */ // contains filtered or unexported fields }
Defines a rpc for a service
func (*Rpc) Descriptor
deprecated
func (*Rpc) GetData ¶
func (x *Rpc) GetData() *Servicereqres
func (*Rpc) GetDeeplink ¶
func (x *Rpc) GetDeeplink() *Servicedeeplink
func (*Rpc) GetDescription ¶
func (*Rpc) GetQuery ¶
func (x *Rpc) GetQuery() map[string]*Queryparam
func (*Rpc) GetRpcName ¶
func (*Rpc) ProtoMessage ¶
func (*Rpc) ProtoMessage()
func (*Rpc) ProtoReflect ¶
func (x *Rpc) ProtoReflect() protoreflect.Message
type Service ¶
type Service struct { // Describe the rpcs or so Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // The version number, use semver Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"` // Describe the rpcs or so Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` // Service lifecycle information Lifecycle *Lifecycle `protobuf:"bytes,4,opt,name=lifecycle,proto3" json:"lifecycle,omitempty"` // information for the proto generator, should be removed for the client spec XProto *Typeproto `protobuf:"bytes,5,opt,name=__proto,json=Proto,proto3" json:"__proto,omitempty"` // RPCs for the service Services map[string]*Rpc `` /* 157-byte string literal not displayed */ // Custom extension Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */ // contains filtered or unexported fields }
Defines a service
func (*Service) Descriptor
deprecated
func (*Service) GetDescription ¶
func (*Service) GetLifecycle ¶
func (*Service) GetServices ¶
func (*Service) GetVersion ¶
func (*Service) ProtoMessage ¶
func (*Service) ProtoMessage()
func (*Service) ProtoReflect ¶
func (x *Service) ProtoReflect() protoreflect.Message
type Servicedeeplink ¶
type Servicedeeplink struct { // Describe the query params Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"` // The link pattern, like /api/xxx/{qp}/yyy Href string `protobuf:"bytes,4,opt,name=href,proto3" json:"href,omitempty"` // method of curl Method string `protobuf:"bytes,3,opt,name=method,proto3" json:"method,omitempty"` // the relationship Rel string `protobuf:"bytes,2,opt,name=rel,proto3" json:"rel,omitempty"` // contains filtered or unexported fields }
URL information for the service
func (*Servicedeeplink) Descriptor
deprecated
func (*Servicedeeplink) Descriptor() ([]byte, []int)
Deprecated: Use Servicedeeplink.ProtoReflect.Descriptor instead.
func (*Servicedeeplink) GetDescription ¶
func (x *Servicedeeplink) GetDescription() string
func (*Servicedeeplink) GetHref ¶
func (x *Servicedeeplink) GetHref() string
func (*Servicedeeplink) GetMethod ¶
func (x *Servicedeeplink) GetMethod() string
func (*Servicedeeplink) GetRel ¶
func (x *Servicedeeplink) GetRel() string
func (*Servicedeeplink) ProtoMessage ¶
func (*Servicedeeplink) ProtoMessage()
func (*Servicedeeplink) ProtoReflect ¶
func (x *Servicedeeplink) ProtoReflect() protoreflect.Message
func (*Servicedeeplink) Reset ¶
func (x *Servicedeeplink) Reset()
func (*Servicedeeplink) String ¶
func (x *Servicedeeplink) String() string
type Servicereqres ¶
type Servicereqres struct { // Define the request type, leave this field empty if not needed Request string `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"` // Define the response type, leave this field empty if not needed Response string `protobuf:"bytes,2,opt,name=response,proto3" json:"response,omitempty"` // Define the body field in request the type // The name of the request field whose value is mapped to the HTTP request // body, or `*` for mapping all request fields not captured by the path // pattern to the HTTP body, or omitted for not having any HTTP request body. // NOTE: the referred field must be present at the top-level of the request // message type. // Bodyfield string `protobuf:"bytes,3,opt,name=bodyfield,proto3" json:"bodyfield,omitempty"` // contains filtered or unexported fields }
Repuest and response types for services, used in service.type
func (*Servicereqres) Descriptor
deprecated
func (*Servicereqres) Descriptor() ([]byte, []int)
Deprecated: Use Servicereqres.ProtoReflect.Descriptor instead.
func (*Servicereqres) GetBodyfield ¶
func (x *Servicereqres) GetBodyfield() string
func (*Servicereqres) GetRequest ¶
func (x *Servicereqres) GetRequest() string
func (*Servicereqres) GetResponse ¶
func (x *Servicereqres) GetResponse() string
func (*Servicereqres) ProtoMessage ¶
func (*Servicereqres) ProtoMessage()
func (*Servicereqres) ProtoReflect ¶
func (x *Servicereqres) ProtoReflect() protoreflect.Message
func (*Servicereqres) Reset ¶
func (x *Servicereqres) Reset()
func (*Servicereqres) String ¶
func (x *Servicereqres) String() string
type Type ¶
type Type struct { // Name of the type Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // the type Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"` // the type description Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` // Type lifecycle information, setting deprecated to true will log a warning when running furo Lifecycle *Lifecycle `protobuf:"bytes,7,opt,name=lifecycle,proto3" json:"lifecycle,omitempty"` // information for the proto generator, should be removed for the client spec XProto *Typeproto `protobuf:"bytes,4,opt,name=__proto,json=Proto,proto3" json:"__proto,omitempty"` // fields of a type Fields map[string]*Field `` /* 153-byte string literal not displayed */ // Custom extension Extensions map[string]*anypb.Any `` /* 161-byte string literal not displayed */ // contains filtered or unexported fields }
Defines a type in the furo spec
func (*Type) Descriptor
deprecated
func (*Type) GetDescription ¶
func (*Type) GetLifecycle ¶
func (*Type) ProtoMessage ¶
func (*Type) ProtoMessage()
func (*Type) ProtoReflect ¶
func (x *Type) ProtoReflect() protoreflect.Message
type Typeproto ¶
type Typeproto struct { // the package this type belogs to Package string `protobuf:"bytes,1,opt,name=package,proto3" json:"package,omitempty"` // the target proto file for this type Targetfile string `protobuf:"bytes,3,opt,name=targetfile,proto3" json:"targetfile,omitempty"` // needed imports like [ "spec/descriptor.proto", "google/protobuf/empty.proto" ] Imports []string `protobuf:"bytes,2,rep,name=imports,proto3" json:"imports,omitempty"` // Proto options Todo: find a solution for boolean options Options map[string]string `` /* 155-byte string literal not displayed */ // contains filtered or unexported fields }
Main proto for a type
func (*Typeproto) Descriptor
deprecated
func (*Typeproto) GetImports ¶
func (*Typeproto) GetOptions ¶
func (*Typeproto) GetPackage ¶
func (*Typeproto) GetTargetfile ¶
func (*Typeproto) ProtoMessage ¶
func (*Typeproto) ProtoMessage()
func (*Typeproto) ProtoReflect ¶
func (x *Typeproto) ProtoReflect() protoreflect.Message
type Uiextension ¶
type Uiextension struct { // component hint for ui-builder Component string `protobuf:"bytes,1,opt,name=component,proto3" json:"component,omitempty"` // UI element flags like full, double, hidden,... Flags []string `protobuf:"bytes,2,rep,name=flags,proto3" json:"flags,omitempty"` // Skip adding this field on ui init NoInit bool `protobuf:"varint,3,opt,name=no_init,json=noInit,proto3" json:"no_init,omitempty"` // do not skip this field, even it is in the default skip list NoSkip bool `protobuf:"varint,4,opt,name=no_skip,json=noSkip,proto3" json:"no_skip,omitempty"` // contains filtered or unexported fields }
ui hints for a field
func (*Uiextension) Descriptor
deprecated
func (*Uiextension) Descriptor() ([]byte, []int)
Deprecated: Use Uiextension.ProtoReflect.Descriptor instead.
func (*Uiextension) GetComponent ¶
func (x *Uiextension) GetComponent() string
func (*Uiextension) GetFlags ¶
func (x *Uiextension) GetFlags() []string
func (*Uiextension) GetNoInit ¶
func (x *Uiextension) GetNoInit() bool
func (*Uiextension) GetNoSkip ¶
func (x *Uiextension) GetNoSkip() bool
func (*Uiextension) ProtoMessage ¶
func (*Uiextension) ProtoMessage()
func (*Uiextension) ProtoReflect ¶
func (x *Uiextension) ProtoReflect() protoreflect.Message
func (*Uiextension) Reset ¶
func (x *Uiextension) Reset()
func (*Uiextension) String ¶
func (x *Uiextension) String() string