blob: 25f70a84018c12d28685e6b010ec6aa9c092f7f8 [file] [log] [blame]
// Copyright (c) 2015, Google Inc.
// 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
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
// This file contains annotation definitions that can be used to describe
// a configuration tree.
syntax = "proto3";
option go_package = "";
package voltha;
import "google/protobuf/descriptor.proto";
enum MessageParserOption {
// Move any enclosing child enum/message definition to the same level
// as the parent (this message) in the yang generated file
// Create both a grouping and a container for this message. The container
// name will be the message name. The grouping name will be the message
// name prefixed with "grouping_"
message InlineNode {
string id = 1;
string type = 2;
message RpcReturnDef {
// The gRPC methods return message types. NETCONF expects an actual
// attribute as defined in the YANG schema. The xnl_tag will be used
// as the top most tag when translating a gRPC response into an xml
// response
string xml_tag = 1;
// When the gRPC response is a list of items, we need to differentiate
// between a YANG schema attribute whose name is "items" and when "items"
// is used only to indicate a list of items is being returned. The default
// behavior assumes a list is returned when "items" is present in
// the response. This option will therefore be used when the attribute
// name in the YANG schema is 'items'
string list_items_name = 2;
extend google.protobuf.MessageOptions {
// This annotation is used to indicate how a message is parsed when
// converting from proto to yang format.
MessageParserOption yang_child_rule = 7761774;
MessageParserOption yang_message_rule = 7761775;
extend google.protobuf.FieldOptions {
// If present, the field (a message reference) should be replaced by the
// message itself. For now, this applies only to non-repeated fields.
InlineNode yang_inline_node = 7761776;
extend google.protobuf.MethodOptions {
RpcReturnDef yang_xml_tag = 7761777;