@birdcc/lsp 0.0.1-alpha.1 → 0.1.0-beta.0

package/dist/hover-docs/20-filter-language.yaml

@@ -0,0 +1,209 @@
+entries:
+  - keyword: .asn
+    description: Extract AS number from pair
+    detail: Get the AS number component from an AS path pair.
+    diff: same
+    version: v2+
+    anchor: filter-pair
+    path: filter
+    related:
+      - .data
+    parameters:
+      - name: pair
+        description: Pair value exposing ASN component.
+  - keyword: .data
+    description: Extract data from pair
+    detail: Get the data component from an AS path pair.
+    diff: same
+    version: v2+
+    anchor: filter-pair
+    path: filter
+    related:
+      - .asn
+    parameters:
+      - name: pair
+        description: Pair value exposing data component.
+  - keyword: .ip
+    description: Extract IP from prefix
+    detail: Get the network address part of a prefix.
+    diff: same
+    version: v2+
+    anchor: filter-prefix
+    path: filter
+    related:
+      - .len
+      - .mask
+    parameters:
+      - name: prefix
+        description: Prefix value exposing network IP.
+  - keyword: .len
+    description: Prefix length operator
+    detail: Get the prefix length of a prefix value.
+    diff: same
+    version: v2+
+    anchor: filter-prefix
+    path: filter
+    related:
+      - .ip
+      - .mask
+    parameters:
+      - name: prefix
+        description: Prefix value exposing mask length.
+  - keyword: .mask
+    description: IP mask operator
+    detail: Get the subnet mask as an IP address.
+    diff: same
+    version: v2+
+    anchor: filter-ip
+    path: filter
+    related:
+      - .ip
+      - .len
+    parameters:
+      - name: ip-or-prefix
+        description: Address value exposing netmask.
+  - keyword: accept
+    description: Accept route
+    detail: Accept the current route and stop processing the filter.
+    diff: same
+    version: v2+
+    anchor: filter-control
+    path: filter
+    related:
+      - reject
+      - return
+  - keyword: case
+    description: Case statement
+    detail: Multi-way branch based on expression value.
+    diff: same
+    version: v2+
+    anchor: filter-control
+    path: filter
+    related:
+      - if
+      - else
+    parameters:
+      - name: expression
+        description: Expression used for case dispatch.
+        required: true
+  - keyword: defined
+    description: Check if symbol is defined
+    detail: Test whether a symbol (attribute, route property) is defined.
+    diff: same
+    version: v2+
+    anchor: filter-operators
+    path: filter
+    related:
+      - if
+    parameters:
+      - name: symbol
+        description: Route attribute or symbol name.
+        required: true
+  - keyword: else
+    description: Else clause
+    detail: Marks the beginning of statements to execute when condition is false.
+    diff: same
+    version: v2+
+    anchor: filter-control
+    path: filter
+    related:
+      - if
+      - then
+    parameters:
+      - name: statement
+        description: Statement block for false branch.
+  - keyword: if
+    description: Conditional statement
+    detail: Execute statements conditionally based on a boolean expression.
+    diff: same
+    version: v2+
+    anchor: filter-control
+    path: filter
+    related:
+      - then
+      - else
+      - case
+    parameters:
+      - name: condition
+        description: Boolean expression for branch entry.
+        required: true
+  - keyword: int
+    description: Integer data type
+    detail: A signed 32-bit integer.
+    diff: same
+    version: v2+
+    anchor: filter-data-types
+    path: filter
+    parameters:
+      - name: value
+        description: Signed 32-bit integer value.
+  - keyword: ip
+    description: IP address data type
+    detail: An IPv4 or IPv6 address.
+    diff: same
+    version: v2+
+    anchor: filter-data-types
+    path: filter
+    parameters:
+      - name: value
+        description: IPv4 or IPv6 address value.
+  - keyword: prefix
+    description: Prefix data type
+    detail: An IP address prefix consisting of an IP address and a prefix length.
+    diff: same
+    version: v2+
+    anchor: filter-data-types
+    path: filter
+    parameters:
+      - name: value
+        description: Prefix value (address/length).
+  - keyword: print
+    description: Print debug output
+    detail: Output debug information during filter execution.
+    diff: same
+    version: v2+
+    anchor: filter-functions
+    path: filter
+    parameters:
+      - name: values
+        description: One or more values to print.
+  - keyword: reject
+    description: Reject route
+    detail: Reject the current route and stop processing the filter.
+    diff: same
+    version: v2+
+    anchor: filter-control
+    path: filter
+    related:
+      - accept
+      - return
+  - keyword: return
+    description: Return from function
+    detail: Return a value from a filter function.
+    diff: same
+    version: v2+
+    anchor: filter-functions
+    path: filter
+    related:
+      - accept
+      - reject
+  - keyword: string
+    description: String data type
+    detail: A sequence of characters.
+    diff: same
+    version: v2+
+    anchor: filter-data-types
+    path: filter
+  - keyword: then
+    description: Then clause
+    detail: Marks the beginning of statements to execute when condition is true.
+    diff: same
+    version: v2+
+    anchor: filter-control
+    path: filter
+    related:
+      - if
+      - else
+    parameters:
+      - name: statement
+        description: Statement block for true branch.

