Sample data utility

[naz]

Problem

Sample data used across different actions/triggers is often duplicated and needs synchronization.

Solution

• as a warm up - update the member's sample data to the newest available (more context in this issue)
• Make an audit of of what is actually returned currently.
  • a good source for the returned data could be our API response snapshots present in e2e tests
  • for webhooks completing and using https://github.com/TryGhost/Toolbox/issues/223 would be great!
• Create an utility which would store sample data in a consistent way. ~When working on it API versioning should be taken into account. ~ There's no longer API versioning since Ghost v5.
  • for now this could be quite a manual filling out of data, just to make things work in a nicer way for Zapier clients. in the future we could come up with some automatic way of syncing the sample data (or at least notifying us of a change in the API response). few ways that come off the bat: looking up changes in snapshot files for relevant endpoints OR having Open API endpoint definition files that would generate sample content for Zapier integraion.

References

• Slack convo
• Specific problem a Zapier client was facing.

[naz]

@royalfig this issue requires a little bit of experimentation around how to orgranize the "sample data" so that it's maintainable long term. Right now it's really hard to get an overview of what sample data is prompted to the user and where it's coming from on Ghost side. The very first point in the todo list might be a good exploration task to do first to familiarize yourself with what kind of beast we are dealing with here. Let me know if you need any help figuring that bit out!