LornaJane

Welcome! I’m Lorna: open source technology leader and developer experience engineer. I’m a striking combination of technical experience, communication skills, and a genuine love for enabling others to succeed. I’m a leader, an engineer, a writer, a user champion, an open source maintainer, and a public speaker. My passion is taking great technology, and making it a great experience for users.

On this site you’ll find my blog, links to things I’ve done in other places, and my contact details. I’m always happy to hear from others in the industry and you are welcome to reach out to me with requests for articles, podcasts, or speaking – I can’t do everything, but that doesn’t stop me trying!

From The Blog

28 Nov

2023

Add OpenAI flags to OpenAPI descriptions

With OpenAI’s new Actions feature allowing you to get a GPT that uses your own API, many new doors are open. However giving an AI an access token the keys to your API and telling it to have fun may lead you to realise that one of the doors available leads to the empty lift shaft of overwritten data, or the bottomless well of cloud bill shock. To reduce the risks, OpenAI supports an extension x-openai-isConsequential that you can add to your OpenAPI description, to indicate which endpoints should not be called without a human confirmation step.

I’m not doing much with OpenAI right now, but I do plenty with OpenAPI and the question “how do I add this field to my existing API description?” is one that I can answer! What’s more, you can use the advice in this post to add other extensions or additions to your OpenAPI descriptions using Overlays, this advice isn’t OpenAI-specific, but it’s used in the examples. Continue reading →

Posted in tech | Leave a reply

20 Nov

2023

When to version bump your OpenAPI description

I’ve heard a variety of bad advice (and some untruths!) regarding how to version your OpenAPI description lately. Rather than dig into those, instead I’ll share my opinion on how I like to version API descriptions in my own projects. Every API project is different, but perhaps there’s something here that can help your project too. Continue reading →

Posted in tech | Leave a reply

08 Nov

2023

API docs previews with Redoc and Netlify

I talk to a lot of people about their API lifecycles and processes, and one thing that has value in almost every case is immediate documentation preview for all updates to an OpenAPI description. The time it takes to set it up (about ten minutes now I know what to do) is an investment that makes every future change easier to propose, review, and accept. Here’s my recipe for open source OpenAPI documentation using Redoc (disclaimer: I work for Redocly, who publish Redoc) with the files pushed to Netlify for hosting (but it’s HTML, so really any hosting will do and you should feel free to adapt the instructions for your preferred platform, and then share them in the comments). Continue reading →

Posted in tech | Leave a reply

From The Blog

Add OpenAI flags to OpenAPI descriptions

When to version bump your OpenAPI description

API docs previews with Redoc and Netlify

Talks, Articles, Podcasts, and More

Docs-As-Code, for Coders

Repeatably Better APIs

API governance without tears

OpenAPI for Documentarians

Design-first APIs with OpenAPI

OpenAPI for Documentarians