package/dist/hover-docs/30-channel-options.yaml

@@ -0,0 +1,244 @@
+entries:
+  - keyword: export
+    description: Export filter for channel
+    detail: Specify filter for routes exported from the routing table to the protocol.
+    diff: modified
+    version: v2-v3
+    anchor: channel-export
+    path:
+      - protocol.bgp.channel
+      - protocol.babel.channel
+      - protocol.rip.channel
+      - protocol.kernel.channel
+      - protocol.static.channel
+      - protocol.pipe.channel
+      - protocol.ospf.channel
+    related:
+      - import
+      - export limit
+    parameters:
+      - name: policy
+        description: Export policy such as all, none, or a named filter.
+    notes:
+      v3: "v3 Enhanced: Supports 'export in prefix' syntax for selective export."
+  - keyword: export block
+    description: Export block size (v3 only)
+    detail: Configure bulk export block size for improved performance.
+    diff: added
+    version: v3+
+    anchor: channel-export-block
+    path:
+      - protocol.bgp.channel
+      - protocol.babel.channel
+      - protocol.rip.channel
+      - protocol.kernel.channel
+      - protocol.static.channel
+      - protocol.pipe.channel
+      - protocol.ospf.channel
+    related:
+      - export
+      - export limit
+    parameters:
+      - name: number
+        description: Block size for batched export processing.
+    notes:
+      v3: "v3 only: Bulk export optimization."
+  - keyword: export limit
+    description: Export route limit
+    detail: Set maximum number of routes that can be exported to the peer.
+    diff: same
+    version: v2+
+    anchor: channel-export-limit
+    path:
+      - protocol.bgp.channel
+      - protocol.babel.channel
+      - protocol.rip.channel
+      - protocol.kernel.channel
+      - protocol.static.channel
+      - protocol.pipe.channel
+      - protocol.ospf.channel
+    related:
+      - export
+      - receive limit
+    parameters:
+      - name: number
+        description: Maximum exported route count.
+      - name: action
+        description: Action when limit is reached, such as warn or disable.
+  - keyword: import
+    description: Import filter for channel
+    detail: Specify filter for routes imported from the protocol to the routing table.
+    diff: same
+    version: v2+
+    anchor: channel-import
+    path:
+      - protocol.bgp.channel
+      - protocol.babel.channel
+      - protocol.rip.channel
+      - protocol.kernel.channel
+      - protocol.static.channel
+      - protocol.pipe.channel
+      - protocol.ospf.channel
+    related:
+      - export
+      - import limit
+    parameters:
+      - name: policy
+        description: Import policy such as all, none, or a named filter.
+  - keyword: import keep filtered
+    description: Keep filtered routes
+    detail: Store routes that were filtered out during import, allowing them to be examined.
+    diff: same
+    version: v2+
+    anchor: channel-import-keep-filtered
+    path:
+      - protocol.bgp.channel
+      - protocol.babel.channel
+      - protocol.rip.channel
+      - protocol.kernel.channel
+      - protocol.static.channel
+      - protocol.pipe.channel
+      - protocol.ospf.channel
+    related:
+      - import
+    parameters:
+      - name: switch
+        description: Enable or disable preservation of filtered routes.
+  - keyword: import limit
+    description: Import route limit
+    detail: Set maximum number of routes that can be imported from this channel.
+    diff: same
+    version: v2+
+    anchor: channel-import-limit
+    path:
+      - protocol.bgp.channel
+      - protocol.babel.channel
+      - protocol.rip.channel
+      - protocol.kernel.channel
+      - protocol.static.channel
+      - protocol.pipe.channel
+      - protocol.ospf.channel
+    related:
+      - import
+      - receive limit
+    parameters:
+      - name: number
+        description: Maximum imported route count.
+      - name: action
+        description: Action when limit is reached, such as warn or block.
+  - keyword: ipv4
+    description: IPv4 channel
+    detail: Define an IPv4 address family channel for route exchange.
+    diff: same
+    version: v2+
+    anchor: channel-opts
+    path:
+      - protocol.bgp
+      - protocol.babel
+      - protocol.rip
+      - protocol.kernel
+      - protocol.static
+      - protocol.pipe
+      - protocol.ospf
+    related:
+      - ipv6
+      - import
+      - export
+  - keyword: ipv6
+    description: IPv6 channel
+    detail: Define an IPv6 address family channel for route exchange.
+    diff: same
+    version: v2+
+    anchor: channel-opts
+    path:
+      - protocol.bgp
+      - protocol.babel
+      - protocol.rip
+      - protocol.kernel
+      - protocol.static
+      - protocol.pipe
+      - protocol.ospf
+    related:
+      - ipv4
+      - import
+      - export
+  - keyword: preference
+    description: Route preference value
+    detail: Set the preference value for routes from this channel. Higher values are preferred.
+    diff: same
+    version: v2+
+    anchor: channel-preference
+    path:
+      - protocol.bgp.channel
+      - protocol.babel.channel
+      - protocol.rip.channel
+      - protocol.kernel.channel
+      - protocol.static.channel
+      - protocol.pipe.channel
+      - protocol.ospf.channel
+    related:
+      - table
+      - import
+      - export
+    parameters:
+      - name: number
+        description: Channel preference value.
+  - keyword: receive limit
+    description: Receive route limit
+    detail: Set maximum number of routes that can be received from the peer.
+    diff: same
+    version: v2+
+    anchor: channel-receive-limit
+    path:
+      - protocol.bgp.channel
+      - protocol.babel.channel
+      - protocol.rip.channel
+      - protocol.kernel.channel
+      - protocol.static.channel
+      - protocol.pipe.channel
+      - protocol.ospf.channel
+    related:
+      - import limit
+      - export limit
+    parameters:
+      - name: number
+        description: Maximum received route count.
+      - name: action
+        description: Action when limit is reached.
+  - keyword: rpki reload
+    description: RPKI reload behavior
+    detail: Configure how routes are reloaded when RPKI validation state changes.
+    diff: modified
+    version: v2-v3
+    anchor: channel-rpki-reload
+    path:
+      - protocol.bgp.channel
+    related:
+      - import
+      - export
+    parameters:
+      - name: switch
+        description: Enable or disable route reload on RPKI state changes.
+    notes:
+      v3: "v3 Enhanced: Supports both ROA and ASPA validation reload."
+  - keyword: table
+    description: Associate channel with routing table
+    detail: Specify which routing table this channel imports to and exports from.
+    diff: same
+    version: v2+
+    anchor: channel-table
+    path:
+      - protocol.bgp.channel
+      - protocol.babel.channel
+      - protocol.rip.channel
+      - protocol.kernel.channel
+      - protocol.static.channel
+      - protocol.pipe.channel
+      - protocol.ospf.channel
+    related:
+      - preference
+      - import
+      - export
+    parameters:
+      - name: table-name
+        description: Target routing table for this channel.

