Skip to content

Update the auto YAML Generation #7725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 34 commits into
base: main
Choose a base branch
from
Open

Update the auto YAML Generation #7725

wants to merge 34 commits into from

Conversation

royendo
Copy link
Contributor

@royendo royendo commented Aug 4, 2025

Separated the schema files for easier management
referenced in project.schema.yaml.

reworked connections to look similar to currrent with copiable form.
models.schema.yaml --> advanced-model.schema.yaml

should we move model.sql reference into the ref folde rmanually?

once confirmed, we can move this to rewrite /reference/project--files/

Checklist:

  • Covered by tests
  • Ran it and it works as intended
  • Reviewed the diff before requesting a review
  • Checked for unhandled edge cases
  • Linked the issues it closes
  • Checked if the docs need to be updated. If so, create a separate Linear DOCS issue
  • Intend to cherry-pick into the release branch
  • I'm proud of this work!

unsur eif schema./yaml is maintained or auto generated.
@royendo royendo changed the title Update the auto Update the auto YAML Generation Aug 4, 2025
@royendo royendo marked this pull request as ready for review August 4, 2025 21:18
@royendo royendo requested review from mindspank and NamanMahor August 4, 2025 21:18
@royendo
Copy link
Contributor Author

royendo commented Aug 5, 2025

@mindspank thoughts on this PR?

  • changed hidden names to match current files
  • separated the schemas into different files
  • made some changes to generate code for connector to make it similar to current look, (copiable code blocks)

If approved, ill go back in and overwrite /reference/project-files/ and fix any broken links

@NamanMahor
Copy link
Contributor

@royendo , we prefer using a single file instead of using imports — like in this example, where everything is in one file. Initially, I had created separate files and imported them into project.schema.yaml, like you did, but @begelundmuller suggested keeping everything in one file.

@@ -0,0 +1,52 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should call it sql-models.md and rename advanced-models.md to just models.md

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

works, with me but will need to fix quite a bit of links and redirects. should be easy

@@ -49,73 +68,53 @@ _[string]_ - Configure how changes to the model specifications are applied (opti

_[oneOf]_ - Refers to the explicitly defined state of your model, cannot be used with partitions (optional)

- **option 1** - _[object]_ - Executes a raw SQL query against the project's data models.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did we remove the options? I think it was clearer before, as it showed that the user could choose any option like sql, metric_sql, api, etc.


#### `aws_access_key_id`

_[string]_ - AWS Access Key ID used for authentication. Required when using static credentials directly or as base credentials for assuming a role.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see change difference in line spacing
Before Change

Screenshot 2025-08-06 at 1 23 39 PM

After Change

Screenshot 2025-08-06 at 1 23 32 PM

Properties and description is little congested.

royendo added 5 commits August 6, 2025 09:03
all schemas into one including rillyaml. commented out lines.

reworked generate-project.go:
- moved out logic for sample in copy, uses schema sample instead
- adding in line examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants