apollographql / apollo-studio-community

🎡  GraphQL developer portal featuring an IDE (Apollo Explorer), auto-documentation, metrics reporting, and more. This repo is for issues, feature requests, and preview docs. 📬
https://studio.apollographql.com
249 stars 29 forks source link

Add ability to report server version to the changelog #269

Open DillonSadofsky opened 10 months ago

DillonSadofsky commented 10 months ago

Context

Apollo studio has a really great graphql schema diff tool at https://studio.apollographql.com/graph//variant//changelog We use it for our internal dev variants and production variants (deployments). I often point third party developers at a deployed variant as a place where they can view a readme, explore schema, and prototype queries in the sandbox.

That said, the changelog notes additions/subtractions by date, but in all correspondence, we refer to what was added or removed by server/schema semver version #. Our clients often take version updates on different dates, or even in bulk, so this takes time and effort to 'map' to our version #'s when in communication with the user.

The readme mentions version control, but I can't find anything in the GraphOS or apollo studio docs about having a version # reported in a first party way. I figure I can 'fake' this by having an endpoint whose 'name' is the version and then the changelog would show -version.5_0 and +version.6_0 but that feels pretty hacky. I assume there has to be a better way?

What type of feedback is this?

Is there anything else you'd like to share about the Platform API?

No