samples

OpenAPI Spec: I hand wrote an OAS definition. The preceding link showcases the final API reference. Each endpoint includes examples, accurate data types and nullability, and consistent, descriptive naming across requests, responses, and parameters.

Python Scripts: I write Python scripts with accompanying tutorials. This one calls an endpoint, applies a client-side filter that isn’t supported by query parameters, then calls another endpoint to action the data. The tutorial guides the user through the script’s functions with the goal of teaching how to use the endpoints in a live scenario. It follows the Diátaxis documentation framework.

Procedural Content: Procedural content is common to all technical writing. I write a lot of it. Here is an example of a quickstart that shows the user what they need to do to get started in three steps.