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

feat: structured output #285

Closed
lrlna opened this issue Feb 19, 2021 · 2 comments · Fixed by #676
Closed

feat: structured output #285

lrlna opened this issue Feb 19, 2021 · 2 comments · Fixed by #676
Assignees
Labels
feature 🎉 new commands, flags, functionality, and improved error messages
Milestone

Comments

@lrlna
Copy link
Member

lrlna commented Feb 19, 2021

Description

Several of Rover's commands would benefit from structured output. The working assumption is this would be in the form of JSON payloads of a defined shape (and likely with a defined "envelope" where every command offering structured output would have the same top-level keys and a payload specific to the output).

Working assumption is we'd have a flag like --json or --output json

@lrlna lrlna added the feature 🎉 new commands, flags, functionality, and improved error messages label Feb 19, 2021
@lrlna lrlna modified the milestones: 0.0.3, 0.0.6, 0.0.5 Feb 19, 2021
@abernix
Copy link
Member

abernix commented Mar 3, 2021

As a use-case from apollo-tooling: apollographql/apollo-tooling#2213:

Sugestion

Would be awesome if we can pass a flag --json to apollo service:list to consume the output or have a programmatic version of apollo service:list to create nodejs scripts based on the output of this command.

Why

I want to create a variant schema based on another variant, to enable things like app reviews. The idea is to enable into PRs to publish an app review of a specific service and compose this service with the current staging schema.

@lrlna lrlna modified the milestones: March 30 - GA, May 4 Mar 12, 2021
@JakeDawkins JakeDawkins modified the milestones: May 11 - GA, Qx Apr 28, 2021
@ndintenfass ndintenfass modified the milestones: Qx, June 8 May 24, 2021
@EverlastingBugstopper EverlastingBugstopper modified the milestones: June 8, June 22 Jun 2, 2021
@abernix
Copy link
Member

abernix commented Jun 3, 2021

Here's my own framing of a use case that was brought to my attention:

JSON output enables implementors to build their own presentation layer or Dashboard for this data and display it to their developers within existing deployment pipelines. It integrates well with other tools — like Splunk — to generate reports about which subgraphs are failing (and for which reasons) and display overall deployment health at a glance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature 🎉 new commands, flags, functionality, and improved error messages
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants