23971 Proposed API and schema changes

[jacobshandling]

For #25034

API changes:

this PR diff ("available_teams" change is adding missing documentation for current API behavior)

schema changes:

• new col in users table, settings, type json. Defaults to {}. New setting, hidden_host_columns, added or updated on first relevant API call per user.

semantics

• null "hidden_host_columns" field means "not yet set, use defaults": {"settings":{"hidden_host_columns": null}}
• included and empty "hidden_host_columns" field means "no columns hidden, show all columns in the UI": {"settings":{"hidden_host_columns": []}}

Updates 1/7/25 per discussion with @rachaelshaw @lucasmrod @sgress454:

• Optional query param include_ui_settings=true included with GETs to /me or /users/:id will trigger considering the API call to be a contributor API call, giving more flexibility for future changes. Note that this is the first time we have one endpoint that can be conditionally considered a contributor endpoint depending on how it is called.

[iansltx]

Was going to ask whether we should revise the default on me?include_settings but it looks like loading the hosts page pulls /me anyway so we can just revise that call to pull column settings when we need them (vs. trying to economize on HTTP requests now).

[jacobshandling]

Hey @rachaelshaw, hope you had a nice vacation. Assigning you this ticket, how do these specs look from product POV?

[rachaelshaw]

Approach lgtm, left a few small comments

[jacobshandling]

@rachaelshaw @lucasmrod @sgress454 added our decisions to this issue description, thanks for your insights!

[lucasmrod]

@jacobshandling Should this PR be merged or closed? (IIRC the functionality was merged to main).

[jacobshandling]

@lucasmrod I'm unsure of doc update process re closing older PRs and opening new ones to merge, so was leaving this info for @rachaelshaw's reference. Rachael, should this PR be closed?