Skip to content
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

Logical model examples without resourceType or id #86

Merged
merged 4 commits into from
Feb 7, 2024

Conversation

jafeltra
Copy link
Collaborator

@jafeltra jafeltra commented Jan 24, 2024

This PR adds a note to the Tips and Tricks section about logical model examples without resource type and id. I wasn't exactly sure where this should fit because it is really similar to the existing documentation. Let me know what you think.

Note: this approach is based on discussion on Zulip here.

Do not merge this PR until there is a SUSHI release that includes support for this.

Copy link
Member

@cmoesel cmoesel left a comment

Choose a reason for hiding this comment

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

This looks good and is explained clearly. Thanks!

@jafeltra
Copy link
Collaborator Author

jafeltra commented Feb 2, 2024

I've updated this PR to use the current extension URL for IG resource format, since the one we had documented has been deprecated.

I've also updated it use a full canonical URL in the resourceType of our example since that is correct (SUSHI will still allow ids there, but we should document best practice). It had been bugging me for a while that our example Logical Model does not have an id element but the example Instance of it does (technically making the example invalid for that logical model), so I added an id element as well.

Copy link
Member

@cmoesel cmoesel left a comment

Choose a reason for hiding this comment

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

I've asked a question / suggested a change. Technically the example is not wrong, so I couldn't make myself select Request Changes -- but it's probably a good idea to change it anyway.

content/docs/SUSHI/tips/_index.md Outdated Show resolved Hide resolved
Copy link
Member

@cmoesel cmoesel left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@jafeltra jafeltra merged commit 683a034 into master Feb 7, 2024
@jafeltra jafeltra deleted the logical-model-without-resource-type branch February 7, 2024 14:01
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