package/dist/hover-docs/40-protocol-common.yaml

@@ -0,0 +1,59 @@
+entries:
+  - keyword: description
+    description: Protocol description
+    detail: Add a human-readable description to the protocol for administrative purposes.
+    diff: same
+    version: v2+
+    anchor: proto-description
+    path: protocol
+    parameters:
+      - name: text
+        description: Human-readable protocol description.
+  - keyword: device
+    description: Device scan protocol
+    detail:
+      Scan network interfaces for link state changes and generate routes for directly connected
+      networks.
+    diff: same
+    version: v2+
+    anchor: proto-device
+  - keyword: direct
+    description: Direct routes protocol
+    detail: Generate routes for directly connected networks based on interface addresses.
+    diff: same
+    version: v2+
+    anchor: proto-direct
+  - keyword: disabled
+    description: Disable protocol on startup
+    detail: Start the protocol in disabled state. Can be enabled later via CLI.
+    diff: same
+    version: v2+
+    anchor: proto-disabled
+    path: protocol
+    parameters:
+      - name: switch
+        description: Enable or disable protocol startup state.
+  - keyword: restart time limit
+    description: Automatic restart time limit (v3 only)
+    detail: Configure automatic restart of the protocol after failure within specified time limit.
+    diff: added
+    version: v3+
+    anchor: proto-restart-time-limit
+    path: protocol
+    related:
+      - disabled
+    parameters:
+      - name: seconds
+        description: Restart deadline before giving up recovery.
+    notes:
+      v3: "v3 only: Automatic protocol restart on failure."
+  - keyword: vrf
+    description: Bind protocol to VRF
+    detail: Associate this protocol with a specific Virtual Routing and Forwarding instance.
+    diff: same
+    version: v2+
+    anchor: proto-vrf
+    path: protocol
+    parameters:
+      - name: vrf-name
+        description: Target VRF instance name.