Clarify object identifiers in public GraphQL docs

What does this MR do?

This MR clarifies the use of object identifiers in the public GraphQL docs. The motivation of this change is #452465 (closed) and specifically #452465 (comment 1903553820) where it was identified that we had clarified how to use object identifiers in our developer docs !144142 (merged) but not the public facing docs.

Related issues

Author's checklist

• Optional. Consider taking the GitLab Technical Writing Fundamentals course.
• Follow the:
  • Documentation process.
  • Documentation guidelines.
  • Style Guide.
• If you're adding a new page, add the product availability details under the H1 topic title.
• If you are a GitLab team member, request a review based on:
  • The documentation page's metadata.
  • The associated Technical Writer.

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

• ~"frontend"
• ~"backend"
• ~"type::bug"
• ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

• If the content requires it, ensure the information is reviewed by a subject matter expert.
• Technical writer review items:
  • Ensure docs metadata is present and up-to-date.
  • Ensure the appropriate labels are added to this MR.
  • Ensure a release milestone is set.
  • If relevant to this MR, ensure content topic type principles are in use, including:
    • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
    • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
    • Any task steps should be written as a numbered list.
    • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
• Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

changed milestone to %Backlog

added Category:API customer devopsfoundations docs-only docsimprovement documentation groupimport and integrate maintenanceusability sectioncore platform typemaintenance labels

assigned to @.luke

@cablett Hello! Could you please give this GraphQL documentation MR a domain expert review and let me know your thoughts! Thank you

requested review from @cablett

added GraphQL label

	1 Message
	This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

Documentation review

The following files require a review from a technical writer:

• doc/api/graphql/index.md (Link to current live version)

The review does not need to block merging this merge request. See the:

• Metadata for the *.md files that you've changed. The first few lines of each *.md file identify the stage and group most closely associated with your docs change.
• The Technical Writer assigned for that stage and group.
• Documentation workflows for information on when to assign a merge request for review.

If needed, you can retry the danger-review job that generated this comment.

Generated by Danger

mentioned in issue #452465 (closed)

Cheers @.luke, LGTM I made a small suggestion but otherwise solid

added 1 commit

• aab6f8f8 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

requested review from @eread and removed review request for @cablett

changed milestone to %17.4

approved this merge request

removed review request for @eread

requested changes

added 1 commit

• 69441869 - Apply 3 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• 442fa5de - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

requested review from @eread

added 1 commit

• 64c4892b - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

resolved all threads

approved this merge request

started a merge train

Hi @eread ,

GitLab Bot has added the Technical Writing label because a Technical Writer has approved or merged this MR.

This message was generated automatically. You're welcome to improve it.

added Technical Writing label

merged

mentioned in commit 5238586a

added workflowstaging-canary label

added workflowcanary label and removed workflowstaging-canary label

added workflowstaging label and removed workflowcanary label

added workflowproduction label and removed workflowstaging label

added releasedcandidate label

added releasedpublished label and removed releasedcandidate label