Introspect Schema endpoint #6731
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Sujith <mail.sujithvn@gmail.com>
🦋 Changeset detectedLatest commit: 0e4bd77 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Signed-off-by: Sujith <mail.sujithvn@gmail.com>
Signed-off-by: Sujith <mail.sujithvn@gmail.com>
Signed-off-by: Sujith <mail.sujithvn@gmail.com>
Signed-off-by: Sujith <mail.sujithvn@gmail.com>
Signed-off-by: Sujith <mail.sujithvn@gmail.com>
Signed-off-by: Sujith <mail.sujithvn@gmail.com>
brent-hoover
approved these changes
Jan 17, 2023
|
@sujithvn Because this requires a mandatory migration I am changing the root branch to |
aldeed
requested changes
Jan 31, 2023
There was a problem hiding this comment.
There are a lot of additional changes in the diff due to pointing at the release branch. Those changes should be merged first or this PR should be rebased off the release branch.
I did my best to review the introspection files, though. See my inline comments.
packages/api-plugin-simple-schema/src/queries/introspectSchema.js
Outdated
Show resolved
Hide resolved
packages/api-plugin-simple-schema/src/queries/introspectSchema.js
Outdated
Show resolved
Hide resolved
packages/api-plugin-simple-schema/src/queries/introspectSchema.js
Outdated
Show resolved
Hide resolved
aldeed
reviewed
Jan 31, 2023
aldeed
reviewed
Jan 31, 2023
… release-5 Signed-off-by: Sujith <mail.sujithvn@gmail.com>
Signed-off-by: Sujith <mail.sujithvn@gmail.com>
Signed-off-by: Sujith <mail.sujithvn@gmail.com>
Signed-off-by: Sujith <mail.sujithvn@gmail.com>
aldeed
approved these changes
Feb 7, 2023
brent-hoover
approved these changes
Feb 8, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Sujith mail.sujithvn@gmail.com
Resolves #6529 #6438
Impact: major
Type: feature
Issue
There is a requirement to introspect any given schema to analyse the fields available and its type with proper permission validation.
Solution
We have developed a new query end-point [introspectSchema] which accepts the schemaName and shopId and returns the schema details as a JSONObject.
Breaking changes
All the changes are new and does not impact any existing setup. But since this change will need additional permissions, it will have a mandatory migration to be done to start using this endpoint.
Testing
Unit test cases currently failing due to issues of the latest simpleSchema 3.4.0 with Jest.