Add graphql query to add document to a component #32
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
ebudtke-atl
reviewed
Oct 21, 2024
| ```graphql | ||
| { | ||
| "cloudId": "YOUR-CLOUD-ID", | ||
| "first": 10, |
There was a problem hiding this comment.
Nit: you could limit this to just 4 as right now the categories are static so you won't ever get back more than that for a given site.
| Maintainer | ||
| Other | ||
|
|
||
| Step 2: Use the following query to add a document to your Compass |
There was a problem hiding this comment.
Nit: Should be "Use the following mutation ... "
| ```graphql | ||
| { | ||
| "input": { | ||
| "title": "title", |
There was a problem hiding this comment.
Would it be worth calling out (in a comment or further above in the readme) that title is optional and you can just supply a url?
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.
Hello team,
As discussed with Josh Campbell, I'm raising this PR to add GraphQL query examples to add a document to a Compass component.
References:
https://developer.atlassian.com/cloud/compass/graphql/#mutations_addDocument)
https://developer.atlassian.com/cloud/compass/graphql/#queries_documentationCategories