Skip to content

Provide a set of examples references from the documentation #41

Open
@devraj

Description

@devraj

Is your feature request related to a problem? Please describe.
It would be good to have runnable examples for the end user to be able to almost copy and paste and run on their console. Particularly when it comes to using the API client.

Describe the solution you'd like
Inspired by the developer experience provided by companies like Stripe who do an excellent job at providing accurate examples of runnable code.

While we reference examples in our documentation we should also maintain a folder of examples which the developers can vendor in.

Note that we have a strong set of tests that we can draw from and the cli demonstrates the use of most of the endpoints.

The aim of this is to extend these working examples and keep them in sync.

A point to consider is how we are going to keep these up to date as the project evolves.

Describe alternatives you've considered
NA

Additional context
See projects shillelagh for examples

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions