Documentation
¶
Overview ¶
Copyright 2023 Yusuke Fredrick Tsutsumi // Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2023 Yusuke Fredrick Tsutsumi ¶
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- Constants
- func APIToProto(a *api.API, outputDir string) (*desc.FileDescriptor, error)
- func APIToProtoString(a *api.API, outputDir string) ([]byte, error)
- func AddApply(a *api.API, r *api.Resource, resMsg Message, fb *builder.FileBuilder, ...) error
- func AddCreate(a *api.API, r *api.Resource, resMsg Message, fb *builder.FileBuilder, ...) error
- func AddCustomMethod(a *api.API, r *api.Resource, cm *api.CustomMethod, resMsg Message, ...) error
- func AddDelete(a *api.API, r *api.Resource, resMsg Message, fb *builder.FileBuilder, ...) error
- func AddGet(a *api.API, r *api.Resource, resMsg Message, fb *builder.FileBuilder, ...) error
- func AddGlobalList(r *api.Resource, a *api.API, resMsg Message, fb *builder.FileBuilder, ...) error
- func AddList(r *api.Resource, resMsg Message, fb *builder.FileBuilder, ...) error
- func AddResource(r *api.Resource, a *api.API, fb *builder.FileBuilder, ...) error
- func AddUpdate(a *api.API, r *api.Resource, resMsg Message, fb *builder.FileBuilder, ...) error
- func GenerateMessage(name string, s *openapi.Schema, a *api.API, m *MessageStorage) (*builder.MessageBuilder, error)
- func GenerateSchemaMessages(a *api.API, m *MessageStorage, fb *builder.FileBuilder) error
- type Message
- type MessageStorage
- type WrappedMessageBuilder
- type WrappedMessageDescriptor
Constants ¶
const OPERATION_MESSAGE = "aep.api.Operation"
Variables ¶
This section is empty.
Functions ¶
func APIToProto ¶
func AddApply ¶
func AddApply(a *api.API, r *api.Resource, resMsg Message, fb *builder.FileBuilder, sb *builder.ServiceBuilder) error
AddApply adds a read method for the resource, along with any required messages.
func AddCreate ¶
func AddCreate(a *api.API, r *api.Resource, resMsg Message, fb *builder.FileBuilder, sb *builder.ServiceBuilder) error
func AddCustomMethod ¶
func AddCustomMethod(a *api.API, r *api.Resource, cm *api.CustomMethod, resMsg Message, fb *builder.FileBuilder, m *MessageStorage, sb *builder.ServiceBuilder) error
func AddDelete ¶
func AddDelete(a *api.API, r *api.Resource, resMsg Message, fb *builder.FileBuilder, sb *builder.ServiceBuilder) error
func AddGet ¶
func AddGet(a *api.API, r *api.Resource, resMsg Message, fb *builder.FileBuilder, sb *builder.ServiceBuilder) error
AddGet adds a read method for the resource, along with any required messages.
func AddGlobalList ¶
func AddGlobalList(r *api.Resource, a *api.API, resMsg Message, fb *builder.FileBuilder, sb *builder.ServiceBuilder) error
func AddList ¶
func AddList(r *api.Resource, resMsg Message, fb *builder.FileBuilder, sb *builder.ServiceBuilder) error
func AddResource ¶
func AddResource(r *api.Resource, a *api.API, fb *builder.FileBuilder, sb *builder.ServiceBuilder, ms *MessageStorage) error
AddResource adds a resource's protos and RPCs to a file and service.
func AddUpdate ¶
func AddUpdate(a *api.API, r *api.Resource, resMsg Message, fb *builder.FileBuilder, sb *builder.ServiceBuilder) error
AddRead adds a read method for the resource, along with any required messages.
func GenerateMessage ¶
func GenerateMessage(name string, s *openapi.Schema, a *api.API, m *MessageStorage) (*builder.MessageBuilder, error)
func GenerateSchemaMessages ¶
func GenerateSchemaMessages(a *api.API, m *MessageStorage, fb *builder.FileBuilder) error
Types ¶
type Message ¶
type Message interface {
FieldType() *builder.FieldType
RpcType() *builder.RpcType
Options() *descriptorpb.MessageOptions
AddMessage(fb *builder.FileBuilder)
}
type Message wraps a MessageBuilder or a message descriptor. It abstracts those concrete implementations to provide a common interface.
func GenerateSchemaMessage ¶
func GenerateSchemaMessage(name string, s *openapi.Schema, a *api.API, ms *MessageStorage) (Message, error)
GenerateResourceMesssage adds the resource message.
type MessageStorage ¶
type WrappedMessageBuilder ¶
type WrappedMessageBuilder struct {
// contains filtered or unexported fields
}
A variant that wraps MessageBuilder, for messages created during generation.
func NewWrappedMessageBuilder ¶
func NewWrappedMessageBuilder(mb *builder.MessageBuilder) WrappedMessageBuilder
func (WrappedMessageBuilder) AddMessage ¶
func (wrapped WrappedMessageBuilder) AddMessage(fb *builder.FileBuilder)
func (WrappedMessageBuilder) FieldType ¶
func (wrapped WrappedMessageBuilder) FieldType() *builder.FieldType
func (WrappedMessageBuilder) Options ¶
func (wrapped WrappedMessageBuilder) Options() *descriptorpb.MessageOptions
func (WrappedMessageBuilder) RpcType ¶
func (wrapped WrappedMessageBuilder) RpcType() *builder.RpcType
type WrappedMessageDescriptor ¶
type WrappedMessageDescriptor struct {
// contains filtered or unexported fields
}
A variant that wraps MessageDescriptor, for messages referenced
func NewWrappedMessageDescriptor ¶
func NewWrappedMessageDescriptor(md *desc.MessageDescriptor) WrappedMessageDescriptor
func (WrappedMessageDescriptor) AddMessage ¶
func (wrapped WrappedMessageDescriptor) AddMessage(fb *builder.FileBuilder)
func (WrappedMessageDescriptor) FieldType ¶
func (wrapped WrappedMessageDescriptor) FieldType() *builder.FieldType
func (WrappedMessageDescriptor) Options ¶
func (wrapped WrappedMessageDescriptor) Options() *descriptorpb.MessageOptions
func (WrappedMessageDescriptor) RpcType ¶
func (wrapped WrappedMessageDescriptor) RpcType() *builder.RpcType
Source Files