Skip to content

Bug/Improvement: Add commands to regenerate table schema used by Website/App when modifying specific table schemas to README/docs #12459

@RachelElysia

Description

@RachelElysia

Fleet version: (head to the "My account" page in the Fleet UI or run fleetctl --version)

Operating system: (e.g. macOS 11.2.3)

Web browser: (e.g. Chrome 88.0.4324)


🧑‍💻  Expected behavior

  • Someone pushed a change in schema/tables/screenlock.yml
  • I'm working on the same file
  • I expected their change to be surfaced to users on the app and website (which uses osquery_fleet_schema.json as a source of truth) as I will be surfacing my changes there as well.

💥  Actual behavior

  • The changes that Mo made are not updated to the app or website
    • The changes are not reflected because they did not regenerate the osquery_fleet_schema.json after their changes.

👣 Reproduction steps

  1. Make a change to schema/tables/table_name_here.yml like Mo did in Update screenlock table doc to be more explicit about its limitations #12432
  2. See that the change is not surfaced in the UI query tables side panel or on the website docs after saving/merging

More info

  • This process is not clear and should be clarified in the README. I also fell into the same trap a week ago assuming updating a table here will automatically update the documentation.

Metadata

Metadata

Assignees

Labels

:improve documentationInvolves writing improvements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions