Skip to content

correct docs gen#998

Merged
raphael-goetz merged 2 commits into
#779-runtime-usage-servicefrom
fix/correct-docs-generation
May 31, 2026
Merged

correct docs gen#998
raphael-goetz merged 2 commits into
#779-runtime-usage-servicefrom
fix/correct-docs-generation

Conversation

@raphael-goetz
Copy link
Copy Markdown
Member

No description provided.

Copilot AI review requested due to automatic review settings May 31, 2026 07:20
@raphael-goetz raphael-goetz requested a review from Taucher2003 May 31, 2026 07:20
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Fixes GraphQL Markdown docs generation so Relay pagination arguments (after, before, first, last) are not rendered for connection-returning fields, decluttering field tables to only show schema-defined custom arguments.

Changes:

  • Added documented_arguments helper that filters out connection pagination args for connection fields, and refactored arguments? to use it.
  • Updated object.md.erb and interface.md.erb templates to render documented_arguments.call(field) instead of raw field[:arguments].
  • Regenerated docs/graphql/object/flow.md and docs/graphql/object/namespace.md to remove pagination args from dailyRuntimeUsages.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tooling/graphql/docs/helper.rb Introduces documented_arguments and exposes it to templates; rewrites arguments? in terms of it.
tooling/graphql/docs/templates/object.md.erb Uses documented_arguments to render field arg tables.
tooling/graphql/docs/templates/interface.md.erb Same change for interface template.
docs/graphql/object/flow.md Regenerated docs: pagination args removed from dailyRuntimeUsages.
docs/graphql/object/namespace.md Regenerated docs: pagination args removed from dailyRuntimeUsages.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 31, 2026

GitLab Pipeline Action

General information

Link to pipeline: https://gitlab.com/code0-tech/development/sagittarius/-/pipelines/2564935694

Status: Passed
Duration: 5 minutes

Job summaries

rspec: [cloud]

Coverage report available at https://code0-tech.gitlab.io/-/development/sagittarius/-/jobs/14618945990/artifacts/tmp/coverage/index.html
Test summary available at https://gitlab.com/code0-tech/development/sagittarius/-/pipelines/2564935694/test_report
Finished in 28.86 seconds (files took 10.67 seconds to load)
1504 examples, 0 failures
Line Coverage: 92.79% (5162 / 5563)
[TEST PROF INFO] Time spent in factories: 00:17.544 (49.5% of total time)

rspec: [ee]

Coverage report available at https://code0-tech.gitlab.io/-/development/sagittarius/-/jobs/14618945989/artifacts/tmp/coverage/index.html
Test summary available at https://gitlab.com/code0-tech/development/sagittarius/-/pipelines/2564935694/test_report
Finished in 26.77 seconds (files took 12.95 seconds to load)
1468 examples, 0 failures
Line Coverage: 93.0% (5009 / 5386)
[TEST PROF INFO] Time spent in factories: 00:16.181 (46.23% of total time)

rspec: [ce]

Coverage report available at https://code0-tech.gitlab.io/-/development/sagittarius/-/jobs/14618945988/artifacts/tmp/coverage/index.html
Test summary available at https://gitlab.com/code0-tech/development/sagittarius/-/pipelines/2564935694/test_report
Finished in 24.86 seconds (files took 10.06 seconds to load)
1418 examples, 0 failures
Line Coverage: 92.52% (4833 / 5224)
[TEST PROF INFO] Time spent in factories: 00:14.962 (48.82% of total time)

docs:preview

Documentation preview available at https://code0-tech.gitlab.io/-/development/telescopium/-/jobs/14618953485/artifacts/out/index.html

rubocop

855 files inspected, no offenses detected

@raphael-goetz raphael-goetz merged commit 2177f14 into #779-runtime-usage-service May 31, 2026
1 check passed
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.

3 participants