Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

network API re-org trial #4276

Closed
wants to merge 2 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
update OpenAPI doc
  • Loading branch information
ahl committed Oct 13, 2023
commit 920620b8ce55f362085d0e415d4b54e75342fb16
242 changes: 166 additions & 76 deletions openapi/nexus.json
Original file line number Diff line number Diff line change
@@ -7565,22 +7565,6 @@
"address_lot"
]
},
"AddressConfig": {
"description": "A set of addresses associated with a port configuration.",
"type": "object",
"properties": {
"addresses": {
"description": "The set of addresses assigned to the port configuration.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Address"
}
}
},
"required": [
"addresses"
]
},
"AddressLot": {
"description": "Represents an address lot object, containing the id of the lot that can be used in other API calls.",
"type": "object",
@@ -7816,43 +7800,6 @@
"serial"
]
},
"BgpPeerConfig": {
"description": "A BGP peer configuration for an interface. Includes the set of announcements that will be advertised to the peer identified by `addr`. The `bgp_config` parameter is a reference to global BGP parameters. The `interface_name` indicates what interface the peer should be contacted on.",
"type": "object",
"properties": {
"addr": {
"description": "The address of the host to peer with.",
"type": "string",
"format": "ip"
},
"bgp_announce_set": {
"description": "The set of announcements advertised by the peer.",
"allOf": [
{
"$ref": "#/components/schemas/NameOrId"
}
]
},
"bgp_config": {
"description": "The global BGP configuration used for establishing a session with this peer.",
"allOf": [
{
"$ref": "#/components/schemas/NameOrId"
}
]
},
"interface_name": {
"description": "The name of interface to peer on. This is relative to the port configuration this BGP peer configuration is a part of. For example this value could be phy0 to refer to a primary physical interface. Or it could be vlan47 to refer to a VLAN interface.",
"type": "string"
}
},
"required": [
"addr",
"bgp_announce_set",
"bgp_config",
"interface_name"
]
},
"BinRangedouble": {
"description": "A type storing a range over `T`.\n\nThis type supports ranges similar to the `RangeTo`, `Range` and `RangeFrom` types in the standard library. Those cover `(..end)`, `(start..end)`, and `(start..)` respectively.",
"oneOf": [
@@ -11751,7 +11698,7 @@
"description": "The link-layer discovery protocol (LLDP) configuration for the link.",
"allOf": [
{
"$ref": "#/components/schemas/LldpServiceConfig"
"$ref": "#/components/schemas/LldpServiceConfigCreate"
}
]
},
@@ -11768,6 +11715,31 @@
]
},
"LldpServiceConfig": {
"description": "A link layer discovery protocol (LLDP) service configuration.",
"type": "object",
"properties": {
"enabled": {
"description": "Whether or not the LLDP service is enabled.",
"type": "boolean"
},
"id": {
"description": "The id of this LLDP service instance.",
"type": "string",
"format": "uuid"
},
"lldp_config_id": {
"nullable": true,
"description": "The link-layer discovery protocol configuration for this service.",
"type": "string",
"format": "uuid"
}
},
"required": [
"enabled",
"id"
]
},
"LldpServiceConfigCreate": {
"description": "The LLDP configuration associated with a port. LLDP may be either enabled or disabled, if enabled, an LLDP configuration must be provided by name or id.",
"type": "object",
"properties": {
@@ -12329,7 +12301,7 @@
"type": "string",
"format": "ip"
},
"vid": {
"vlan_id": {
"nullable": true,
"description": "VLAN id the gateway is reachable over.",
"type": "integer",
@@ -12342,22 +12314,6 @@
"gw"
]
},
"RouteConfig": {
"description": "Route configuration data associated with a switch port configuration.",
"type": "object",
"properties": {
"routes": {
"description": "The set of routes assigned to a switch port.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Route"
}
}
},
"required": [
"routes"
]
},
"RouteDestination": {
"description": "A `RouteDestination` is used to match traffic with a routing rule, on the destination of that traffic.\n\nWhen traffic is to be sent to a destination that is within a given `RouteDestination`, the corresponding `RouterRoute` applies, and traffic will be forward to the `RouteTarget` for that rule.",
"oneOf": [
@@ -13461,14 +13417,53 @@
]
},
"SwitchInterfaceConfig": {
"description": "A switch port interface configuration for a port settings object.",
"type": "object",
"properties": {
"id": {
"description": "A unique identifier for this switch interface.",
"type": "string",
"format": "uuid"
},
"interface_name": {
"description": "The name of this switch interface.",
"type": "string"
},
"kind": {
"description": "The switch interface kind.",
"allOf": [
{
"$ref": "#/components/schemas/SwitchInterfaceKind"
}
]
},
"port_settings_id": {
"description": "The port settings object this switch interface configuration belongs to.",
"type": "string",
"format": "uuid"
},
"v6_enabled": {
"description": "Whether or not IPv6 is enabled on this interface.",
"type": "boolean"
}
},
"required": [
"id",
"interface_name",
"kind",
"port_settings_id",
"v6_enabled"
]
},
"SwitchInterfaceConfigCreate": {
"description": "A layer-3 switch interface configuration. When IPv6 is enabled, a link local address will be created for the interface.",
"type": "object",
"properties": {
"kind": {
"description": "What kind of switch interface this configuration represents.",
"allOf": [
{
"$ref": "#/components/schemas/SwitchInterfaceKind"
"$ref": "#/components/schemas/SwitchInterfaceKindCreate"
}
]
},
@@ -13483,6 +13478,32 @@
]
},
"SwitchInterfaceKind": {
"description": "Describes the kind of an switch interface.",
"oneOf": [
{
"description": "Primary interfaces are associated with physical links. There is exactly one primary interface per physical link.",
"type": "string",
"enum": [
"primary"
]
},
{
"description": "VLAN interfaces allow physical interfaces to be multiplexed onto multiple logical links, each distinguished by a 12-bit 802.1Q Ethernet tag.",
"type": "string",
"enum": [
"vlan"
]
},
{
"description": "Loopback interfaces are anchors for IP addresses that are not specific to any particular port.",
"type": "string",
"enum": [
"loopback"
]
}
]
},
"SwitchInterfaceKindCreate": {
"description": "Indicates the kind for a switch interface.",
"oneOf": [
{
@@ -13609,6 +13630,22 @@
"port_settings_id"
]
},
"SwitchPortAddressConfigCreate": {
"description": "A set of addresses associated with a port configuration.",
"type": "object",
"properties": {
"addresses": {
"description": "The set of addresses assigned to the port configuration.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Address"
}
}
},
"required": [
"addresses"
]
},
"SwitchPortApplySettings": {
"description": "Parameters for applying settings to switch ports.",
"type": "object",
@@ -13663,6 +13700,43 @@
"port_settings_id"
]
},
"SwitchPortBgpPeerConfigCreate": {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The prefixed names make sense here -- it's the sorta thing we'd want from uniquely-named submodules, but we're just doing explicitly.

"description": "A BGP peer configuration for an interface. Includes the set of announcements that will be advertised to the peer identified by `addr`. The `bgp_config` parameter is a reference to global BGP parameters. The `interface_name` indicates what interface the peer should be contacted on.",
"type": "object",
"properties": {
"addr": {
"description": "The address of the host to peer with.",
"type": "string",
"format": "ip"
},
"bgp_announce_set": {
"description": "The set of announcements advertised by the peer.",
"allOf": [
{
"$ref": "#/components/schemas/NameOrId"
}
]
},
"bgp_config": {
"description": "The global BGP configuration used for establishing a session with this peer.",
"allOf": [
{
"$ref": "#/components/schemas/NameOrId"
}
]
},
"interface_name": {
"description": "The name of interface to peer on. This is relative to the port configuration this BGP peer configuration is a part of. For example this value could be phy0 to refer to a primary physical interface. Or it could be vlan47 to refer to a VLAN interface.",
"type": "string"
}
},
"required": [
"addr",
"bgp_announce_set",
"bgp_config",
"interface_name"
]
},
"SwitchPortConfig": {
"description": "Physical switch port configuration.",
"type": "object",
@@ -13803,6 +13877,22 @@
"port_settings_id"
]
},
"SwitchPortRouteConfigCreate": {
"description": "Route configuration data associated with a switch port configuration.",
"type": "object",
"properties": {
"routes": {
"description": "The set of routes assigned to a switch port.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Route"
}
}
},
"required": [
"routes"
]
},
"SwitchPortSettings": {
"description": "A switch port settings identity whose id may be used to view additional details.",
"type": "object",
@@ -13851,14 +13941,14 @@
"description": "Addresses indexed by interface name.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/AddressConfig"
"$ref": "#/components/schemas/SwitchPortAddressConfigCreate"
}
},
"bgp_peers": {
"description": "BGP peers indexed by interface name.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/BgpPeerConfig"
"$ref": "#/components/schemas/SwitchPortBgpPeerConfigCreate"
}
},
"description": {
@@ -13874,7 +13964,7 @@
"description": "Interfaces indexed by link name.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/SwitchInterfaceConfig"
"$ref": "#/components/schemas/SwitchInterfaceConfigCreate"
}
},
"links": {
@@ -13894,7 +13984,7 @@
"description": "Routes indexed by interface name.",
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/RouteConfig"
"$ref": "#/components/schemas/SwitchPortRouteConfigCreate"
}
}
},
Loading