Consolidate JSON API field allowlist

Author: xantrac

.formatter.exs

@@ -77,7 +77,6 @@ spark_locals_without_parens = [
   router: 1,
   serve_schema?: 1,
   show_fields: 1,
-  show_relationships: 1,
   show_raised_errors?: 1,
   tag: 1,
   type: 1,

documentation/dsls/DSL-AshJsonApi.Resource.md

@@ -68,8 +68,7 @@ end
 | [`include_nil_values?`](#json_api-include_nil_values?){: #json_api-include_nil_values? } | `any` |  | Whether or not to include properties for values that are nil in the JSON output |
 | [`default_fields`](#json_api-default_fields){: #json_api-default_fields } | `list(atom)` |  | The fields to include in the object if the `fields` query parameter does not specify. Defaults to all public |
 | [`hide_fields`](#json_api-hide_fields){: #json_api-hide_fields } | `list(atom)` | `[]` | A list of fields to hide from the generated OpenAPI specification. Applies to attributes, relationships, calculations, and aggregates. |
-| [`show_fields`](#json_api-show_fields){: #json_api-show_fields } | `list(atom)` |  | A list of attributes, calculations, and aggregates to show in the JSON:API response and generated OpenAPI specification. If not specified, all public non-relationship fields are allowed in responses, and all public non-relationship fields except those in `hide_fields` are shown in the generated OpenAPI specification. |
-| [`show_relationships`](#json_api-show_relationships){: #json_api-show_relationships } | `list(atom)` |  | A list of relationships to show in the JSON:API response and generated OpenAPI specification. If not specified, all public relationships are allowed in responses, and all public relationships except those in `hide_fields` are shown in the generated OpenAPI specification. |
+| [`show_fields`](#json_api-show_fields){: #json_api-show_fields } | `list(atom)` |  | A list of fields to show in the JSON:API response and generated OpenAPI specification. Applies to attributes, relationships, calculations, and aggregates. If not specified, all public fields are allowed in responses, and all public fields except those in `hide_fields` are shown in the generated OpenAPI specification. |
 | [`derive_sort?`](#json_api-derive_sort?){: #json_api-derive_sort? } | `boolean` | `true` | Whether or not to derive a sort parameter based on the sortable fields of the resource |
 | [`derive_filter?`](#json_api-derive_filter?){: #json_api-derive_filter? } | `boolean` | `true` | Whether or not to derive a filter parameter based on the sortable fields of the resource |
 | [`relationship_meta_in`](#json_api-relationship_meta_in){: #json_api-relationship_meta_in } | `keyword` | `[]` | Configures how incoming JSON:API `meta` keys on relationship resource identifiers map to join resource attributes for many_to_many relationship writes. Use together with `relationship_meta_out` for reads. Each relationship you want to support must declare both mappings explicitly. |

lib/ash_json_api/includes/parser.ex

@@ -37,23 +37,23 @@ defmodule AshJsonApi.Includes.Parser do
     list
     |> Enum.flat_map(fn
       {key, value} when is_list(value) ->
-        if AshJsonApi.Resource.Info.allow_relationship?(resource, key) do
+        if AshJsonApi.Resource.Info.allow_field?(resource, key) do
           relationship = Ash.Resource.Info.public_relationship(resource, key)
           [{to_string(key), to_nested_map(value, relationship.destination)}]
         else
           []
         end
 
       {key, value} when is_atom(value) ->
-        if AshJsonApi.Resource.Info.allow_relationship?(resource, key) do
+        if AshJsonApi.Resource.Info.allow_field?(resource, key) do
           relationship = Ash.Resource.Info.public_relationship(resource, key)
           [{to_string(key), to_nested_map([value], relationship.destination)}]
         else
           []
         end
 
       value ->
-        if AshJsonApi.Resource.Info.allow_relationship?(resource, value) do
+        if AshJsonApi.Resource.Info.allow_field?(resource, value) do
           relationship = Ash.Resource.Info.public_relationship(resource, value)
           [{to_string(value), to_nested_map(value, relationship.destination)}]
         else

lib/ash_json_api/json_schema/open_api.ex

@@ -217,7 +217,7 @@ if Code.ensure_loaded?(OpenApiSpex) do
       |> Enum.flat_map(fn resource ->
         resource
         |> Ash.Resource.Info.public_relationships()
-        |> filter_shown_relationships(resource)
+        |> filter_shown_fields(resource)
       end)
       |> Enum.map(& &1.destination)
       |> Enum.reject(&(&1 in resources))
@@ -245,7 +245,7 @@ if Code.ensure_loaded?(OpenApiSpex) do
       |> Stream.flat_map(fn resource ->
         resource
         |> Ash.Resource.Info.relationships()
-        |> filter_shown_relationships(resource)
+        |> filter_shown_fields(resource)
       end)
       |> Stream.filter(& &1.public?)
       |> Enum.any?(&(&1.destination == resource))
@@ -277,18 +277,6 @@ if Code.ensure_loaded?(OpenApiSpex) do
       Enum.filter(fields, &show_field?(resource, &1))
     end
 
-    defp show_relationship?(resource, %{name: name}) do
-      AshJsonApi.Resource.Info.show_relationship?(resource, name)
-    end
-
-    defp show_relationship?(resource, relationship) do
-      AshJsonApi.Resource.Info.show_relationship?(resource, relationship)
-    end
-
-    defp filter_shown_relationships(relationships, resource) do
-      Enum.filter(relationships, &show_relationship?(resource, &1))
-    end
-
     defp resource_filter_schemas(domains, resource, acc) do
       {field_types, acc} = filter_field_types(resource, acc)
 
@@ -1384,7 +1372,7 @@ if Code.ensure_loaded?(OpenApiSpex) do
     defp resource_relationships(resource) do
       resource
       |> Ash.Resource.Info.public_relationships()
-      |> filter_shown_relationships(resource)
+      |> filter_shown_fields(resource)
       |> Enum.filter(fn %{destination: destination} ->
         AshJsonApi.Resource.Info.type(destination)
       end)
@@ -2141,7 +2129,7 @@ if Code.ensure_loaded?(OpenApiSpex) do
           is_nil(relationship) ->
             {:halt, false}
 
-          !show_relationship?(current_resource, relationship_name) ->
+          !show_field?(current_resource, relationship_name) ->
             {:halt, false}
 
           true ->
@@ -2576,7 +2564,7 @@ if Code.ensure_loaded?(OpenApiSpex) do
     defp required_relationship_attributes(resource, relationship_arguments, action) do
       action.arguments
       |> Enum.filter(&has_relationship_argument?(relationship_arguments, &1.name))
-      |> Enum.filter(&show_relationship?(resource, &1.name))
+      |> Enum.filter(&show_field?(resource, &1.name))
       |> Enum.reject(& &1.allow_nil?)
       |> Enum.map(fn arg ->
         AshJsonApi.Resource.Info.argument_to_json_key(resource, action.name, arg.name)
@@ -2588,7 +2576,7 @@ if Code.ensure_loaded?(OpenApiSpex) do
     defp write_relationships(resource, relationship_arguments, action) do
       action.arguments
       |> Enum.filter(&has_relationship_argument?(relationship_arguments, &1.name))
-      |> Enum.filter(&show_relationship?(resource, &1.name))
+      |> Enum.filter(&show_field?(resource, &1.name))
       |> Map.new(fn argument ->
         data = resource_write_relationship_field_data(resource, argument)
 
@@ -2833,7 +2821,7 @@ if Code.ensure_loaded?(OpenApiSpex) do
       do: relationship_destination(resource, include) |> List.wrap()
 
     defp relationship_destination(resource, include) do
-      if show_relationship?(resource, include) do
+      if show_field?(resource, include) do
         resource
         |> Ash.Resource.Info.public_relationship(include)
         |> case do
@@ -3080,7 +3068,7 @@ if Code.ensure_loaded?(OpenApiSpex) do
 
       resource
       |> Ash.Resource.Info.public_relationships()
-      |> filter_shown_relationships(resource)
+      |> filter_shown_fields(resource)
       |> Enum.filter(
         &(&1.destination in all_resources &&
             AshJsonApi.Resource.Info.derive_filter?(&1.destination) &&

lib/ash_json_api/request.ex

@@ -696,7 +696,7 @@ defmodule AshJsonApi.Request do
   defp public_related(resource, [path | rest]) do
     case public_relationship(resource, path) do
       %{destination: destination, name: name} ->
-        if AshJsonApi.Resource.Info.allow_relationship?(resource, name) do
+        if AshJsonApi.Resource.Info.allow_field?(resource, name) do
           public_related(destination, rest)
         end
 
@@ -817,7 +817,7 @@ defmodule AshJsonApi.Request do
           end
 
         rel = public_relationship(resource, key) ->
-          if AshJsonApi.Resource.Info.allow_relationship?(resource, rel.name) do
+          if AshJsonApi.Resource.Info.allow_field?(resource, rel.name) do
             fields = Map.update(request.fields, resource, [rel.name], &[rel.name | &1])
             %{request | fields: fields}
           else
@@ -1059,7 +1059,7 @@ defmodule AshJsonApi.Request do
             Keyword.has_key?(includes, key) ->
               includes
 
-            AshJsonApi.Resource.Info.allow_relationship?(resource, key) ->
+            AshJsonApi.Resource.Info.allow_field?(resource, key) ->
               Keyword.put(includes, key, :linkage_only)
 
             true ->

lib/ash_json_api/resource/info.ex

@@ -75,17 +75,12 @@ defmodule AshJsonApi.Resource.Info do
     Extension.get_opt(resource, [:json_api], :hide_fields, [], true)
   end
 
-  @doc "Non-relationship fields to show in JSON:API responses and the generated API specification"
+  @doc "Fields to show in JSON:API responses and the generated API specification"
   def show_fields(resource) do
     Extension.get_opt(resource, [:json_api], :show_fields, nil, true)
   end
 
-  @doc "Relationships to show in JSON:API responses and the generated API specification"
-  def show_relationships(resource) do
-    Extension.get_opt(resource, [:json_api], :show_relationships, nil, true)
-  end
-
-  @doc "Whether or not a given non-relationship field should be shown in the generated API specification"
+  @doc "Whether or not a given field should be shown in the generated API specification"
   def show_field?(resource, %{name: name}) do
     show_field?(resource, name)
   end
@@ -95,9 +90,6 @@ defmodule AshJsonApi.Resource.Info do
       field in hide_fields(resource) ->
         false
 
-      Ash.Resource.Info.public_relationship(resource, field) ->
-        false
-
       is_nil(show_fields(resource)) ->
         true
 
@@ -106,69 +98,33 @@ defmodule AshJsonApi.Resource.Info do
     end
   end
 
-  @doc "Whether or not a given relationship should be shown in the generated API specification"
-  def show_relationship?(resource, %{name: name}) do
-    show_relationship?(resource, name)
-  end
-
-  def show_relationship?(resource, relationship) do
-    cond do
-      relationship in hide_fields(resource) ->
-        false
-
-      is_nil(show_relationships(resource)) ->
-        true
-
-      true ->
-        relationship in show_relationships(resource)
-    end
-  end
-
   @doc "Whether or not a route should be shown in the generated API specification"
   def show_route?(_resource, %{relationship: nil}), do: true
 
   def show_route?(resource, %{relationship: relationship}) do
-    show_relationship?(resource, relationship)
+    show_field?(resource, relationship)
   end
 
-  @doc "Whether or not a given non-relationship field is allowed in the JSON:API response"
+  @doc "Whether or not a given field is allowed in the JSON:API response"
   def allow_field?(resource, %{name: name}) do
     allow_field?(resource, name)
   end
 
   def allow_field?(resource, field) do
-    cond do
-      Ash.Resource.Info.public_relationship(resource, field) ->
-        false
-
-      is_nil(show_fields(resource)) ->
-        true
-
-      true ->
-        field in show_fields(resource)
-    end
-  end
-
-  @doc "Whether or not a given relationship is allowed in the JSON:API response"
-  def allow_relationship?(resource, %{name: name}) do
-    allow_relationship?(resource, name)
-  end
-
-  def allow_relationship?(resource, relationship) do
-    case show_relationships(resource) do
+    case show_fields(resource) do
       nil -> true
-      show_relationships -> relationship in show_relationships
+      show_fields -> field in show_fields
     end
   end
 
   @doc "Whether or not a route is allowed in the runtime JSON:API router"
   def allow_route?(_resource, %{relationship: nil}), do: true
 
   def allow_route?(resource, %{relationship: relationship}) do
-    allow_relationship?(resource, relationship)
+    allow_field?(resource, relationship)
   end
 
-  @doc "Filters non-relationship fields to those that should be shown in the generated API specification"
+  @doc "Filters fields to those that should be shown in the generated API specification"
   def filter_shown_fields(fields, resource) when is_list(fields) and is_atom(resource) do
     filter_shown_fields(resource, fields)
   end
@@ -177,29 +133,13 @@ defmodule AshJsonApi.Resource.Info do
     Enum.filter(fields, &show_field?(resource, &1))
   end
 
-  @doc "Filters relationships to those that should be shown in the generated API specification"
-  def filter_shown_relationships(relationships, resource)
-      when is_list(relationships) and is_atom(resource) do
-    filter_shown_relationships(resource, relationships)
-  end
-
-  def filter_shown_relationships(resource, relationships) do
-    Enum.filter(relationships, &show_relationship?(resource, &1))
-  end
-
   @doc "Filters a sparse fieldset or default field list to fields and relationships shown in the generated API specification"
   def filter_shown_fieldset(fields, resource) when is_list(fields) and is_atom(resource) do
     filter_shown_fieldset(resource, fields)
   end
 
   def filter_shown_fieldset(resource, fields) do
-    Enum.filter(fields, fn field ->
-      if Ash.Resource.Info.public_relationship(resource, field) do
-        show_relationship?(resource, field)
-      else
-        show_field?(resource, field)
-      end
-    end)
+    Enum.filter(fields, &show_field?(resource, &1))
   end
 
   @doc "Filters a sparse fieldset or default field list to fields and relationships allowed in responses"
@@ -208,26 +148,10 @@ defmodule AshJsonApi.Resource.Info do
   end
 
   def filter_allowed_fieldset(resource, fields) do
-    Enum.filter(fields, fn field ->
-      if Ash.Resource.Info.public_relationship(resource, field) do
-        allow_relationship?(resource, field)
-      else
-        allow_field?(resource, field)
-      end
-    end)
-  end
-
-  @doc "Filters relationships to those that are allowed in responses"
-  def filter_allowed_relationships(relationships, resource)
-      when is_list(relationships) and is_atom(resource) do
-    filter_allowed_relationships(resource, relationships)
-  end
-
-  def filter_allowed_relationships(resource, relationships) do
-    Enum.filter(relationships, &allow_relationship?(resource, &1))
+    Enum.filter(fields, &allow_field?(resource, &1))
   end
 
-  @doc "Default response fields filtered by `show_fields` and `show_relationships`"
+  @doc "Default response fields filtered by `show_fields`"
   def default_response_fields(resource) do
     resource
     |> default_fields()

lib/ash_json_api/resource/resource.ex

@@ -566,12 +566,7 @@ defmodule AshJsonApi.Resource do
       show_fields: [
         type: {:list, :atom},
         doc:
-          "A list of attributes, calculations, and aggregates to show in the JSON:API response and generated OpenAPI specification. If not specified, all public non-relationship fields are allowed in responses, and all public non-relationship fields except those in `hide_fields` are shown in the generated OpenAPI specification."
-      ],
-      show_relationships: [
-        type: {:list, :atom},
-        doc:
-          "A list of relationships to show in the JSON:API response and generated OpenAPI specification. If not specified, all public relationships are allowed in responses, and all public relationships except those in `hide_fields` are shown in the generated OpenAPI specification."
+          "A list of fields to show in the JSON:API response and generated OpenAPI specification. Applies to attributes, relationships, calculations, and aggregates. If not specified, all public fields are allowed in responses, and all public fields except those in `hide_fields` are shown in the generated OpenAPI specification."
       ],
       derive_sort?: [
         type: :boolean,