OpenFn / OpenFn/apollo

Send apollo version back to lightning

Open
#489 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

monitoring
Dominant language
Jupyter Notebook
Stars
5
Forks
10
Avg merge
2d 20h
Merged PRs (30d)
17

Description

All apollo APIs should include a version number in the response. This helps us analyse metrics by seeing which version generated a certain payload.

We could do this in a few ways:

  • as a response header on all responses. Totally generic. Metrics tools would have to look for it and use it
  • as a top-level property in all payloads. I don't love mandating this, and it might be too direct. But makes it easier to reason about
  • as a property on the meta key. The most obvious approach. Might be a bit hard to use in metrics though - perhaps we can pull it out of the response payload

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by inventorying the Apollo API response shapes, then compare the response-header, top-level, and meta-key options. Done means the project has chosen and documented one version location that is present in every API response and usable for metrics.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.