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

Type Fix for Returned Schemas #4580

Merged
merged 4 commits into from
May 31, 2022
Merged

Conversation

takameyer
Copy link
Contributor

@takameyer takameyer commented May 18, 2022

What, How & Why?

The schema returned from an open realm has a different structure than the input schema
for configuration. This structure has now been typed along with updated documentation.

☑️ ToDos

  • 📝 Changelog entry
  • 📝 Compatibility label is updated or copied from previous entry
  • 🚦 Tests
  • 🔀 Executed flexible sync tests locally if modifying flexible sync
  • 📱 Check the React Native/other sample apps work if necessary
  • 📝 Public documentation PR created or is not necessary
  • 💥 Breaking label has been applied or is not necessary

If this PR adds or changes public API's:

  • typescript definitions file is updated
  • jsdoc files updated
  • Chrome debug API is updated if API is available on React Native

@cla-bot cla-bot bot added the cla: yes label May 18, 2022
@takameyer takameyer force-pushed the andrew/canonical-schema-object branch from 8b5e99f to 955b530 Compare May 18, 2022 06:39
types/index.d.ts Outdated Show resolved Hide resolved
@takameyer takameyer force-pushed the andrew/canonical-schema-object branch from 00df19b to 8a11e17 Compare May 18, 2022 08:29
* The schema returned from an open realm has a different structure than the input schema
for configuration.  This structure has now been typed along with updated documentation.

* Statically cast the returned schema as it is being used to dynamically update the schema
@takameyer takameyer force-pushed the andrew/canonical-schema-object branch from 8a11e17 to f4b6432 Compare May 18, 2022 08:34
@tomduncalf
Copy link
Contributor

Accidentally reviewed these changes as part of #4581

@takameyer takameyer force-pushed the andrew/canonical-schema-object branch from e88d294 to 3a6a819 Compare May 18, 2022 13:41
Copy link
Contributor

@kneth kneth left a comment

Choose a reason for hiding this comment

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

I suggest that it is merged but it leaves us with a decision to make. Maybe the upcoming TS model classes will have it simpler to make the decision.

docs/realm.js Outdated Show resolved Hide resolved
@takameyer takameyer force-pushed the andrew/canonical-schema-object branch from ba76a01 to 1e22627 Compare May 31, 2022 07:50
@takameyer takameyer force-pushed the andrew/canonical-schema-object branch from 1e22627 to a2a4c70 Compare May 31, 2022 08:01
@takameyer takameyer merged commit 01a0172 into master May 31, 2022
@takameyer takameyer deleted the andrew/canonical-schema-object branch May 31, 2022 09:32
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants