From 1054d64115a4a13803c29c215d623d47017ae0de Mon Sep 17 00:00:00 2001 From: Rajas Panat Date: Wed, 6 May 2026 16:10:08 -0400 Subject: [PATCH 1/4] adding a deprecation marker to class, object and profile pages Signed-off-by: Rajas Panat --- lib/schema_web/templates/layout/app.html.eex | 6 ++++ lib/schema_web/templates/page/class.html.eex | 10 ++++++ lib/schema_web/templates/page/object.html.eex | 10 ++++++ .../templates/page/profile.html.eex | 10 ++++++ lib/schema_web/views/page_view.ex | 32 +++++++++++++++++++ 5 files changed, 68 insertions(+) diff --git a/lib/schema_web/templates/layout/app.html.eex b/lib/schema_web/templates/layout/app.html.eex index 38c3ccd..d80516a 100644 --- a/lib/schema_web/templates/layout/app.html.eex +++ b/lib/schema_web/templates/layout/app.html.eex @@ -95,6 +95,9 @@ limitations under the License. case '/objects': $('#objects_id a.nav-link').addClass("active"); break; + case '/profiles': + $('#profiles_id a.nav-link').addClass("active"); + break; case '/objects/observable': $('#observable_id a.nav-link').addClass("active"); break; @@ -248,6 +251,9 @@ limitations under the License. + diff --git a/lib/schema_web/templates/page/class.html.eex b/lib/schema_web/templates/page/class.html.eex index 21c3084..b811a35 100644 --- a/lib/schema_web/templates/page/class.html.eex +++ b/lib/schema_web/templates/page/class.html.eex @@ -51,6 +51,16 @@ limitations under the License.
<%= raw description(@data) %>
+ <%= if has_deprecated_attributes?(@data) do %> + <% dep_count = deprecated_attributes_count(@data) %> +
+ + + This class contains <%= dep_count %> deprecated <%= if dep_count == 1, do: "attribute", else: "attributes" %>. + Check the Show deprecated items box in the sidebar to view <%= if dep_count == 1, do: "it", else: "them" %>. + +
+ <% end %> <%= if observables != nil and !Enum.empty?(observables) do %>
Class-specific attribute path observables are at the bottom of this page. diff --git a/lib/schema_web/templates/page/object.html.eex b/lib/schema_web/templates/page/object.html.eex index 64fdce3..8342c3b 100644 --- a/lib/schema_web/templates/page/object.html.eex +++ b/lib/schema_web/templates/page/object.html.eex @@ -46,6 +46,16 @@ limitations under the License.
<%= raw description(@data) %>
+ <%= if has_deprecated_attributes?(@data) do %> + <% dep_count = deprecated_attributes_count(@data) %> +
+ + + This object contains <%= dep_count %> deprecated <%= if dep_count == 1, do: "attribute", else: "attributes" %>. + Check the Show deprecated items box in the sidebar to view <%= if dep_count == 1, do: "it", else: "them" %>. + +
+ <% end %> <%= raw object_references_section(references) %>
diff --git a/lib/schema_web/templates/page/profile.html.eex b/lib/schema_web/templates/page/profile.html.eex index 336d31c..b7fccd4 100644 --- a/lib/schema_web/templates/page/profile.html.eex +++ b/lib/schema_web/templates/page/profile.html.eex @@ -25,6 +25,16 @@ limitations under the License.
<%= raw @data[:description] %>
+ <%= if has_deprecated_attributes?(@data) do %> + <% dep_count = deprecated_attributes_count(@data) %> +
+ + + This profile contains <%= dep_count %> deprecated <%= if dep_count == 1, do: "attribute", else: "attributes" %>. + Check the Show deprecated items box in the sidebar to view <%= if dep_count == 1, do: "it", else: "them" %>. + +
+ <% end %> <%= raw object_references_section(@data[:references]) %>
diff --git a/lib/schema_web/views/page_view.ex b/lib/schema_web/views/page_view.ex index 6542db2..282b601 100644 --- a/lib/schema_web/views/page_view.ex +++ b/lib/schema_web/views/page_view.ex @@ -1743,4 +1743,36 @@ defmodule SchemaWeb.PageView do def show_deprecated_css_classes(item) do show_deprecated_css_classes(item, "") end + + @doc """ + Returns true if the item (class or object) contains at least one deprecated attribute. + """ + @spec has_deprecated_attributes?(map()) :: boolean() + def has_deprecated_attributes?(item) do + deprecated_attributes_count(item) > 0 + end + + @doc """ + Returns the count of deprecated attributes in the item (class or object). + """ + @spec deprecated_attributes_count(map()) :: non_neg_integer() + def deprecated_attributes_count(item) do + case item[:attributes] do + nil -> + 0 + + attributes when is_map(attributes) -> + Enum.count(attributes, fn {_key, attr} -> + attr[:"@deprecated"] != nil + end) + + attributes when is_list(attributes) -> + Enum.count(attributes, fn {_key, attr} -> + attr[:"@deprecated"] != nil + end) + + _ -> + 0 + end + end end From 967b7f0597fb876bd9adbd8857983e038c2701ab Mon Sep 17 00:00:00 2001 From: Rajas Panat Date: Wed, 6 May 2026 16:10:35 -0400 Subject: [PATCH 2/4] adding necessary css Signed-off-by: Rajas Panat --- priv/static/css/components.css | 53 ++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/priv/static/css/components.css b/priv/static/css/components.css index cfc8a9d..de8a748 100644 --- a/priv/static/css/components.css +++ b/priv/static/css/components.css @@ -764,3 +764,56 @@ button:hover, background: var(--surface-color); border-left-color: var(--accent-color); } + +/* Deprecated Attributes Badge - shown on classes/objects that contain deprecated attributes */ +.deprecated-attr-badge { + display: inline-flex; + align-items: center; + justify-content: center; + color: var(--warning-color); + font-size: 0.75rem; + cursor: help; + opacity: 0.85; + transition: var(--transition-fast); +} + +.deprecated-attr-badge:hover { + opacity: 1; + transform: scale(1.15); +} + +[data-theme="dark"] .deprecated-attr-badge { + color: #FBBF24; +} + +/* Deprecated Attributes Notice - banner on class/object detail pages */ +.deprecated-attr-notice { + display: inline-flex; + align-items: center; + gap: var(--spacing-sm); + background: rgba(217, 119, 6, 0.08); + border: 1px solid rgba(217, 119, 6, 0.3); + border-left: 3px solid var(--warning-color); + border-radius: var(--radius-md); + padding: var(--spacing-sm) var(--spacing-md); + margin-top: var(--spacing-md); + font-size: 0.875rem; + color: var(--text-primary); + width: fit-content; +} + +.deprecated-attr-notice i { + color: var(--warning-color); + font-size: 0.875rem; + flex-shrink: 0; +} + +[data-theme="dark"] .deprecated-attr-notice { + background: rgba(251, 191, 36, 0.08); + border-color: rgba(251, 191, 36, 0.3); + border-left-color: #FBBF24; +} + +[data-theme="dark"] .deprecated-attr-notice i { + color: #FBBF24; +} From aa8332429ecbab0878c949b8fdb0fa18fb71216b Mon Sep 17 00:00:00 2001 From: Rajas Panat Date: Wed, 6 May 2026 16:10:48 -0400 Subject: [PATCH 3/4] bumping minor version Signed-off-by: Rajas Panat --- mix.exs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mix.exs b/mix.exs index fbf913a..b79de31 100644 --- a/mix.exs +++ b/mix.exs @@ -10,7 +10,7 @@ defmodule Schema.MixProject do use Mix.Project - @version "4.0.2" + @version "4.1.0" def project do build = System.get_env("GITHUB_RUN_NUMBER") || "SNAPSHOT" From d2c771925f6a37cdb95781885dea42a9b46a0d92 Mon Sep 17 00:00:00 2001 From: Rajas Panat Date: Wed, 6 May 2026 16:40:04 -0400 Subject: [PATCH 4/4] bugfix: extension added attrs only when extension is selected Signed-off-by: Rajas Panat --- lib/schema_web/controllers/page_controller.ex | 11 ++++++++++- lib/schema_web/templates/layout/app.html.eex | 19 +++++++++++++++++-- priv/static/js/app.js | 8 ++++---- 3 files changed, 31 insertions(+), 7 deletions(-) diff --git a/lib/schema_web/controllers/page_controller.ex b/lib/schema_web/controllers/page_controller.ex index a00ef9e..1609961 100644 --- a/lib/schema_web/controllers/page_controller.ex +++ b/lib/schema_web/controllers/page_controller.ex @@ -32,6 +32,8 @@ defmodule SchemaWeb.PageController do @spec category_by_id(Plug.Conn.t(), map()) :: Plug.Conn.t() def category_by_id(conn, params) do + params = Map.put_new(params, "extensions", "") + case SchemaController.category_classes(params) do nil -> send_resp(conn, 404, "Not Found: #{SchemaController.params_to_uid(params)}") @@ -49,6 +51,7 @@ defmodule SchemaWeb.PageController do @spec profiles(Plug.Conn.t(), map) :: Plug.Conn.t() def profiles(conn, params) do + params = Map.put_new(params, "extensions", "") profiles = get_profiles(params) sorted_profiles = sort_by_descoped_key(profiles) @@ -81,7 +84,10 @@ defmodule SchemaWeb.PageController do @spec classes(Plug.Conn.t(), any) :: Plug.Conn.t() def classes(conn, params) do - data = SchemaController.classes(params) |> sort_by(:uid) + data = + Map.put_new(params, "extensions", "") + |> SchemaController.classes() + |> sort_by(:uid) render(conn, "classes.html", extensions: Schema.extensions(), @@ -137,6 +143,8 @@ defmodule SchemaWeb.PageController do @spec objects(Plug.Conn.t(), map()) :: Plug.Conn.t() def objects(conn, params) do + params = Map.put_new(params, "extensions", "") + data = SchemaController.parse_options(SchemaController.extensions(params)) |> Schema.objects_filter_extensions() @@ -190,6 +198,7 @@ defmodule SchemaWeb.PageController do @spec dictionary(Plug.Conn.t(), any) :: Plug.Conn.t() def dictionary(conn, params) do + params = Map.put_new(params, "extensions", "") schema = Schema.schema() data = diff --git a/lib/schema_web/templates/layout/app.html.eex b/lib/schema_web/templates/layout/app.html.eex index d80516a..cbec0ee 100644 --- a/lib/schema_web/templates/layout/app.html.eex +++ b/lib/schema_web/templates/layout/app.html.eex @@ -46,11 +46,26 @@ limitations under the License. this.href = this.href + params; }); - // Also update main navigation links + // Also update main navigation links (skip dropdown toggles and hash-only links) $(".top-navbar-nav a.nav-link").each(function() { + if (this.getAttribute('href') === '#' || this.classList.contains('dropdown-toggle')) { + return; + } this.href = this.href + params; }); + // Update content links (class, object, category, profile links in page body) + $(".main-page a").each(function() { + const href = this.getAttribute('href'); + if (!href || href.startsWith('http') || href.startsWith('#') || href.startsWith('javascript:') || href.includes('?')) { + return; + } + // Only update internal schema navigation links + if (href.match(/^\/(classes|objects|categories|profiles|dictionary|data_types)/)) { + this.href = this.href + params; + } + }); + // set the profile checkboxes init_selected_profiles(); @@ -267,7 +282,7 @@ limitations under the License.
|