Documentation
¶
Index ¶
- type CreateDocumentationOp
- func (m *CreateDocumentationOp) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *CreateDocumentationOp) CloneVT() *CreateDocumentationOp
- func (this *CreateDocumentationOp) EqualMessageVT(thatMsg any) bool
- func (this *CreateDocumentationOp) EqualVT(that *CreateDocumentationOp) bool
- func (x *CreateDocumentationOp) GetDescription() string
- func (x *CreateDocumentationOp) GetName() string
- func (x *CreateDocumentationOp) GetObjectKey() string
- func (x *CreateDocumentationOp) GetTimestamp() *timestamppb.Timestamp
- func (x *CreateDocumentationOp) MarshalJSON() ([]byte, error)
- func (x *CreateDocumentationOp) MarshalProtoJSON(s *json.MarshalState)
- func (x *CreateDocumentationOp) MarshalProtoText() string
- func (m *CreateDocumentationOp) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *CreateDocumentationOp) MarshalToVT(dAtA []byte) (int, error)
- func (m *CreateDocumentationOp) MarshalVT() (dAtA []byte, err error)
- func (*CreateDocumentationOp) ProtoMessage()
- func (x *CreateDocumentationOp) Reset()
- func (m *CreateDocumentationOp) SizeVT() (n int)
- func (x *CreateDocumentationOp) String() string
- func (x *CreateDocumentationOp) UnmarshalJSON(b []byte) error
- func (x *CreateDocumentationOp) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *CreateDocumentationOp) UnmarshalVT(dAtA []byte) error
- type Documentation
- func (m *Documentation) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *Documentation) CloneVT() *Documentation
- func (this *Documentation) EqualMessageVT(thatMsg any) bool
- func (this *Documentation) EqualVT(that *Documentation) bool
- func (x *Documentation) GetCreatedAt() *timestamppb.Timestamp
- func (x *Documentation) GetDescription() string
- func (x *Documentation) GetName() string
- func (x *Documentation) MarshalJSON() ([]byte, error)
- func (x *Documentation) MarshalProtoJSON(s *json.MarshalState)
- func (x *Documentation) MarshalProtoText() string
- func (m *Documentation) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Documentation) MarshalToVT(dAtA []byte) (int, error)
- func (m *Documentation) MarshalVT() (dAtA []byte, err error)
- func (*Documentation) ProtoMessage()
- func (x *Documentation) Reset()
- func (m *Documentation) SizeVT() (n int)
- func (x *Documentation) String() string
- func (x *Documentation) UnmarshalJSON(b []byte) error
- func (x *Documentation) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *Documentation) UnmarshalVT(dAtA []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateDocumentationOp ¶
type CreateDocumentationOp struct {
// ObjectKey is the key to create the documentation at.
ObjectKey string `protobuf:"bytes,1,opt,name=object_key,json=objectKey,proto3" json:"objectKey,omitempty"`
// Name is the display name.
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
// Description is a short description.
Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
// Timestamp is the creation timestamp.
Timestamp *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
// contains filtered or unexported fields
}
CreateDocumentationOp creates a new Documentation world object.
func (*CreateDocumentationOp) CloneMessageVT ¶
func (m *CreateDocumentationOp) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*CreateDocumentationOp) CloneVT ¶
func (m *CreateDocumentationOp) CloneVT() *CreateDocumentationOp
func (*CreateDocumentationOp) EqualMessageVT ¶
func (this *CreateDocumentationOp) EqualMessageVT(thatMsg any) bool
func (*CreateDocumentationOp) EqualVT ¶
func (this *CreateDocumentationOp) EqualVT(that *CreateDocumentationOp) bool
func (*CreateDocumentationOp) GetDescription ¶
func (x *CreateDocumentationOp) GetDescription() string
func (*CreateDocumentationOp) GetName ¶
func (x *CreateDocumentationOp) GetName() string
func (*CreateDocumentationOp) GetObjectKey ¶
func (x *CreateDocumentationOp) GetObjectKey() string
func (*CreateDocumentationOp) GetTimestamp ¶
func (x *CreateDocumentationOp) GetTimestamp() *timestamppb.Timestamp
func (*CreateDocumentationOp) MarshalJSON ¶
func (x *CreateDocumentationOp) MarshalJSON() ([]byte, error)
MarshalJSON marshals the CreateDocumentationOp to JSON.
func (*CreateDocumentationOp) MarshalProtoJSON ¶
func (x *CreateDocumentationOp) MarshalProtoJSON(s *json.MarshalState)
MarshalProtoJSON marshals the CreateDocumentationOp message to JSON.
func (*CreateDocumentationOp) MarshalProtoText ¶
func (x *CreateDocumentationOp) MarshalProtoText() string
func (*CreateDocumentationOp) MarshalToSizedBufferVT ¶
func (m *CreateDocumentationOp) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*CreateDocumentationOp) MarshalToVT ¶
func (m *CreateDocumentationOp) MarshalToVT(dAtA []byte) (int, error)
func (*CreateDocumentationOp) MarshalVT ¶
func (m *CreateDocumentationOp) MarshalVT() (dAtA []byte, err error)
func (*CreateDocumentationOp) ProtoMessage ¶
func (*CreateDocumentationOp) ProtoMessage()
func (*CreateDocumentationOp) Reset ¶
func (x *CreateDocumentationOp) Reset()
func (*CreateDocumentationOp) SizeVT ¶
func (m *CreateDocumentationOp) SizeVT() (n int)
func (*CreateDocumentationOp) String ¶
func (x *CreateDocumentationOp) String() string
func (*CreateDocumentationOp) UnmarshalJSON ¶
func (x *CreateDocumentationOp) UnmarshalJSON(b []byte) error
UnmarshalJSON unmarshals the CreateDocumentationOp from JSON.
func (*CreateDocumentationOp) UnmarshalProtoJSON ¶
func (x *CreateDocumentationOp) UnmarshalProtoJSON(s *json.UnmarshalState)
UnmarshalProtoJSON unmarshals the CreateDocumentationOp message from JSON.
func (*CreateDocumentationOp) UnmarshalVT ¶
func (m *CreateDocumentationOp) UnmarshalVT(dAtA []byte) error
type Documentation ¶
type Documentation struct {
// Name is the display name of the documentation site.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Description is a short description of the documentation.
Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
// CreatedAt is the creation timestamp.
CreatedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=created_at,json=createdAt,proto3" json:"createdAt,omitempty"`
// contains filtered or unexported fields
}
Documentation is a world object representing a documentation site. Content is sourced from a UnixFS directory (markdown files) linked via the doc/source graph edge. Optionally linked to a GitRepo for versioning.
func (*Documentation) CloneMessageVT ¶
func (m *Documentation) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*Documentation) CloneVT ¶
func (m *Documentation) CloneVT() *Documentation
func (*Documentation) EqualMessageVT ¶
func (this *Documentation) EqualMessageVT(thatMsg any) bool
func (*Documentation) EqualVT ¶
func (this *Documentation) EqualVT(that *Documentation) bool
func (*Documentation) GetCreatedAt ¶
func (x *Documentation) GetCreatedAt() *timestamppb.Timestamp
func (*Documentation) GetDescription ¶
func (x *Documentation) GetDescription() string
func (*Documentation) GetName ¶
func (x *Documentation) GetName() string
func (*Documentation) MarshalJSON ¶
func (x *Documentation) MarshalJSON() ([]byte, error)
MarshalJSON marshals the Documentation to JSON.
func (*Documentation) MarshalProtoJSON ¶
func (x *Documentation) MarshalProtoJSON(s *json.MarshalState)
MarshalProtoJSON marshals the Documentation message to JSON.
func (*Documentation) MarshalProtoText ¶
func (x *Documentation) MarshalProtoText() string
func (*Documentation) MarshalToSizedBufferVT ¶
func (m *Documentation) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*Documentation) MarshalToVT ¶
func (m *Documentation) MarshalToVT(dAtA []byte) (int, error)
func (*Documentation) MarshalVT ¶
func (m *Documentation) MarshalVT() (dAtA []byte, err error)
func (*Documentation) ProtoMessage ¶
func (*Documentation) ProtoMessage()
func (*Documentation) Reset ¶
func (x *Documentation) Reset()
func (*Documentation) SizeVT ¶
func (m *Documentation) SizeVT() (n int)
func (*Documentation) String ¶
func (x *Documentation) String() string
func (*Documentation) UnmarshalJSON ¶
func (x *Documentation) UnmarshalJSON(b []byte) error
UnmarshalJSON unmarshals the Documentation from JSON.
func (*Documentation) UnmarshalProtoJSON ¶
func (x *Documentation) UnmarshalProtoJSON(s *json.UnmarshalState)
UnmarshalProtoJSON unmarshals the Documentation message from JSON.
func (*Documentation) UnmarshalVT ¶
func (m *Documentation) UnmarshalVT(dAtA []byte) error
Source Files
Click to show internal directories.
Click to hide internal directories.