diff --git a/arista/configstatus.v1/configstatus-changelog.yaml b/arista/configstatus.v1/configstatus-changelog.yaml index f77f7724..d499b220 100644 --- a/arista/configstatus.v1/configstatus-changelog.yaml +++ b/arista/configstatus.v1/configstatus-changelog.yaml @@ -7,6 +7,10 @@ # New entries go on top. Changes: + - date: 2024-08-15 + description: Add hierarchy config source type + version: 1.1.1 + cvaas: true - date: 2024-05-09 description: Update GetSome REST endpoint version: 1.1.0 diff --git a/arista/configstatus.v1/configstatus.proto b/arista/configstatus.v1/configstatus.proto index cfdf4481..b5828a6b 100644 --- a/arista/configstatus.v1/configstatus.proto +++ b/arista/configstatus.v1/configstatus.proto @@ -19,95 +19,105 @@ import "fmp/extensions.proto"; // ErrorCode indicates warnings and errors produced during computing config enum ErrorCode { + // ERROR_CODE_UNSPECIFIED uninitialized value ERROR_CODE_UNSPECIFIED = 0; - // DEVICE_WARNING indicates device warning + // ERROR_CODE_DEVICE_WARNING indicates device warning ERROR_CODE_DEVICE_WARNING = 1; - // DEVICE_ERROR indicates device error + // ERROR_CODE_DEVICE_ERROR indicates device error ERROR_CODE_DEVICE_ERROR = 2; - // UNREACHABLE_DEVICE indicates the device cannot be reached + // ERROR_CODE_UNREACHABLE_DEVICE indicates the device cannot be reached ERROR_CODE_UNREACHABLE_DEVICE = 3; - // CONFIG_FILTER_ERROR indicates error from partial config management filters + // ERROR_CODE_CONFIG_FILTER_ERROR indicates error from partial config management filters ERROR_CODE_CONFIG_FILTER_ERROR = 4; - // INTERNAL indicates internal errors + // ERROR_CODE_INTERNAL indicates internal errors ERROR_CODE_INTERNAL = 5; } -// ConfigError represents errors reported by CVP when handling device configuration +// ConfigError represents errors reported by CVP/EOS when handling device configuration message ConfigError { + // error_code - type of error. ErrorCode error_code = 1; + // error_msg - details of error google.protobuf.StringValue error_msg = 2; - // Line_num represents line number, if any + // line_num represents line number, if any google.protobuf.Int32Value line_num = 3; - // Configlet_name represents the originating configlet name. Configlet_name + // configlet_name represents the originating configlet name. Configlet_name // and line_num point to the line where config warning or config error originate. google.protobuf.StringValue configlet_name = 4; } +// ConfigErrors list of errors message ConfigErrors { + // values - list of errors repeated ConfigError values = 1; } // DiffOp is the operation to a line from one side of diff to get to another enum DiffOp { + // DIFF_OP_UNSPECIFIED uninitialized DIFF_OP_UNSPECIFIED = 0; - // NOP indicates no change. A and B are identical at this line + // DIFF_OP_NOP indicates no change. A and B are identical at this line DIFF_OP_NOP = 1; - // IGNORE indicates a line that's ignored in either A or B. + // DIFF_OP_IGNORE indicates a line that's ignored in either A or B. // One of a_line_num or b_line_num will be -1 DIFF_OP_IGNORE = 2; - // ADD is an addition of a line from A + // DIFF_OP_ADD is an addition of a line from A DIFF_OP_ADD = 3; - // DELETE is deletion of a line from B + // DIFF_OP_DELETE is deletion of a line from B DIFF_OP_DELETE = 4; - // CHANGE is a modification to a line in A + // DIFF_OP_CHANGE is a modification to a line in A DIFF_OP_CHANGE = 5; } // ConfigFilterCode indicates if a config line matches PCM filter(s) enum ConfigFilterCode { - // UNSPECIFIED indicates config line did not match any partial config management (PCM) filter + // CONFIG_FILTER_CODE_UNSPECIFIED uninitialized CONFIG_FILTER_CODE_UNSPECIFIED = 0; - // MANAGED_LINE indicates config line matches managed PCM filter hence is managed + // CONFIG_FILTER_CODE_MANAGED_LINE indicates config line matches managed PCM filter hence is managed CONFIG_FILTER_CODE_MANAGED_LINE = 1; - // UNMANAGED_LINE indicates config line matches unmanaged PCM filter hence is not managed + // CONFIG_FILTER_CODE_UNMANAGED_LINE indicates config line matches unmanaged PCM filter hence is not managed CONFIG_FILTER_CODE_UNMANAGED_LINE = 2; } // DiffEntry represents one entry in a Diff message DiffEntry { + // op - type of diff DiffOp op = 1; - // line number in A this diff applies to + // a_line_num - line number in A this diff applies to google.protobuf.Int32Value a_line_num = 2; - // line number in B this diff applies to + // b_line_num - line number in B this diff applies to google.protobuf.Int32Value b_line_num = 3; - // line number of the parent command in B + // b_parent_line_num line number of the parent command in B google.protobuf.Int32Value b_parent_line_num = 4; - // content of config line in A + // a_line content of config line in A google.protobuf.StringValue a_line = 5; - // content of config line in B + // b_line content of config line in B google.protobuf.StringValue b_line = 6; - // Config filter code of the line in A + // a_filter_code Config filter code of the line in A ConfigFilterCode a_filter_code = 7; - // Config filter code of the line in B + // b_filter_code Config filter code of the line in B ConfigFilterCode b_filter_code = 8; - // line number of the parent command in A + // a_parent_line_num line number of the parent command in A google.protobuf.Int32Value a_parent_line_num = 9; } // DiffEntries indicates potential multiple lines of config diff message DiffEntries { + // values - list of diff entries repeated DiffEntry values = 1; } // ConfigSyncCode indicates config synchronization status enum ConfigSyncCode { + // CONFIG_SYNC_CODE_UNSPECIFIED uninitialized CONFIG_SYNC_CODE_UNSPECIFIED = 0; - // IN_SYNC indicates designed config and running config are identical + // CONFIG_SYNC_CODE_IN_SYNC indicates designed config and running config are identical CONFIG_SYNC_CODE_IN_SYNC = 1; - // OUT_OF_SYNC indicates designed config and running config are not identical + // CONFIG_SYNC_CODE_OUT_OF_SYNC indicates designed config and running config are not identical CONFIG_SYNC_CODE_OUT_OF_SYNC = 2; } // ConfigSourceType indicates the type of source for the proposed/designed configuration // for the device enum ConfigSourceType { + // CONFIG_SOURCE_TYPE_UNSPECIFIED uninitialized value CONFIG_SOURCE_TYPE_UNSPECIFIED = 0; // CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET - configlet created from @@ -117,12 +127,16 @@ enum ConfigSourceType { // CONFIG_SOURCE_TYPE_STUDIO - config generated from a regular studio CONFIG_SOURCE_TYPE_STUDIO = 2; - // SCONFIG_SOURCE_TYPE_STUDIO_STATIC - static config from studios framework + // CONFIG_SOURCE_TYPE_STUDIO_STATIC - static config from studios framework CONFIG_SOURCE_TYPE_STUDIO_STATIC = 3; + + // CONFIG_SOURCE_TYPE_HIERARCHY - config from the hierarchy frameork + CONFIG_SOURCE_TYPE_HIERARCHY = 5; } // ConfigSource describes an individual source of the proposed/designed config message ConfigSource { + // source_type - app type of the config snippet ConfigSourceType source_type = 1; // source_id identifier to distinguish between multiple instances of the source type @@ -130,48 +144,55 @@ message ConfigSource { // configlet name for CONFIG_SOURCE_TYPE_NETWORK_PROVISIONING_CONFIGLET // studio id for CONFIG_SOURCE_TYPE_STUDIO // configlet id for CONFIG_SOURCE_TYPE_STUDIO_STATIC + // FixtureInstance id for CONFIG_SOURCE_TYPE_HIERARCHY google.protobuf.StringValue source_id = 2; } // ConfigSources is the list of sources of the proposed/designed config message ConfigSources { + // values - ordered list of all the config snippets present in DC repeated ConfigSource values = 1; } // ConfigSummary represents device configuration summary. message ConfigSummary { + // sync - state of DC vs RC ConfigSyncCode sync = 1; - // Number of lines with code no-operation + // nop_lines - Number of lines with code no-operation google.protobuf.Int32Value nop_lines = 2; - // Number of lines with code IGNORE + // ignored_lines - Number of lines with code IGNORE google.protobuf.Int32Value ignored_lines = 3; - // Number of lines with code ADD + // added_lines - Number of lines with code ADD google.protobuf.Int32Value added_lines = 4; - // Number of lines with code DELETE + // deleted_lines - Number of lines with code DELETE google.protobuf.Int32Value deleted_lines = 5; - // Number of lines with code CHANGE + // changed_lines - Number of lines with code CHANGE google.protobuf.Int32Value changed_lines = 6; - // Number of designed config errors + // designed_config_errors - Number of designed config errors google.protobuf.Int32Value designed_config_errors = 7; - // Number of designed config warnings + // designed_config_warnings - Number of designed config warnings google.protobuf.Int32Value designed_config_warnings = 8; - // Timestamp at which running config is updated + // running_config_update_time - Timestamp at which running config is updated google.protobuf.Timestamp running_config_update_time = 9; - // Timestamp at which designed config is updated + // designed_config_update_time - Timestamp at which designed config is updated google.protobuf.Timestamp designed_config_update_time = 10; - // The HTTP URI client can use to GET running config and associated errors + // running_config_uri - The HTTP URI client can use to GET running config and associated errors google.protobuf.StringValue running_config_uri = 11; - // The HTTP URI client can use to GET designed config and associated errors + // designed_config_uri - The HTTP URI client can use to GET designed config and associated errors google.protobuf.StringValue designed_config_uri = 12; - // The HTTP URI client can use to GET config diff and associated errors + // diff_uri - The HTTP URI client can use to GET config diff and associated errors google.protobuf.StringValue diff_uri = 13; - // Digest (SHA-256) of the config diff. + // digest (SHA-256) of the config diff. google.protobuf.StringValue digest = 14; } +// ConfigType - specifies type of config enum ConfigType { + // CONFIG_TYPE_UNSPECIFIED uninitialized value CONFIG_TYPE_UNSPECIFIED = 0; + // CONFIG_TYPE_RUNNING_CONFIG uninitialized value CONFIG_TYPE_RUNNING_CONFIG = 1; + // CONFIG_TYPE_DESIGNED_CONFIG uninitialized value CONFIG_TYPE_DESIGNED_CONFIG = 2; } @@ -179,9 +200,9 @@ enum ConfigType { message ConfigKey { option (fmp.model_key) = true; - // Device_id is the serial number of the device + // device_id is the serial number of the device google.protobuf.StringValue device_id = 1; - // Type describes the config type + // type describes the config type ConfigType type = 2; } @@ -189,8 +210,9 @@ message ConfigKey { message Configuration { option (fmp.model) = "ro"; + // key specifies the device and type of config ConfigKey key = 1; - // Uri represents the HTTP URI client can use to GET config body and associated errors + // uri represents the HTTP URI client can use to GET config body and associated errors google.protobuf.StringValue uri = 2; } @@ -198,28 +220,29 @@ message Configuration { message ConfigDiffKey { option (fmp.model_key) = true; - // A_device_id is the serial number of the device on A side (left hand side) + // a_device_id is the serial number of the device on A side (left hand side) google.protobuf.StringValue a_device_id = 1; - // A_type is the config type on A side (left hand side) + // a_type is the config type on A side (left hand side) ConfigType a_type = 2; - // A_time is the time at which to fetch config on A side (left hand side) + // a_time is the time at which to fetch config on A side (left hand side) google.protobuf.Timestamp a_time = 3; - // B_device_id is the serial number of the device on B side (right hand side) + // b_device_id is the serial number of the device on B side (right hand side) google.protobuf.StringValue b_device_id = 4; - // B_type is the config type on B side (right hand side) + // b_type is the config type on B side (right hand side) ConfigType b_type = 5; - // B_time is the time at which to fetch config on B side (right hand side) + // b_time is the time at which to fetch config on B side (right hand side) google.protobuf.Timestamp b_time = 6; } +// ConfigDiff - specifies the diff request message ConfigDiff { option (fmp.model) = "ro"; - // Key represents config diff key + // key represents config diff key ConfigDiffKey key = 1; - // Uri represents the HTTP URI client can use to GET config diff and associated errors + // uri represents the HTTP URI client can use to GET config diff and associated errors google.protobuf.StringValue uri = 2; } @@ -227,15 +250,18 @@ message ConfigDiff { message SummaryKey { option (fmp.model_key) = true; - // Device_id is the serial number of the device + // device_id is the serial number of the device google.protobuf.StringValue device_id = 1; } +// Summary - Describes the device's diff summary message Summary { option (fmp.model) = "ro"; + // key spefies the device SummaryKey key = 1; + // summary - diff summary of the device ConfigSummary summary = 2; } @@ -252,6 +278,7 @@ message SecurityProfile { // SecurityProfileComplianceSummary holds the compliance summary for // security profile configuration. message SecurityProfileComplianceSummary { + // sync - sync state of the device ConfigSyncCode sync = 1; // nop_lines is the number of lines with code no-operation google.protobuf.Int32Value nop_lines = 2; diff --git a/arista/configstatus.v1/services.gen.swagger.json b/arista/configstatus.v1/services.gen.swagger.json index a026d0a8..18559b9f 100644 --- a/arista/configstatus.v1/services.gen.swagger.json +++ b/arista/configstatus.v1/services.gen.swagger.json @@ -58,14 +58,14 @@ "parameters": [ { "name": "key.aDeviceId", - "description": "A_device_id is the serial number of the device on A side (left hand side)", + "description": "a_device_id is the serial number of the device on A side (left hand side)", "in": "query", "required": true, "type": "string" }, { "name": "key.aType", - "description": "A_type is the config type on A side (left hand side)", + "description": "a_type is the config type on A side (left hand side)\n\n - CONFIG_TYPE_UNSPECIFIED: CONFIG_TYPE_UNSPECIFIED uninitialized value\n - CONFIG_TYPE_RUNNING_CONFIG: CONFIG_TYPE_RUNNING_CONFIG uninitialized value\n - CONFIG_TYPE_DESIGNED_CONFIG: CONFIG_TYPE_DESIGNED_CONFIG uninitialized value", "in": "query", "required": true, "type": "string", @@ -78,7 +78,7 @@ }, { "name": "key.aTime", - "description": "A_time is the time at which to fetch config on A side (left hand side)", + "description": "a_time is the time at which to fetch config on A side (left hand side)", "in": "query", "required": true, "type": "string", @@ -86,14 +86,14 @@ }, { "name": "key.bDeviceId", - "description": "B_device_id is the serial number of the device on B side (right hand side)", + "description": "b_device_id is the serial number of the device on B side (right hand side)", "in": "query", "required": true, "type": "string" }, { "name": "key.bType", - "description": "B_type is the config type on B side (right hand side)", + "description": "b_type is the config type on B side (right hand side)\n\n - CONFIG_TYPE_UNSPECIFIED: CONFIG_TYPE_UNSPECIFIED uninitialized value\n - CONFIG_TYPE_RUNNING_CONFIG: CONFIG_TYPE_RUNNING_CONFIG uninitialized value\n - CONFIG_TYPE_DESIGNED_CONFIG: CONFIG_TYPE_DESIGNED_CONFIG uninitialized value", "in": "query", "required": true, "type": "string", @@ -106,7 +106,7 @@ }, { "name": "key.bTime", - "description": "B_time is the time at which to fetch config on B side (right hand side)", + "description": "b_time is the time at which to fetch config on B side (right hand side)", "in": "query", "required": true, "type": "string", @@ -513,14 +513,14 @@ "parameters": [ { "name": "key.deviceId", - "description": "Device_id is the serial number of the device", + "description": "device_id is the serial number of the device", "in": "query", "required": true, "type": "string" }, { "name": "key.type", - "description": "Type describes the config type", + "description": "type describes the config type\n\n - CONFIG_TYPE_UNSPECIFIED: CONFIG_TYPE_UNSPECIFIED uninitialized value\n - CONFIG_TYPE_RUNNING_CONFIG: CONFIG_TYPE_RUNNING_CONFIG uninitialized value\n - CONFIG_TYPE_DESIGNED_CONFIG: CONFIG_TYPE_DESIGNED_CONFIG uninitialized value", "in": "query", "required": true, "type": "string", @@ -932,14 +932,14 @@ "parameters": [ { "name": "key.deviceId", - "description": "Device_id is the serial number of the device", + "description": "device_id is the serial number of the device", "in": "query", "required": true, "type": "string" }, { "name": "key.type", - "description": "Type describes the config type", + "description": "type describes the config type\n\n - CONFIG_TYPE_UNSPECIFIED: CONFIG_TYPE_UNSPECIFIED uninitialized value\n - CONFIG_TYPE_RUNNING_CONFIG: CONFIG_TYPE_RUNNING_CONFIG uninitialized value\n - CONFIG_TYPE_DESIGNED_CONFIG: CONFIG_TYPE_DESIGNED_CONFIG uninitialized value", "in": "query", "required": true, "type": "string", @@ -1351,14 +1351,14 @@ "parameters": [ { "name": "key.aDeviceId", - "description": "A_device_id is the serial number of the device on A side (left hand side)", + "description": "a_device_id is the serial number of the device on A side (left hand side)", "in": "query", "required": true, "type": "string" }, { "name": "key.aType", - "description": "A_type is the config type on A side (left hand side)", + "description": "a_type is the config type on A side (left hand side)\n\n - CONFIG_TYPE_UNSPECIFIED: CONFIG_TYPE_UNSPECIFIED uninitialized value\n - CONFIG_TYPE_RUNNING_CONFIG: CONFIG_TYPE_RUNNING_CONFIG uninitialized value\n - CONFIG_TYPE_DESIGNED_CONFIG: CONFIG_TYPE_DESIGNED_CONFIG uninitialized value", "in": "query", "required": true, "type": "string", @@ -1371,7 +1371,7 @@ }, { "name": "key.aTime", - "description": "A_time is the time at which to fetch config on A side (left hand side)", + "description": "a_time is the time at which to fetch config on A side (left hand side)", "in": "query", "required": true, "type": "string", @@ -1379,14 +1379,14 @@ }, { "name": "key.bDeviceId", - "description": "B_device_id is the serial number of the device on B side (right hand side)", + "description": "b_device_id is the serial number of the device on B side (right hand side)", "in": "query", "required": true, "type": "string" }, { "name": "key.bType", - "description": "B_type is the config type on B side (right hand side)", + "description": "b_type is the config type on B side (right hand side)\n\n - CONFIG_TYPE_UNSPECIFIED: CONFIG_TYPE_UNSPECIFIED uninitialized value\n - CONFIG_TYPE_RUNNING_CONFIG: CONFIG_TYPE_RUNNING_CONFIG uninitialized value\n - CONFIG_TYPE_DESIGNED_CONFIG: CONFIG_TYPE_DESIGNED_CONFIG uninitialized value", "in": "query", "required": true, "type": "string", @@ -1399,7 +1399,7 @@ }, { "name": "key.bTime", - "description": "B_time is the time at which to fetch config on B side (right hand side)", + "description": "b_time is the time at which to fetch config on B side (right hand side)", "in": "query", "required": true, "type": "string", @@ -1806,7 +1806,7 @@ "parameters": [ { "name": "key.deviceId", - "description": "Device_id is the serial number of the device", + "description": "device_id is the serial number of the device", "in": "query", "required": true, "type": "string" @@ -2212,7 +2212,7 @@ "parameters": [ { "name": "key.deviceId", - "description": "Device_id is the serial number of the device", + "description": "device_id is the serial number of the device", "in": "query", "required": true, "type": "string" @@ -2605,13 +2605,14 @@ "properties": { "key": { "$ref": "#/definitions/arista.configstatus.v1.ConfigDiffKey", - "title": "Key represents config diff key" + "title": "key represents config diff key" }, "uri": { "type": "string", - "title": "Uri represents the HTTP URI client can use to GET config diff and associated errors" + "title": "uri represents the HTTP URI client can use to GET config diff and associated errors" } - } + }, + "title": "ConfigDiff - specifies the diff request" }, "arista.configstatus.v1.ConfigDiffBatchedStreamResponse": { "type": "object", @@ -2631,29 +2632,29 @@ "properties": { "aDeviceId": { "type": "string", - "title": "A_device_id is the serial number of the device on A side (left hand side)" + "title": "a_device_id is the serial number of the device on A side (left hand side)" }, "aType": { "$ref": "#/definitions/arista.configstatus.v1.ConfigType", - "title": "A_type is the config type on A side (left hand side)" + "title": "a_type is the config type on A side (left hand side)" }, "aTime": { "type": "string", "format": "date-time", - "title": "A_time is the time at which to fetch config on A side (left hand side)" + "title": "a_time is the time at which to fetch config on A side (left hand side)" }, "bDeviceId": { "type": "string", - "title": "B_device_id is the serial number of the device on B side (right hand side)" + "title": "b_device_id is the serial number of the device on B side (right hand side)" }, "bType": { "$ref": "#/definitions/arista.configstatus.v1.ConfigType", - "title": "B_type is the config type on B side (right hand side)" + "title": "b_type is the config type on B side (right hand side)" }, "bTime": { "type": "string", "format": "date-time", - "title": "B_time is the time at which to fetch config on B side (right hand side)" + "title": "b_time is the time at which to fetch config on B side (right hand side)" } }, "title": "ConfigDiffKey uniquely identifies a configuration diff request", @@ -2757,7 +2758,7 @@ "CONFIG_FILTER_CODE_UNMANAGED_LINE" ], "default": "CONFIG_FILTER_CODE_UNSPECIFIED", - "description": "- CONFIG_FILTER_CODE_UNSPECIFIED: UNSPECIFIED indicates config line did not match any partial config management (PCM) filter\n - CONFIG_FILTER_CODE_MANAGED_LINE: MANAGED_LINE indicates config line matches managed PCM filter hence is managed\n - CONFIG_FILTER_CODE_UNMANAGED_LINE: UNMANAGED_LINE indicates config line matches unmanaged PCM filter hence is not managed", + "description": "- CONFIG_FILTER_CODE_UNSPECIFIED: CONFIG_FILTER_CODE_UNSPECIFIED uninitialized\n - CONFIG_FILTER_CODE_MANAGED_LINE: CONFIG_FILTER_CODE_MANAGED_LINE indicates config line matches managed PCM filter hence is managed\n - CONFIG_FILTER_CODE_UNMANAGED_LINE: CONFIG_FILTER_CODE_UNMANAGED_LINE indicates config line matches unmanaged PCM filter hence is not managed", "title": "ConfigFilterCode indicates if a config line matches PCM filter(s)" }, "arista.configstatus.v1.ConfigKey": { @@ -2765,11 +2766,11 @@ "properties": { "deviceId": { "type": "string", - "title": "Device_id is the serial number of the device" + "title": "device_id is the serial number of the device" }, "type": { "$ref": "#/definitions/arista.configstatus.v1.ConfigType", - "title": "Type describes the config type" + "title": "type describes the config type" } }, "description": "ConfigKey uniquely identifies a config request.", @@ -2782,68 +2783,69 @@ "type": "object", "properties": { "sync": { - "$ref": "#/definitions/arista.configstatus.v1.ConfigSyncCode" + "$ref": "#/definitions/arista.configstatus.v1.ConfigSyncCode", + "title": "sync - state of DC vs RC" }, "nopLines": { "type": "integer", "format": "int32", - "title": "Number of lines with code no-operation" + "title": "nop_lines - Number of lines with code no-operation" }, "ignoredLines": { "type": "integer", "format": "int32", - "title": "Number of lines with code IGNORE" + "title": "ignored_lines - Number of lines with code IGNORE" }, "addedLines": { "type": "integer", "format": "int32", - "title": "Number of lines with code ADD" + "title": "added_lines - Number of lines with code ADD" }, "deletedLines": { "type": "integer", "format": "int32", - "title": "Number of lines with code DELETE" + "title": "deleted_lines - Number of lines with code DELETE" }, "changedLines": { "type": "integer", "format": "int32", - "title": "Number of lines with code CHANGE" + "title": "changed_lines - Number of lines with code CHANGE" }, "designedConfigErrors": { "type": "integer", "format": "int32", - "title": "Number of designed config errors" + "title": "designed_config_errors - Number of designed config errors" }, "designedConfigWarnings": { "type": "integer", "format": "int32", - "title": "Number of designed config warnings" + "title": "designed_config_warnings - Number of designed config warnings" }, "runningConfigUpdateTime": { "type": "string", "format": "date-time", - "title": "Timestamp at which running config is updated" + "title": "running_config_update_time - Timestamp at which running config is updated" }, "designedConfigUpdateTime": { "type": "string", "format": "date-time", - "title": "Timestamp at which designed config is updated" + "title": "designed_config_update_time - Timestamp at which designed config is updated" }, "runningConfigUri": { "type": "string", - "title": "The HTTP URI client can use to GET running config and associated errors" + "title": "running_config_uri - The HTTP URI client can use to GET running config and associated errors" }, "designedConfigUri": { "type": "string", - "title": "The HTTP URI client can use to GET designed config and associated errors" + "title": "designed_config_uri - The HTTP URI client can use to GET designed config and associated errors" }, "diffUri": { "type": "string", - "title": "The HTTP URI client can use to GET config diff and associated errors" + "title": "diff_uri - The HTTP URI client can use to GET config diff and associated errors" }, "digest": { "type": "string", - "description": "Digest (SHA-256) of the config diff." + "description": "digest (SHA-256) of the config diff." } }, "description": "ConfigSummary represents device configuration summary." @@ -2856,7 +2858,7 @@ "CONFIG_SYNC_CODE_OUT_OF_SYNC" ], "default": "CONFIG_SYNC_CODE_UNSPECIFIED", - "description": "- CONFIG_SYNC_CODE_IN_SYNC: IN_SYNC indicates designed config and running config are identical\n - CONFIG_SYNC_CODE_OUT_OF_SYNC: OUT_OF_SYNC indicates designed config and running config are not identical", + "description": "- CONFIG_SYNC_CODE_UNSPECIFIED: CONFIG_SYNC_CODE_UNSPECIFIED uninitialized\n - CONFIG_SYNC_CODE_IN_SYNC: CONFIG_SYNC_CODE_IN_SYNC indicates designed config and running config are identical\n - CONFIG_SYNC_CODE_OUT_OF_SYNC: CONFIG_SYNC_CODE_OUT_OF_SYNC indicates designed config and running config are not identical", "title": "ConfigSyncCode indicates config synchronization status" }, "arista.configstatus.v1.ConfigType": { @@ -2866,17 +2868,20 @@ "CONFIG_TYPE_RUNNING_CONFIG", "CONFIG_TYPE_DESIGNED_CONFIG" ], - "default": "CONFIG_TYPE_UNSPECIFIED" + "default": "CONFIG_TYPE_UNSPECIFIED", + "description": "- CONFIG_TYPE_UNSPECIFIED: CONFIG_TYPE_UNSPECIFIED uninitialized value\n - CONFIG_TYPE_RUNNING_CONFIG: CONFIG_TYPE_RUNNING_CONFIG uninitialized value\n - CONFIG_TYPE_DESIGNED_CONFIG: CONFIG_TYPE_DESIGNED_CONFIG uninitialized value", + "title": "ConfigType - specifies type of config" }, "arista.configstatus.v1.Configuration": { "type": "object", "properties": { "key": { - "$ref": "#/definitions/arista.configstatus.v1.ConfigKey" + "$ref": "#/definitions/arista.configstatus.v1.ConfigKey", + "title": "key specifies the device and type of config" }, "uri": { "type": "string", - "title": "Uri represents the HTTP URI client can use to GET config body and associated errors" + "title": "uri represents the HTTP URI client can use to GET config body and associated errors" } }, "title": "Configuration represents device's CLI configuration" @@ -2985,7 +2990,8 @@ "items": { "type": "object", "$ref": "#/definitions/arista.configstatus.v1.DiffEntry" - } + }, + "title": "values - list of diff entries" } }, "title": "DiffEntries indicates potential multiple lines of config diff" @@ -2994,43 +3000,44 @@ "type": "object", "properties": { "op": { - "$ref": "#/definitions/arista.configstatus.v1.DiffOp" + "$ref": "#/definitions/arista.configstatus.v1.DiffOp", + "title": "op - type of diff" }, "aLineNum": { "type": "integer", "format": "int32", - "title": "line number in A this diff applies to" + "title": "a_line_num - line number in A this diff applies to" }, "bLineNum": { "type": "integer", "format": "int32", - "title": "line number in B this diff applies to" + "title": "b_line_num - line number in B this diff applies to" }, "bParentLineNum": { "type": "integer", "format": "int32", - "title": "line number of the parent command in B" + "title": "b_parent_line_num line number of the parent command in B" }, "aLine": { "type": "string", - "title": "content of config line in A" + "title": "a_line content of config line in A" }, "bLine": { "type": "string", - "title": "content of config line in B" + "title": "b_line content of config line in B" }, "aFilterCode": { "$ref": "#/definitions/arista.configstatus.v1.ConfigFilterCode", - "title": "Config filter code of the line in A" + "title": "a_filter_code Config filter code of the line in A" }, "bFilterCode": { "$ref": "#/definitions/arista.configstatus.v1.ConfigFilterCode", - "title": "Config filter code of the line in B" + "title": "b_filter_code Config filter code of the line in B" }, "aParentLineNum": { "type": "integer", "format": "int32", - "title": "line number of the parent command in A" + "title": "a_parent_line_num line number of the parent command in A" } }, "title": "DiffEntry represents one entry in a Diff" @@ -3046,7 +3053,7 @@ "DIFF_OP_CHANGE" ], "default": "DIFF_OP_UNSPECIFIED", - "description": "- DIFF_OP_NOP: NOP indicates no change. A and B are identical at this line\n - DIFF_OP_IGNORE: IGNORE indicates a line that's ignored in either A or B.\nOne of a_line_num or b_line_num will be -1\n - DIFF_OP_ADD: ADD is an addition of a line from A\n - DIFF_OP_DELETE: DELETE is deletion of a line from B\n - DIFF_OP_CHANGE: CHANGE is a modification to a line in A", + "description": "- DIFF_OP_UNSPECIFIED: DIFF_OP_UNSPECIFIED uninitialized\n - DIFF_OP_NOP: DIFF_OP_NOP indicates no change. A and B are identical at this line\n - DIFF_OP_IGNORE: DIFF_OP_IGNORE indicates a line that's ignored in either A or B.\nOne of a_line_num or b_line_num will be -1\n - DIFF_OP_ADD: DIFF_OP_ADD is an addition of a line from A\n - DIFF_OP_DELETE: DIFF_OP_DELETE is deletion of a line from B\n - DIFF_OP_CHANGE: DIFF_OP_CHANGE is a modification to a line in A", "title": "DiffOp is the operation to a line from one side of diff to get to another" }, "arista.configstatus.v1.MetaResponse": { @@ -3099,7 +3106,8 @@ "type": "object", "properties": { "sync": { - "$ref": "#/definitions/arista.configstatus.v1.ConfigSyncCode" + "$ref": "#/definitions/arista.configstatus.v1.ConfigSyncCode", + "title": "sync - sync state of the device" }, "nopLines": { "type": "integer", @@ -3450,12 +3458,15 @@ "type": "object", "properties": { "key": { - "$ref": "#/definitions/arista.configstatus.v1.SummaryKey" + "$ref": "#/definitions/arista.configstatus.v1.SummaryKey", + "title": "key spefies the device" }, "summary": { - "$ref": "#/definitions/arista.configstatus.v1.ConfigSummary" + "$ref": "#/definitions/arista.configstatus.v1.ConfigSummary", + "title": "summary - diff summary of the device" } - } + }, + "title": "Summary - Describes the device's diff summary" }, "arista.configstatus.v1.SummaryBatchedStreamResponse": { "type": "object", @@ -3475,7 +3486,7 @@ "properties": { "deviceId": { "type": "string", - "title": "Device_id is the serial number of the device" + "title": "device_id is the serial number of the device" } }, "title": "SummaryKey uniquely identifies a device summary request",