diff --git a/.github/file-filters.yml b/.github/file-filters.yml index 0c04075..e4128f4 100644 --- a/.github/file-filters.yml +++ b/.github/file-filters.yml @@ -20,6 +20,10 @@ yaml_all: &yaml_all markdown_all: &markdown_all - "**/*.{md,mdx}" +schema_all: &schema_all + - "base/**/*.{yml,yaml}" + - "extensions/**/*.{yml,yaml}" + documentation_all: - *doc_files - *markdown_all diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f72dd9d..38daddb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,5 +1,6 @@ --- # yamllint disable rule:truthy rule:truthy rule:line-length + name: "CI" on: pull_request: @@ -24,6 +25,7 @@ jobs: documentation: ${{ steps.changes.outputs.documentation_all }} markdown: ${{ steps.changes.outputs.markdown_all }} python: ${{ steps.changes.outputs.python_all }} + schema: ${{ steps.changes.outputs.schema_all }} yaml: ${{ steps.changes.outputs.yaml_all }} steps: - name: "Check out repository code" @@ -111,7 +113,7 @@ jobs: always() && !cancelled() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') && - needs.files-changed.outputs.yaml == 'true' + needs.files-changed.outputs.schema == 'true' runs-on: group: huge-runners env: @@ -150,7 +152,8 @@ jobs: if: always() run: uv run invoke destroy - documentation: + check-documentation: + name: Check generated documentation is up to date defaults: run: working-directory: ./docs @@ -158,8 +161,15 @@ jobs: always() && !cancelled() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') && - needs.files-changed.outputs.documentation == 'true' - needs: ["files-changed", "yaml-lint", "python-lint"] + github.event_name == 'pull_request' + needs: + [ + "files-changed", + "yaml-lint", + "python-lint", + "markdown-lint", + "schema-test", + ] runs-on: "ubuntu-22.04" timeout-minutes: 5 steps: @@ -171,7 +181,7 @@ jobs: uses: actions/setup-node@v4 with: node-version: 20 - cache: 'npm' + cache: "npm" cache-dependency-path: docs/package-lock.json - name: "Install uv" uses: "astral-sh/setup-uv@v5" @@ -186,17 +196,21 @@ jobs: - name: "Generate reference documentation" run: "uv run invoke docs.generate" working-directory: ./ - - name: "Build docs website" - run: "uv run invoke docs.build" + - name: "Check for outdated documentation" + run: | + if ! git diff --exit-code -- docs/reference/; then + echo "::error::Generated documentation is out of date. Please run 'invoke docs.generate' locally and commit the changes." + exit 1 + fi working-directory: ./ - validate-documentation-style: + validate-documentation: if: | always() && !cancelled() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') && - needs.files-changed.outputs.documentation == 'true' - needs: ["files-changed", "yaml-lint", "python-lint"] + github.event_name == 'pull_request' + needs: ["check-documentation"] runs-on: "ubuntu-22.04" timeout-minutes: 5 steps: @@ -204,6 +218,25 @@ jobs: uses: "actions/checkout@v4" with: submodules: true + - name: Install NodeJS + uses: actions/setup-node@v4 + with: + node-version: 20 + cache: "npm" + cache-dependency-path: docs/package-lock.json + - name: "Install uv" + uses: "astral-sh/setup-uv@v5" + with: + version: "0.9.18" + - name: "Install Python dependencies" + run: "uv sync" + working-directory: ./ + - name: "Install dependencies" + run: "uv run invoke docs.install" + working-directory: ./ + - name: "Build docs website" + run: "uv run invoke docs.build" + working-directory: ./ # The official GitHub Action for Vale doesn't work, installing manually instead: # https://github.com/errata-ai/vale-action/issues/103 - name: Download Vale diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 6ca8007..84810d6 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,17 +1,28 @@ --- +# Markdownlint configuration +# https://github.com/DavidAnson/markdownlint + default: true + +# MD007/ul-indent - Unordered list indentation MD007: - indent: 4 # sets indent size to 4 spaces -MD013: false # disables max line-length -MD024: false # disables 'no duplicate headings', - # which we use in tabs for instructions + indent: 4 + +# MD013/line-length - Line length (disabled for readability in prose) +MD013: false + +# MD024/no-duplicate-heading - Multiple headings with the same content +# Allow duplicate headings in different sections +MD024: + siblings_only: true + +# MD025/single-title - Multiple top-level headings +# Prevent collisions with h1s and frontmatter titles MD025: - front_matter_title: "" # prevent collisions with h1s - # and frontmatter titles -MD029: false # allows manually creating ordered lists -MD033: false # allows inline html to override markdown styles -MD034: false # no-bare-urls -MD045: false # no alt text around images -MD047: false # single trailing newline -MD014: false # dollar signs used before commands -MD060: false # table column style - disabled for generated tables + front_matter_title: "" + +# MD033/no-inline-html - Inline HTML (disabled for MDX React components) +MD033: false + +# MD060/table-column-style - Table column style (disabled for generated tables) +MD060: false diff --git a/.markdownlintignore b/.markdownlintignore index 57bf93e..a3619d4 100644 --- a/.markdownlintignore +++ b/.markdownlintignore @@ -1,2 +1,3 @@ docs/node_modules/ .venv/ +docs/docs/reference \ No newline at end of file diff --git a/docs/docs/home.mdx b/docs/docs/home.mdx index f456e7a..3ae6df8 100644 --- a/docs/docs/home.mdx +++ b/docs/docs/home.mdx @@ -156,4 +156,4 @@ This error indicates that the schema you are trying to load has dependencies on To resolve this, ensure that you have loaded all required schemas before attempting to load the one in question. You can find the list of dependencies in the schema documentation. -::: \ No newline at end of file +::: diff --git a/docs/docs/reference/azure.mdx b/docs/docs/reference/azure.mdx index 280a9c1..18cf63d 100644 --- a/docs/docs/reference/azure.mdx +++ b/docs/docs/reference/azure.mdx @@ -15,7 +15,6 @@ This schema extension introduces cloud support for Microsoft Azure. ### Location - **Namespace:** Azure -- **Display Labels:** name__value #### Attributes @@ -26,7 +25,6 @@ This schema extension introduces cloud support for Microsoft Azure. ### Tenant - **Namespace:** Azure -- **Display Labels:** name__value, tenant_id__value #### Attributes @@ -44,7 +42,6 @@ This schema extension introduces cloud support for Microsoft Azure. ### Subscription - **Namespace:** Azure -- **Display Labels:** name__value, subscription_id__value #### Attributes @@ -63,7 +60,6 @@ This schema extension introduces cloud support for Microsoft Azure. ### ResourceGroup - **Namespace:** Azure -- **Display Labels:** name__value #### Attributes @@ -82,7 +78,6 @@ This schema extension introduces cloud support for Microsoft Azure. - **Label:** Virtual Networks - **Namespace:** Azure -- **Display Labels:** name__value - **Inherit From:** AzureResource #### Relationships @@ -96,7 +91,6 @@ This schema extension introduces cloud support for Microsoft Azure. - **Label:** Subnets - **Namespace:** Azure -- **Display Labels:** name__value #### Attributes @@ -157,17 +151,14 @@ nodes: - name: Location namespace: Azure menu_placement: AzureResource - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text - name: Tenant namespace: Azure menu_placement: AzureResource - display_labels: - - name__value - - tenant_id__value + display_label: '{{ name__value }} (Tenant ID: {{ tenant_id__value }})' attributes: - name: name kind: Text @@ -181,9 +172,7 @@ nodes: - name: Subscription namespace: Azure menu_placement: AzureResource - display_labels: - - name__value - - subscription_id__value + display_label: '{{ name__value }} (Subscription ID: {{ subscription_id__value }})' attributes: - name: name kind: Text @@ -202,8 +191,7 @@ nodes: - name: ResourceGroup namespace: Azure menu_placement: AzureResource - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text @@ -221,8 +209,7 @@ nodes: label: Virtual Networks namespace: Azure menu_placement: AzureResource - display_labels: - - name__value + display_label: name__value inherit_from: - AzureResource relationships: @@ -239,8 +226,7 @@ nodes: namespace: Azure menu_placement: AzureResource include_in_menu: true - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text diff --git a/docs/docs/reference/circuit.mdx b/docs/docs/reference/circuit.mdx index ac4b26f..e5aa791 100644 --- a/docs/docs/reference/circuit.mdx +++ b/docs/docs/reference/circuit.mdx @@ -18,7 +18,6 @@ This schema extension contains Circuits and ways to connect them with your infra - **Description:** A Circuit represent service operated by a provider. - **Namespace:** Dcim - **Icon:** mdi:cable-data -- **Display Labels:** circuit_id__value - **Human Friendly ID:** circuit_id__value #### Attributes @@ -44,7 +43,6 @@ This schema extension contains Circuits and ways to connect them with your infra - **Description:** A circuit endpoint, could be a position in a MMR... - **Namespace:** Dcim - **Icon:** mdi:ethernet -- **Display Labels:** name__value - **Uniqueness Constraints:** - circuit, name__value - **Human Friendly ID:** circuit__circuit_id__value, name__value @@ -103,8 +101,7 @@ nodes: - circuit_id__value order_by: - circuit_id__value - display_labels: - - circuit_id__value + display_label: circuit_id__value attributes: - name: circuit_id kind: Text @@ -186,8 +183,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text diff --git a/docs/docs/reference/circuit_service.mdx b/docs/docs/reference/circuit_service.mdx index 23a2f4b..b2b0aae 100644 --- a/docs/docs/reference/circuit_service.mdx +++ b/docs/docs/reference/circuit_service.mdx @@ -21,7 +21,6 @@ For example you have a MPLS network supported by a provider connecting multiple - **Description:** Represent the boundary of a provider network, the details of which are unknown or unimportant - **Namespace:** Circuit - **Icon:** mdi:cloud -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -79,8 +78,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text diff --git a/docs/docs/reference/cluster.mdx b/docs/docs/reference/cluster.mdx index 47ae73c..864af9e 100644 --- a/docs/docs/reference/cluster.mdx +++ b/docs/docs/reference/cluster.mdx @@ -18,7 +18,6 @@ This schema extension contains the foundations to capture clusters. With this on - **Description:** A cluster of machines hosting services or other machines. - **Namespace:** Cluster - **Icon:** mdi:dots-hexagon -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -84,8 +83,7 @@ generics: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text diff --git a/docs/docs/reference/cross_connect.mdx b/docs/docs/reference/cross_connect.mdx index 3987e65..5ae365a 100644 --- a/docs/docs/reference/cross_connect.mdx +++ b/docs/docs/reference/cross_connect.mdx @@ -17,7 +17,6 @@ This extension contains schema to capture Cross Connect. You can see it as "a ca - **Description:** Cross-connect between different endpoints within a datacenter. - **Namespace:** Dcim - **Icon:** streamline:arrow-crossover-right-solid -- **Display Labels:** identifier__value - **Uniqueness Constraints:** - identifier__value, provider - **Human Friendly ID:** provider__name__value, identifier__value @@ -52,8 +51,7 @@ nodes: - DcimConnector order_by: - provider__name__value - display_labels: - - identifier__value + display_label: '{{ identifier__value }} (Provider: {{ provider__name__value }})' human_friendly_id: - provider__name__value - identifier__value diff --git a/docs/docs/reference/dcim.mdx b/docs/docs/reference/dcim.mdx index 2f86a5b..9d6691b 100644 --- a/docs/docs/reference/dcim.mdx +++ b/docs/docs/reference/dcim.mdx @@ -16,7 +16,6 @@ Basic DCIM schema to capture devices, racks, interfaces, and related information - **Description:** A model of device - **Namespace:** Dcim - **Icon:** mdi:poll -- **Display Labels:** name__value - **Uniqueness Constraints:** - manufacturer, name__value - **Human Friendly ID:** name__value @@ -46,7 +45,6 @@ Basic DCIM schema to capture devices, racks, interfaces, and related information - **Description:** A Platform represent the type of software running on a device. - **Namespace:** Dcim - **Icon:** mdi:application-cog-outline -- **Display Labels:** name__value - **Uniqueness Constraints:** - name__value - **Human Friendly ID:** name__value @@ -113,7 +111,6 @@ Basic DCIM schema to capture devices, racks, interfaces, and related information - **Description:** Generic Device object. - **Namespace:** Dcim - **Icon:** mdi:server -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -180,7 +177,6 @@ Basic DCIM schema to capture devices, racks, interfaces, and related information - **Label:** Interface - **Description:** Generic Network Interface - **Namespace:** Dcim -- **Display Labels:** name__value - **Uniqueness Constraints:** - device, name__value - **Human Friendly ID:** device__name__value, name__value @@ -258,8 +254,7 @@ generics: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text @@ -370,8 +365,7 @@ generics: description: Generic Network Interface label: Interface include_in_menu: false - display_labels: - - name__value + display_label: name__value order_by: - device__name__value - name__value @@ -548,8 +542,7 @@ nodes: icon: mdi:poll human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value order_by: - manufacturer__name__value - name__value @@ -611,8 +604,7 @@ nodes: icon: mdi:application-cog-outline human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value order_by: - manufacturer__name__value - name__value diff --git a/docs/docs/reference/dwdm.mdx b/docs/docs/reference/dwdm.mdx index 0cfd2cd..db6c99c 100644 --- a/docs/docs/reference/dwdm.mdx +++ b/docs/docs/reference/dwdm.mdx @@ -18,7 +18,6 @@ This schema extension contains models for OADM (Optical Add Drop Multiplexer) su - **Description:** An OADM (Optical Add Drop Multiplexer) supporting various WDM (Wavelength Division Multiplexing) technologies. - **Namespace:** Dcim - **Icon:** mdi:transit-connection-variant -- **Display Labels:** name__value - **Human Friendly ID:** name__value - **Inherit From:** DcimPhysicalDevice @@ -41,7 +40,6 @@ This schema extension contains models for OADM (Optical Add Drop Multiplexer) su - **Label:** Optical Multiplexer Front Interfaces - **Namespace:** Dcim -- **Display Labels:** name__value - **Uniqueness Constraints:** - optical_multiplexer, name__value - **Human Friendly ID:** optical_multiplexer__name__value, name__value @@ -58,7 +56,6 @@ This schema extension contains models for OADM (Optical Add Drop Multiplexer) su - **Label:** Optical Multiplexer Rear Interfaces - **Namespace:** Dcim -- **Display Labels:** name__value - **Uniqueness Constraints:** - optical_multiplexer, name__value - **Human Friendly ID:** optical_multiplexer__name__value, name__value @@ -76,7 +73,6 @@ This schema extension contains models for OADM (Optical Add Drop Multiplexer) su - **Description:** A WDM channel with its wavelength and frequency. - **Namespace:** Dcim - **Icon:** game-icons:laser-warning -- **Display Labels:** wdm_type__value, channel__value - **Uniqueness Constraints:** - frequency__value, wavelength__value, channel__value, wdm_type__value - channel__value, wdm_type__value @@ -244,8 +240,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value inherit_from: - DcimPhysicalDevice attributes: @@ -293,8 +288,7 @@ nodes: human_friendly_id: - optical_multiplexer__name__value - name__value - display_labels: - - name__value + display_label: '{{ optical_multiplexer__name__value }} > {{ name__value }}' order_by: - optical_multiplexer__name__value - name__value @@ -325,8 +319,7 @@ nodes: human_friendly_id: - optical_multiplexer__name__value - name__value - display_labels: - - name__value + display_label: '{{ optical_multiplexer__name__value }} > {{ name__value }}' order_by: - optical_multiplexer__name__value - name__value @@ -352,9 +345,7 @@ nodes: order_by: - wdm_type__value - channel__value - display_labels: - - wdm_type__value - - channel__value + display_label: '{{ wdm_type__value }} Channel {{ channel__value }}' uniqueness_constraints: - - frequency__value - wavelength__value diff --git a/docs/docs/reference/firewall_policer.mdx b/docs/docs/reference/firewall_policer.mdx index 2c868fd..da563f6 100644 --- a/docs/docs/reference/firewall_policer.mdx +++ b/docs/docs/reference/firewall_policer.mdx @@ -17,7 +17,6 @@ This schema extension contains models for VMs. You might consider Cluster or/and - **Description:** A generic policer configuration. - **Namespace:** Security - **Icon:** mdi:car-speed-limiter -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -43,8 +42,7 @@ nodes: label: Network Policer icon: mdi:car-speed-limiter description: A generic policer configuration. - display_labels: - - name__value + display_label: name__value order_by: - name__value human_friendly_id: diff --git a/docs/docs/reference/infiniband.mdx b/docs/docs/reference/infiniband.mdx index b0f0f58..8adf165 100644 --- a/docs/docs/reference/infiniband.mdx +++ b/docs/docs/reference/infiniband.mdx @@ -18,7 +18,6 @@ This schema extension adds support for InfiniBand switches. - **Description:** InfiniBand Switch - **Namespace:** Infiniband - **Icon:** mdi:server -- **Display Labels:** name__value - **Inherit From:** CoreArtifactTarget #### Attributes @@ -54,7 +53,6 @@ This schema extension adds support for InfiniBand switches. - **Description:** InfiniBand Switch Interface - **Namespace:** Infiniband - **Icon:** mdi:ethernet -- **Display Labels:** name__value - **Uniqueness Constraints:** - switch, name__value - **Human Friendly ID:** switch__name__value, name__value @@ -89,7 +87,6 @@ This schema extension adds support for InfiniBand switches. - **Description:** InfiniBand Switch Management Interface - **Namespace:** Infiniband - **Icon:** mdi:ethernet -- **Display Labels:** name__value - **Uniqueness Constraints:** - switch, name__value - **Human Friendly ID:** switch__name__value, name__value @@ -118,7 +115,6 @@ This schema extension adds support for InfiniBand switches. - **Description:** InfiniBand Interface Speed Options - **Namespace:** Infiniband - **Icon:** mdi:ethernet -- **Display Labels:** speed__value - **Human Friendly ID:** description__value #### Attributes @@ -140,7 +136,6 @@ This schema extension adds support for InfiniBand switches. - **Description:** InfiniBand Rail-Optimized Scalable Unit - **Namespace:** Infiniband - **Icon:** mdi:network -- **Display Labels:** identifier__value - **Uniqueness Constraints:** - identifier__value @@ -164,7 +159,6 @@ This schema extension adds support for InfiniBand switches. - **Description:** InfiniBand Network Fabric - **Namespace:** Infiniband - **Icon:** mdi:network -- **Display Labels:** name__value - **Human Friendly ID:** name__value - **Inherit From:** CoreArtifactTarget @@ -188,8 +182,7 @@ nodes: - CoreArtifactTarget order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text @@ -312,8 +305,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value uniqueness_constraints: - - switch - name__value @@ -428,8 +420,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value uniqueness_constraints: - - switch - name__value @@ -477,8 +468,7 @@ nodes: - description__value order_by: - speed__value - display_labels: - - speed__value + display_label: speed__value attributes: - name: speed kind: Dropdown @@ -515,8 +505,7 @@ nodes: icon: mdi:network order_by: - identifier__value - display_labels: - - identifier__value + display_label: identifier__value uniqueness_constraints: - - identifier__value attributes: @@ -552,8 +541,7 @@ nodes: - CoreArtifactTarget order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text diff --git a/docs/docs/reference/ipam.mdx b/docs/docs/reference/ipam.mdx index 3131a7c..a332b9c 100644 --- a/docs/docs/reference/ipam.mdx +++ b/docs/docs/reference/ipam.mdx @@ -16,7 +16,6 @@ Basic IPAM schema to capture IP addresses, subnets, and related information. - **Description:** IP Address - **Namespace:** Ipam - **Icon:** mdi:ip -- **Display Labels:** address__value - **Uniqueness Constraints:** - address__value, ip_namespace - **Human Friendly ID:** address__value, ip_namespace__name__value @@ -40,7 +39,6 @@ Basic IPAM schema to capture IP addresses, subnets, and related information. - **Description:** IPv4 or IPv6 network (with mask) - **Namespace:** Ipam - **Icon:** mdi:ip-network -- **Display Labels:** prefix__value - **Uniqueness Constraints:** - prefix__value, ip_namespace - **Human Friendly ID:** prefix__value, ip_namespace__name__value @@ -74,8 +72,7 @@ nodes: include_in_menu: false order_by: - address__value - display_labels: - - address__value + display_label: address__value inherit_from: - BuiltinIPAddress uniqueness_constraints: @@ -103,8 +100,7 @@ nodes: label: Prefix order_by: - prefix__value - display_labels: - - prefix__value + display_label: prefix__value inherit_from: - BuiltinIPPrefix uniqueness_constraints: diff --git a/docs/docs/reference/location.mdx b/docs/docs/reference/location.mdx index 713169c..46306a3 100644 --- a/docs/docs/reference/location.mdx +++ b/docs/docs/reference/location.mdx @@ -16,7 +16,6 @@ Basic Location schema to capture locations, sites, and related information. - **Description:** Generic Location, could be a country, city ... - **Namespace:** Location - **Icon:** mingcute:location-line -- **Display Labels:** name__value - **Human Friendly ID:** shortname__value #### Attributes @@ -37,6 +36,13 @@ Basic Location schema to capture locations, sites, and related information. - **Description:** Location directly hosting device and services. - **Namespace:** Location +- **Human Friendly ID:** shortname__value + +#### Attributes + +| name | description | kind | optional | default_value | choices | +| ---- | ----------- | ---- | -------- | ------------- | ------- | +| shortname | | Text | | | | #### Relationships @@ -61,8 +67,7 @@ generics: - shortname__value order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text @@ -85,6 +90,13 @@ generics: namespace: Location description: Location directly hosting device and services. include_in_menu: false + human_friendly_id: + - shortname__value + attributes: + - name: shortname + kind: Text + unique: true + order_weight: 1100 relationships: - name: prefixes label: Prefixes diff --git a/docs/docs/reference/location_extended.mdx b/docs/docs/reference/location_extended.mdx index 4d59a55..6ecfa3c 100644 --- a/docs/docs/reference/location_extended.mdx +++ b/docs/docs/reference/location_extended.mdx @@ -16,7 +16,6 @@ This schema extension is the most detailed when it comes to location, you'll fin - **Label:** Continent - **Namespace:** Location - **Icon:** jam:world -- **Display Labels:** name__value - **Inherit From:** LocationGeneric ### Country @@ -24,7 +23,6 @@ This schema extension is the most detailed when it comes to location, you'll fin - **Label:** Country - **Namespace:** Location - **Icon:** gis:search-country -- **Display Labels:** name__value - **Inherit From:** LocationGeneric ### Region @@ -32,7 +30,6 @@ This schema extension is the most detailed when it comes to location, you'll fin - **Label:** Region - **Namespace:** Location - **Icon:** carbon:cics-region-target -- **Display Labels:** name__value - **Inherit From:** LocationGeneric ### Metro @@ -40,7 +37,6 @@ This schema extension is the most detailed when it comes to location, you'll fin - **Label:** Metro - **Namespace:** Location - **Icon:** healthicons:city -- **Display Labels:** name__value - **Inherit From:** LocationGeneric ### Building @@ -48,7 +44,6 @@ This schema extension is the most detailed when it comes to location, you'll fin - **Label:** Building - **Namespace:** Location - **Icon:** ri:building-line -- **Display Labels:** name__value - **Inherit From:** LocationGeneric #### Attributes @@ -69,7 +64,6 @@ This schema extension is the most detailed when it comes to location, you'll fin - **Label:** Floor - **Namespace:** Location - **Icon:** mdi:home-floor-0 -- **Display Labels:** name__value - **Inherit From:** LocationGeneric ### Suite @@ -77,7 +71,6 @@ This schema extension is the most detailed when it comes to location, you'll fin - **Label:** Suite - **Namespace:** Location - **Icon:** game-icons:cage -- **Display Labels:** name__value - **Inherit From:** LocationGeneric #### Attributes @@ -97,7 +90,6 @@ This schema extension is the most detailed when it comes to location, you'll fin - **Label:** Rack - **Namespace:** Location - **Icon:** clarity:rack-server-line -- **Display Labels:** name__value - **Human Friendly ID:** shortname__value - **Inherit From:** LocationGeneric @@ -141,8 +133,7 @@ nodes: include_in_menu: true menu_placement: LocationGeneric label: Continent - display_labels: - - name__value + display_label: name__value parent: '' children: LocationCountry icon: jam:world @@ -153,8 +144,7 @@ nodes: include_in_menu: true menu_placement: LocationGeneric label: Country - display_labels: - - name__value + display_label: name__value parent: LocationContinent children: LocationRegion icon: gis:search-country @@ -165,8 +155,7 @@ nodes: include_in_menu: true menu_placement: LocationGeneric label: Region - display_labels: - - name__value + display_label: name__value parent: LocationCountry children: LocationMetro icon: carbon:cics-region-target @@ -177,8 +166,7 @@ nodes: include_in_menu: true menu_placement: LocationGeneric label: Metro - display_labels: - - name__value + display_label: name__value parent: LocationRegion children: LocationBuilding icon: healthicons:city @@ -189,8 +177,7 @@ nodes: include_in_menu: true menu_placement: LocationGeneric label: Building - display_labels: - - name__value + display_label: name__value parent: LocationMetro children: LocationFloor icon: ri:building-line @@ -217,8 +204,7 @@ nodes: include_in_menu: true menu_placement: LocationGeneric label: Floor - display_labels: - - name__value + display_label: name__value parent: LocationBuilding icon: mdi:home-floor-0 children: LocationSuite @@ -229,8 +215,7 @@ nodes: include_in_menu: true menu_placement: LocationGeneric label: Suite - display_labels: - - name__value + display_label: name__value parent: LocationFloor children: LocationRack icon: game-icons:cage @@ -252,8 +237,7 @@ nodes: include_in_menu: true menu_placement: LocationGeneric label: Rack - display_labels: - - name__value + display_label: name__value human_friendly_id: - shortname__value parent: LocationSuite diff --git a/docs/docs/reference/location_minimal.mdx b/docs/docs/reference/location_minimal.mdx index 9692b98..4a00aaf 100644 --- a/docs/docs/reference/location_minimal.mdx +++ b/docs/docs/reference/location_minimal.mdx @@ -16,7 +16,6 @@ This schema extension is minimal but will provide you with basic items to store - **Label:** Country - **Namespace:** Location - **Icon:** gis:search-country -- **Display Labels:** name__value - **Inherit From:** LocationGeneric #### Attributes @@ -30,7 +29,6 @@ This schema extension is minimal but will provide you with basic items to store - **Label:** Metro - **Namespace:** Location - **Icon:** healthicons:city -- **Display Labels:** name__value - **Inherit From:** LocationGeneric ### Site @@ -38,7 +36,6 @@ This schema extension is minimal but will provide you with basic items to store - **Label:** Site - **Namespace:** Location - **Icon:** ri:building-line -- **Display Labels:** name__value - **Inherit From:** LocationGeneric, LocationHosting #### Attributes @@ -59,7 +56,6 @@ This schema extension is minimal but will provide you with basic items to store - **Label:** Rack - **Namespace:** Location - **Icon:** clarity:rack-server-line -- **Display Labels:** name__value - **Inherit From:** LocationGeneric, LocationHosting #### Attributes @@ -102,8 +98,7 @@ nodes: inherit_from: - LocationGeneric menu_placement: LocationGeneric - display_labels: - - name__value + display_label: name__value parent: '' children: LocationMetro icon: gis:search-country @@ -118,8 +113,7 @@ nodes: inherit_from: - LocationGeneric menu_placement: LocationGeneric - display_labels: - - name__value + display_label: name__value parent: LocationCountry children: LocationSite icon: healthicons:city @@ -130,8 +124,7 @@ nodes: - LocationGeneric - LocationHosting menu_placement: LocationGeneric - display_labels: - - name__value + display_label: name__value parent: LocationMetro children: LocationRack icon: ri:building-line @@ -158,8 +151,7 @@ nodes: - LocationGeneric - LocationHosting include_in_menu: true - display_labels: - - name__value + display_label: name__value menu_placement: LocationGeneric parent: LocationSite icon: clarity:rack-server-line diff --git a/docs/docs/reference/mlag.mdx b/docs/docs/reference/mlag.mdx index 231533c..bca3917 100644 --- a/docs/docs/reference/mlag.mdx +++ b/docs/docs/reference/mlag.mdx @@ -26,7 +26,6 @@ Next steps: - **Label:** MLAG Interface - **Description:** Multi-Chassis Link Aggregation Group Interface - **Namespace:** Mlag -- **Display Labels:** name__value - **Uniqueness Constraints:** - mlag_domain, name__value - **Human Friendly ID:** mlag_domain__domain_id__value, name__value @@ -68,7 +67,6 @@ Next steps: - **Label:** MLAG Domain - **Namespace:** Generic -- **Display Labels:** domain_id__value - **Human Friendly ID:** domain_id__value #### Attributes @@ -118,8 +116,7 @@ generics: namespace: Generic include_in_menu: false label: MLAG Domain - display_labels: - - domain_id__value + display_label: domain_id__value human_friendly_id: - domain_id__value attributes: @@ -168,8 +165,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text diff --git a/docs/docs/reference/modules.mdx b/docs/docs/reference/modules.mdx index af47998..615d48d 100644 --- a/docs/docs/reference/modules.mdx +++ b/docs/docs/reference/modules.mdx @@ -19,7 +19,6 @@ NOTE: This extension doesn't contain any Nodes, you can use the extension module - **Description:** A generic module, such as a Linecard or Routing Engine, installed in a device. - **Namespace:** Device - **Icon:** mdi:expansion-card -- **Display Labels:** serial_number__value - **Human Friendly ID:** serial_number__value #### Attributes @@ -43,7 +42,6 @@ NOTE: This extension doesn't contain any Nodes, you can use the extension module - **Description:** A generic module type, with common specifications like part number and manufacturer. - **Namespace:** Device - **Icon:** mdi:database-cog -- **Display Labels:** name__value - **Uniqueness Constraints:** - name__value, manufacturer - **Human Friendly ID:** name__value @@ -92,8 +90,7 @@ generics: icon: mdi:expansion-card human_friendly_id: - serial_number__value - display_labels: - - serial_number__value + display_label: serial_number__value order_by: - serial_number__value attributes: @@ -153,8 +150,7 @@ generics: label: Module Type icon: mdi:database-cog menu_placement: DeviceGenericModule - display_labels: - - name__value + display_label: name__value uniqueness_constraints: - - name__value - manufacturer diff --git a/docs/docs/reference/modules_linecards.mdx b/docs/docs/reference/modules_linecards.mdx index 4248bac..d741b7a 100644 --- a/docs/docs/reference/modules_linecards.mdx +++ b/docs/docs/reference/modules_linecards.mdx @@ -54,7 +54,6 @@ This schema extension allows you to capture Linecard related information like th - **Description:** Physical Interface Card (PIC) installed in the Linecard, containing multiple ports. - **Namespace:** Device - **Icon:** mdi:memory -- **Display Labels:** serial_number__value - **Uniqueness Constraints:** - linecard, slot__value - **Human Friendly ID:** serial_number__value @@ -79,7 +78,6 @@ This schema extension allows you to capture Linecard related information like th - **Description:** A network port on a PIC, specifying speed and port number. - **Namespace:** Device - **Icon:** mdi:ethernet -- **Display Labels:** port_number__value - **Uniqueness Constraints:** - pic, port_number__value - **Human Friendly ID:** pic__serial_number__value, port_number__value @@ -165,8 +163,7 @@ nodes: - slot__value human_friendly_id: - serial_number__value - display_labels: - - serial_number__value + display_label: serial_number__value order_by: - linecard__serial_number__value attributes: @@ -207,8 +204,7 @@ nodes: human_friendly_id: - pic__serial_number__value - port_number__value - display_labels: - - port_number__value + display_label: port_number__value order_by: - pic__serial_number__value attributes: diff --git a/docs/docs/reference/modules_routing_engine.mdx b/docs/docs/reference/modules_routing_engine.mdx index d4c98eb..29e71a7 100644 --- a/docs/docs/reference/modules_routing_engine.mdx +++ b/docs/docs/reference/modules_routing_engine.mdx @@ -31,7 +31,6 @@ This schema extension allows you to capture Routing Engine related information l - **Description:** A Routing Engine (RE) installed in a device, responsible for routing functionalities. - **Namespace:** Device - **Icon:** mdi:cpu-64-bit -- **Display Labels:** serial_number__value - **Uniqueness Constraints:** - serial_number__value - **Human Friendly ID:** device__name__value, slot__value @@ -84,8 +83,7 @@ nodes: order_by: - device__name__value - slot__value - display_labels: - - serial_number__value + display_label: serial_number__value attributes: - name: slot kind: Number diff --git a/docs/docs/reference/organization.mdx b/docs/docs/reference/organization.mdx index ad9ed8f..4c61d2c 100644 --- a/docs/docs/reference/organization.mdx +++ b/docs/docs/reference/organization.mdx @@ -39,7 +39,6 @@ Basic Organization schema to capture organizations, vendors, and related informa - **Description:** An organization represent a legal entity, a company. - **Namespace:** Organization - **Icon:** mdi:domain -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -68,8 +67,7 @@ generics: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value icon: mdi:domain include_in_menu: true attributes: diff --git a/docs/docs/reference/patch_panel.mdx b/docs/docs/reference/patch_panel.mdx index cecd1d7..563e4ce 100644 --- a/docs/docs/reference/patch_panel.mdx +++ b/docs/docs/reference/patch_panel.mdx @@ -19,7 +19,6 @@ NOTE: This extension is compatible with all sort of connectors, meaning you can - **Description:** A Patch Panel used for managing network cable connections in a data center or telecom setup. - **Namespace:** Dcim - **Icon:** ic:round-device-hub -- **Display Labels:** name__value - **Human Friendly ID:** name__value - **Inherit From:** DcimPhysicalDevice @@ -43,7 +42,6 @@ NOTE: This extension is compatible with all sort of connectors, meaning you can - **Label:** Patch Panel Front Interfaces - **Namespace:** Dcim -- **Display Labels:** name__value - **Uniqueness Constraints:** - patch_panel, name__value - **Human Friendly ID:** patch_panel__name__value, name__value @@ -60,7 +58,6 @@ NOTE: This extension is compatible with all sort of connectors, meaning you can - **Label:** Patch Panel Rear Interfaces - **Namespace:** Dcim -- **Display Labels:** name__value - **Uniqueness Constraints:** - patch_panel, name__value - **Human Friendly ID:** patch_panel__name__value, name__value @@ -78,7 +75,6 @@ NOTE: This extension is compatible with all sort of connectors, meaning you can - **Label:** Patch Panel Module - **Namespace:** Dcim - **Icon:** mdi:expansion-card -- **Display Labels:** name__value - **Uniqueness Constraints:** - patch_panel, position__value - **Human Friendly ID:** patch_panel__name__value, name__value @@ -232,8 +228,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value inherit_from: - DcimPhysicalDevice attributes: @@ -277,8 +272,7 @@ nodes: human_friendly_id: - patch_panel__name__value - name__value - display_labels: - - name__value + display_label: '{{ patch_panel__name__value }} > {{ name__value }}' order_by: - corresponding_front_rear__name__value - name__value @@ -310,8 +304,7 @@ nodes: human_friendly_id: - patch_panel__name__value - name__value - display_labels: - - name__value + display_label: '{{ patch_panel__name__value }} > {{ name__value }}' order_by: - patch_panel__name__value - name__value @@ -344,8 +337,7 @@ nodes: human_friendly_id: - patch_panel__name__value - name__value - display_labels: - - name__value + display_label: '{{ patch_panel__name__value }} > {{ name__value }}' order_by: - patch_panel__name__value - position__value diff --git a/docs/docs/reference/peering_ixp.mdx b/docs/docs/reference/peering_ixp.mdx index 6c2f580..debf679 100644 --- a/docs/docs/reference/peering_ixp.mdx +++ b/docs/docs/reference/peering_ixp.mdx @@ -20,7 +20,6 @@ This schema extension contains all you need to model anything revolving around i - **Description:** An Internet Exchange Point (IXP) for peering - **Namespace:** Peering - **Icon:** mdi:network -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -48,7 +47,6 @@ This schema extension contains all you need to model anything revolving around i - **Description:** A connection to an Internet Exchange Point (IXP) - **Namespace:** Peering - **Icon:** mdi:lan-connect -- **Display Labels:** name__value - **Uniqueness Constraints:** - name__value - **Human Friendly ID:** name__value @@ -88,8 +86,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text @@ -168,8 +165,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text diff --git a/docs/docs/reference/physical_disk.mdx b/docs/docs/reference/physical_disk.mdx index bea4d20..bab4560 100644 --- a/docs/docs/reference/physical_disk.mdx +++ b/docs/docs/reference/physical_disk.mdx @@ -19,7 +19,6 @@ NOTE: This extension is compatible with all sort of device. You can apply the ge - **Description:** Physical Disk - **Namespace:** Dcim - **Icon:** carbon:vmdk-disk -- **Display Labels:** name__value - **Uniqueness Constraints:** - device, name__value - **Human Friendly ID:** name__value @@ -78,8 +77,7 @@ nodes: icon: carbon:vmdk-disk order_by: - name__value - display_labels: - - name__value + display_label: name__value human_friendly_id: - name__value uniqueness_constraints: diff --git a/docs/docs/reference/qos.mdx b/docs/docs/reference/qos.mdx index 6f53da0..61e7848 100644 --- a/docs/docs/reference/qos.mdx +++ b/docs/docs/reference/qos.mdx @@ -16,7 +16,6 @@ This schema extension contains models for Quality of Service (QoS) - **Label:** Forwarding Class - **Description:** Represents a forwarding class in QoS with distinct loss priorities. - **Namespace:** Qos -- **Display Labels:** name__value - **Uniqueness Constraints:** - name__value - **Human Friendly ID:** name__value @@ -34,7 +33,6 @@ This schema extension contains models for Quality of Service (QoS) - **Label:** Class of Service - **Description:** Defines a Class of Service configuration. - **Namespace:** Qos -- **Display Labels:** name__value - **Uniqueness Constraints:** - name__value - **Human Friendly ID:** name__value @@ -56,7 +54,6 @@ This schema extension contains models for Quality of Service (QoS) - **Label:** Traffic Control Profile - **Description:** Defines a traffic control profile with an active/inactive state. - **Namespace:** Qos -- **Display Labels:** name__value - **Uniqueness Constraints:** - name__value - **Human Friendly ID:** name__value @@ -73,7 +70,6 @@ This schema extension contains models for Quality of Service (QoS) - **Label:** Classifier - **Description:** Represents a classifier mapping DSCP or EXP values to forwarding classes. - **Namespace:** Qos -- **Display Labels:** name__value - **Uniqueness Constraints:** - name__value - **Human Friendly ID:** name__value @@ -96,7 +92,6 @@ This schema extension contains models for Quality of Service (QoS) - **Label:** Scheduler - **Description:** Represents a scheduler configuration. - **Namespace:** Qos -- **Display Labels:** name__value - **Uniqueness Constraints:** - name__value - **Human Friendly ID:** name__value @@ -116,7 +111,6 @@ This schema extension contains models for Quality of Service (QoS) - **Label:** Scheduler Map - **Description:** Defines mappings of schedulers to forwarding classes. - **Namespace:** Qos -- **Display Labels:** name__value - **Uniqueness Constraints:** - name__value - **Human Friendly ID:** name__value @@ -143,8 +137,7 @@ nodes: namespace: Qos label: Forwarding Class description: Represents a forwarding class in QoS with distinct loss priorities. - display_labels: - - name__value + display_label: name__value order_by: - name__value human_friendly_id: @@ -172,8 +165,7 @@ nodes: namespace: Qos label: Class of Service description: Defines a Class of Service configuration. - display_labels: - - name__value + display_label: name__value order_by: - name__value human_friendly_id: @@ -197,8 +189,7 @@ nodes: namespace: Qos label: Traffic Control Profile description: Defines a traffic control profile with an active/inactive state. - display_labels: - - name__value + display_label: name__value order_by: - name__value human_friendly_id: @@ -226,8 +217,7 @@ nodes: namespace: Qos label: Classifier description: Represents a classifier mapping DSCP or EXP values to forwarding classes. - display_labels: - - name__value + display_label: name__value order_by: - name__value human_friendly_id: @@ -263,8 +253,7 @@ nodes: namespace: Qos label: Scheduler description: Represents a scheduler configuration. - display_labels: - - name__value + display_label: name__value order_by: - name__value human_friendly_id: @@ -314,8 +303,7 @@ nodes: namespace: Qos label: Scheduler Map description: Defines mappings of schedulers to forwarding classes. - display_labels: - - name__value + display_label: name__value order_by: - name__value human_friendly_id: diff --git a/docs/docs/reference/routing_bgp.mdx b/docs/docs/reference/routing_bgp.mdx index e6a7c44..1a95566 100644 --- a/docs/docs/reference/routing_bgp.mdx +++ b/docs/docs/reference/routing_bgp.mdx @@ -18,7 +18,6 @@ This schema extension contains all you need to model your BGP platform. - **Description:** An Autonomous System (AS) is a set of Internet routable IP prefixes belonging to a network - **Namespace:** Routing - **Icon:** mdi:bank-circle-outline -- **Display Labels:** asn__value, name__value - **Human Friendly ID:** asn__value, name__value #### Attributes @@ -43,7 +42,6 @@ This schema extension contains all you need to model your BGP platform. - **Description:** A BGP Peer Group is used to regroup parameters that are shared across multiple peers - **Namespace:** Routing - **Icon:** mdi:view-grid-plus-outline -- **Display Labels:** name__value, description__value - **Human Friendly ID:** name__value, description__value - **Inherit From:** RoutingProtocol @@ -72,7 +70,6 @@ This schema extension contains all you need to model your BGP platform. - **Description:** A BGP Session represent a point to point connection between two routers - **Namespace:** Routing - **Icon:** mdi:router -- **Display Labels:** description__value - **Inherit From:** RoutingProtocol #### Attributes @@ -139,9 +136,7 @@ nodes: order_by: - asn__value - name__value - display_labels: - - asn__value - - name__value + display_label: 'AS {{ asn__value }}: {{ name__value }}' attributes: - name: name kind: Text @@ -188,9 +183,7 @@ nodes: - description__value order_by: - name__value - display_labels: - - name__value - - description__value + display_label: '{{ name__value }} - {{ description__value }}' attributes: - name: name kind: Text @@ -260,8 +253,7 @@ nodes: - RoutingProtocol order_by: - remote_as__asn__value - display_labels: - - description__value + display_label: description__value attributes: - name: import_policies kind: Text diff --git a/docs/docs/reference/routing_bgp_community.mdx b/docs/docs/reference/routing_bgp_community.mdx index ffe4b41..c879687 100644 --- a/docs/docs/reference/routing_bgp_community.mdx +++ b/docs/docs/reference/routing_bgp_community.mdx @@ -18,7 +18,6 @@ This schema extension adds the BGP Communities models. - **Description:** Defines a BGP community. - **Namespace:** Routing - **Icon:** iconoir:community -- **Display Labels:** name__value, community__value - **Human Friendly ID:** name__value #### Attributes @@ -50,9 +49,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value - - community__value + display_label: '{{ name__value }} ({{ community__value }})' attributes: - name: name kind: Text diff --git a/docs/docs/reference/routing_bgp_rr.mdx b/docs/docs/reference/routing_bgp_rr.mdx index f796ed6..8d006af 100644 --- a/docs/docs/reference/routing_bgp_rr.mdx +++ b/docs/docs/reference/routing_bgp_rr.mdx @@ -19,7 +19,6 @@ This schema extension extend the BGP extension to add BGP Route Reflector Cluste - **Description:** A Route Reflector (RR) Cluster used for grouping internal peers - **Namespace:** Routing - **Icon:** mdi:router-network -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -65,8 +64,7 @@ nodes: include_in_menu: false human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text diff --git a/docs/docs/reference/routing_ospf.mdx b/docs/docs/reference/routing_ospf.mdx index 9543401..ff7079c 100644 --- a/docs/docs/reference/routing_ospf.mdx +++ b/docs/docs/reference/routing_ospf.mdx @@ -18,7 +18,6 @@ This schema extension contains all you need to model the OSPF Routing Protocol. - **Description:** OSPF (Open Shortest Path First) instance on a Virtual Router. - **Namespace:** Routing - **Icon:** mdi:network-outline -- **Display Labels:** description__value - **Uniqueness Constraints:** - device, vrf, version__value - **Human Friendly ID:** device__name__value, vrf__name__value, version__value @@ -46,7 +45,6 @@ This schema extension contains all you need to model the OSPF Routing Protocol. - **Description:** Pivot table linking OSPF configuration to an interface. - **Namespace:** Routing - **Icon:** mdi:ethernet -- **Display Labels:** description__value - **Uniqueness Constraints:** - ospf, interface - **Human Friendly ID:** description__value @@ -92,8 +90,7 @@ nodes: - device__name__value - vrf__name__value - version__value - display_labels: - - description__value + display_label: description__value inherit_from: - RoutingProtocol attributes: @@ -146,8 +143,7 @@ nodes: include_in_menu: false order_by: - description__value - display_labels: - - description__value + display_label: description__value uniqueness_constraints: - - ospf - interface diff --git a/docs/docs/reference/routing_pim.mdx b/docs/docs/reference/routing_pim.mdx index ab03abb..c989332 100644 --- a/docs/docs/reference/routing_pim.mdx +++ b/docs/docs/reference/routing_pim.mdx @@ -18,7 +18,6 @@ This schema extension contains all you need to model the PIM Protocol. - **Description:** Protocol Independent Multicast (PIM) instance on a Virtual Router. - **Namespace:** Routing - **Icon:** mdi:network-outline -- **Display Labels:** description__value - **Uniqueness Constraints:** - device, vrf - **Human Friendly ID:** device__name__value, vrf__name__value @@ -45,7 +44,6 @@ This schema extension contains all you need to model the PIM Protocol. - **Description:** Interface configuration for PIM. - **Namespace:** Routing - **Icon:** mdi:ethernet -- **Display Labels:** description__value - **Uniqueness Constraints:** - pim, interface - **Human Friendly ID:** description__value @@ -88,8 +86,7 @@ nodes: human_friendly_id: - device__name__value - vrf__name__value - display_labels: - - description__value + display_label: description__value attributes: - name: dr_priority kind: Number @@ -127,8 +124,7 @@ nodes: include_in_menu: false order_by: - description__value - display_labels: - - description__value + display_label: description__value uniqueness_constraints: - - pim - interface diff --git a/docs/docs/reference/routing_policies.mdx b/docs/docs/reference/routing_policies.mdx index 45286f7..c2dbe9a 100644 --- a/docs/docs/reference/routing_policies.mdx +++ b/docs/docs/reference/routing_policies.mdx @@ -16,7 +16,6 @@ This schema extension contains a generic to create Routing Policies. This Generi - **Description:** Policy defining the rules for routing traffic in a network. - **Namespace:** Routing - **Icon:** carbon:deployment-policy -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -43,8 +42,7 @@ generics: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text diff --git a/docs/docs/reference/security.mdx b/docs/docs/reference/security.mdx index 79cd50d..8ebd3c9 100644 --- a/docs/docs/reference/security.mdx +++ b/docs/docs/reference/security.mdx @@ -17,7 +17,6 @@ This schema extension contains models for implementing detailed security. - **Description:** Security zones - **Namespace:** Security - **Icon:** game-icons:fire-zone -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -80,7 +79,6 @@ This schema extension contains models for implementing detailed security. - **Description:** IPv4/6 address - **Namespace:** Security - **Icon:** mdi:ip-outline -- **Display Labels:** name__value, address__value - **Human Friendly ID:** name__value - **Inherit From:** SecurityGenericAddress @@ -97,7 +95,6 @@ This schema extension contains models for implementing detailed security. - **Description:** IPv4/6 prefix - **Namespace:** Security - **Icon:** mdi:ip-network-outline -- **Display Labels:** name__value, prefix__value - **Human Friendly ID:** name__value - **Inherit From:** SecurityGenericAddress @@ -114,7 +111,6 @@ This schema extension contains models for implementing detailed security. - **Description:** IPv4/6 Range - **Namespace:** Security - **Icon:** mdi:ip-outline -- **Display Labels:** name__value - **Human Friendly ID:** name__value - **Inherit From:** SecurityGenericAddress @@ -131,7 +127,6 @@ This schema extension contains models for implementing detailed security. - **Description:** Full Qualified Domain Name - **Namespace:** Security - **Icon:** eos-icons:dns -- **Display Labels:** name__value - **Human Friendly ID:** name__value - **Inherit From:** SecurityGenericAddress @@ -147,7 +142,6 @@ This schema extension contains models for implementing detailed security. - **Description:** Group of addresses - **Namespace:** Security - **Icon:** material-symbols:menu-book-outline-rounded -- **Display Labels:** name__value - **Human Friendly ID:** name__value - **Inherit From:** SecurityGenericAddressGroup @@ -157,7 +151,6 @@ This schema extension contains models for implementing detailed security. - **Description:** IP protocol - **Namespace:** Security - **Icon:** mdi:protocol -- **Display Labels:** name__value - **Human Friendly ID:** name__value - **Inherit From:** SecurityGenericService @@ -173,7 +166,6 @@ This schema extension contains models for implementing detailed security. - **Description:** Service - **Namespace:** Security - **Icon:** eos-icons:application-outlined -- **Display Labels:** name__value - **Human Friendly ID:** name__value - **Inherit From:** SecurityGenericService @@ -195,7 +187,6 @@ This schema extension contains models for implementing detailed security. - **Description:** Service range - **Namespace:** Security - **Icon:** eos-icons:application-outlined -- **Display Labels:** name__value - **Human Friendly ID:** name__value - **Inherit From:** SecurityGenericService @@ -218,7 +209,6 @@ This schema extension contains models for implementing detailed security. - **Description:** Group of services - **Namespace:** Security - **Icon:** material-symbols:menu-book-outline-rounded -- **Display Labels:** name__value - **Human Friendly ID:** name__value - **Inherit From:** SecurityGenericServiceGroup @@ -226,7 +216,6 @@ This schema extension contains models for implementing detailed security. - **Label:** Security Policy - **Namespace:** Security -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -333,7 +322,6 @@ This schema extension contains models for implementing detailed security. - **Label:** Firewall Interface - **Namespace:** Security - **Icon:** mdi:ethernet -- **Display Labels:** name__value - **Inherit From:** InfraInterface, InfraEndpoint #### Relationships @@ -359,7 +347,6 @@ This schema extension contains models for implementing detailed security. ### GenericAddressGroup - **Namespace:** Security -- **Display Labels:** name__value #### Attributes @@ -377,7 +364,6 @@ This schema extension contains models for implementing detailed security. ### GenericAddress - **Namespace:** Security -- **Display Labels:** name__value #### Attributes @@ -394,7 +380,6 @@ This schema extension contains models for implementing detailed security. ### GenericServiceGroup - **Namespace:** Security -- **Display Labels:** name__value #### Attributes @@ -412,7 +397,6 @@ This schema extension contains models for implementing detailed security. ### GenericService - **Namespace:** Security -- **Display Labels:** name__value #### Attributes @@ -462,8 +446,7 @@ generics: - name: GenericAddressGroup namespace: Security include_in_menu: false - display_labels: - - name__value + display_label: name__value hierarchical: true attributes: - name: name @@ -483,8 +466,7 @@ generics: optional: true - name: GenericAddress namespace: Security - display_labels: - - name__value + display_label: name__value include_in_menu: false attributes: - name: name @@ -501,8 +483,7 @@ generics: namespace: Security include_in_menu: false hierarchical: true - display_labels: - - name__value + display_label: name__value attributes: - name: name label: Name @@ -522,8 +503,7 @@ generics: - name: GenericService include_in_menu: false namespace: Security - display_labels: - - name__value + display_label: name__value attributes: - name: name label: Name @@ -545,8 +525,7 @@ nodes: menu_placement: SecurityPolicy human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value include_in_menu: true icon: game-icons:fire-zone description: Security zones @@ -617,9 +596,7 @@ nodes: - SecurityGenericAddress order_by: - address__value - display_labels: - - name__value - - address__value + display_label: '{{ name__value }} ({{ address__value }})' attributes: - name: address kind: IPHost @@ -639,9 +616,7 @@ nodes: - SecurityGenericAddress order_by: - name__value - display_labels: - - name__value - - prefix__value + display_label: '{{ name__value }} ({{ prefix__value }})' attributes: - name: prefix kind: IPNetwork @@ -659,8 +634,7 @@ nodes: label: IP Range human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value inherit_from: - SecurityGenericAddress order_by: @@ -683,8 +657,7 @@ nodes: label: FQDN human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value inherit_from: - SecurityGenericAddress order_by: @@ -706,8 +679,7 @@ nodes: human_friendly_id: - name__value parent: SecurityAddressGroup - display_labels: - - name__value + display_label: name__value inherit_from: - SecurityGenericAddressGroup - name: IPProtocol @@ -719,8 +691,7 @@ nodes: label: IP Protocols human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value order_by: - name__value inherit_from: @@ -738,8 +709,7 @@ nodes: label: Service human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value order_by: - name__value inherit_from: @@ -762,8 +732,7 @@ nodes: label: Service range human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value order_by: - name__value inherit_from: @@ -790,8 +759,7 @@ nodes: description: Group of services human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value order_by: - name__value inherit_from: @@ -801,8 +769,7 @@ nodes: label: Security Policy human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value order_by: - name__value attributes: @@ -1070,8 +1037,7 @@ nodes: menu_placement: InfraGenericDevice include_in_menu: false icon: mdi:ethernet - display_labels: - - name__value + display_label: name__value inherit_from: - InfraInterface - InfraEndpoint diff --git a/docs/docs/reference/sfp.mdx b/docs/docs/reference/sfp.mdx index ea5d73e..7cea68b 100644 --- a/docs/docs/reference/sfp.mdx +++ b/docs/docs/reference/sfp.mdx @@ -50,7 +50,6 @@ Improvements: - **Description:** Generic base for all Small Form-factor Pluggable (SFP) transceivers. - **Namespace:** Dcim - **Icon:** mdi:gpu -- **Display Labels:** form_factor__value, sfp_type__value #### Attributes @@ -112,9 +111,7 @@ generics: label: SFP icon: mdi:gpu include_in_menu: true - display_labels: - - form_factor__value - - sfp_type__value + display_label: '{{ form_factor__value }} {{ sfp_type__value }}' attributes: - name: serial kind: Text diff --git a/docs/docs/reference/snmp.mdx b/docs/docs/reference/snmp.mdx index 0dd7bb0..0830ee6 100644 --- a/docs/docs/reference/snmp.mdx +++ b/docs/docs/reference/snmp.mdx @@ -17,7 +17,6 @@ This schema extension contains models for SNMP Communities and SNMP Clients. As - **Description:** SNMP v1/v2c community configuration. - **Namespace:** Snmp - **Icon:** iconoir:community -- **Display Labels:** name__value - **Human Friendly ID:** name__value - **Inherit From:** SnmpCommunity @@ -34,7 +33,6 @@ This schema extension contains models for SNMP Communities and SNMP Clients. As - **Description:** SNMP version 3 configuration with enhanced security. - **Namespace:** Snmp - **Icon:** iconoir:community -- **Display Labels:** name__value - **Human Friendly ID:** name__value - **Inherit From:** SnmpCommunity @@ -55,7 +53,6 @@ This schema extension contains models for SNMP Communities and SNMP Clients. As - **Description:** Represents an SNMP client that interacts with SNMP Community. - **Namespace:** Snmp - **Icon:** ph:user-list-light -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -79,7 +76,6 @@ This schema extension contains models for SNMP Communities and SNMP Clients. As - **Description:** Generic model for SNMP community configurations. - **Namespace:** Snmp - **Icon:** iconoir:community -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -107,8 +103,7 @@ generics: icon: iconoir:community human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value order_by: - name__value attributes: @@ -133,8 +128,7 @@ nodes: menu_placement: SnmpCommunity human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value order_by: - name__value inherit_from: @@ -157,8 +151,7 @@ nodes: menu_placement: SnmpCommunity human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value order_by: - name__value inherit_from: @@ -215,8 +208,7 @@ nodes: menu_placement: SnmpCommunity human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value order_by: - name__value attributes: diff --git a/docs/docs/reference/users.mdx b/docs/docs/reference/users.mdx index fe3f507..b2fc616 100644 --- a/docs/docs/reference/users.mdx +++ b/docs/docs/reference/users.mdx @@ -17,7 +17,6 @@ This schema extension contains models for account management. - **Description:** User Group - **Namespace:** User - **Icon:** iconoir:group -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -35,7 +34,6 @@ This schema extension contains models for account management. - **Description:** User login and authentication - **Namespace:** User - **Icon:** mdi:account-key -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -81,8 +79,7 @@ nodes: description: User Group label: User Groups icon: iconoir:group - display_labels: - - name__value + display_label: name__value order_by: - name__value human_friendly_id: @@ -119,8 +116,7 @@ nodes: description: User login and authentication label: User Account icon: mdi:account-key - display_labels: - - name__value + display_label: name__value order_by: - name__value human_friendly_id: diff --git a/docs/docs/reference/vlan.mdx b/docs/docs/reference/vlan.mdx index 3394d61..18065bb 100644 --- a/docs/docs/reference/vlan.mdx +++ b/docs/docs/reference/vlan.mdx @@ -17,7 +17,6 @@ This schema extension contains models to support VLANs in you network. - **Description:** A VLAN is isolated layer two domain - **Namespace:** Ipam - **Icon:** mdi:lan-pending -- **Display Labels:** name__value - **Uniqueness Constraints:** - vlan_id__value, l2domain - **Human Friendly ID:** name__value @@ -46,7 +45,6 @@ This schema extension contains models to support VLANs in you network. - **Description:** Represents layer 2 domain. - **Namespace:** Ipam - **Icon:** mdi:domain-switch -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -112,8 +110,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text @@ -179,8 +176,7 @@ nodes: icon: mdi:domain-switch human_friendly_id: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text diff --git a/docs/docs/reference/vrf.mdx b/docs/docs/reference/vrf.mdx index 192abde..533c885 100644 --- a/docs/docs/reference/vrf.mdx +++ b/docs/docs/reference/vrf.mdx @@ -17,7 +17,6 @@ This schema extension contains models to support VRF in your network. - **Description:** A VRF is isolated layer three domain - **Namespace:** Ipam - **Icon:** mdi:router -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -42,7 +41,6 @@ This schema extension contains models to support VRF in your network. - **Description:** Route Target (RFC 4360) - **Namespace:** Ipam - **Icon:** mdi:target -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -96,8 +94,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text @@ -141,8 +138,7 @@ nodes: - name__value order_by: - name__value - display_labels: - - name__value + display_label: name__value attributes: - name: name kind: Text diff --git a/docs/docs/reference/vrrp.mdx b/docs/docs/reference/vrrp.mdx index 48989c3..da59512 100644 --- a/docs/docs/reference/vrrp.mdx +++ b/docs/docs/reference/vrrp.mdx @@ -17,7 +17,6 @@ This schema extension contains models for VRRP. - **Description:** VRRP Group configuration - **Namespace:** Network - **Icon:** fluent:virtual-network-20-filled -- **Display Labels:** name__value - **Human Friendly ID:** name__value #### Attributes @@ -91,8 +90,7 @@ nodes: label: VRRP Group icon: fluent:virtual-network-20-filled description: VRRP Group configuration - display_labels: - - name__value + display_label: name__value order_by: - name__value human_friendly_id: diff --git a/tasks/__init__.py b/tasks/__init__.py index 3cd07c4..0e63de9 100644 --- a/tasks/__init__.py +++ b/tasks/__init__.py @@ -6,7 +6,7 @@ VERSION = os.getenv("INFRAHUB_VERSION", None) DOCKER_PROJECT = os.getenv("INFRAHUB_BUILD_NAME", "schema-library-ci") -COMPOSE_COMMAND = f"curl https://infrahub.opsmill.io/{VERSION if VERSION else 'stable'} | sed 's/8000:8000/0:8000/' | docker compose -p {DOCKER_PROJECT} -f -" # noqa: line-too-long +COMPOSE_COMMAND = f"curl -fsSL https://infrahub.opsmill.io/{VERSION if VERSION else 'stable'} | sed 's/8000:8000/0:8000/' | docker compose -p {DOCKER_PROJECT} -f -" # noqa: line-too-long ns = Collection()