<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <title>michaelheap.com</title>
  <subtitle>Thoughts on leadership, code and how to fix odd edge cases in tools (not necessarily in that order)</subtitle>
  <link href="https://michaelheap.com/rss" rel="self"/>
  <link href="https://michaelheap.com"/>
  <updated>2025-02-18T17:15:37Z</updated>
  <id>https://michaelheap.com</id>
  <author>
    <name>Michael Heap</name>
    <email>[email protected]</email>
  </author>
  
  <entry>
    <title>Using AWS credential_process and 1Password</title>
    <link href="https://michaelheap.com/aws-credential-helper-1password/"/>
    <updated>2025-02-18T17:15:37Z</updated>
    <id>https://michaelheap.com/aws-credential-helper-1password/</id>
    <content type="html">&lt;p&gt;A while back I read an excellent post from Paul Galow on &lt;a href=&quot;https://paulgalow.com/securing-aws-credentials-macos-lastpass&quot;&gt;securing AWS credentials with LastPass&lt;/a&gt;. I wanted exactly this, but with 1Password instead. Here&#39;s how to do it.&lt;/p&gt;
&lt;h2 id=&quot;configure-1password&quot; tabindex=&quot;-1&quot;&gt;Configure 1Password&lt;/h2&gt;
&lt;p&gt;If you don’t already have &lt;code&gt;op&lt;/code&gt; installed, you’ll need to install the &lt;a href=&quot;https://developer.1password.com/docs/cli/&quot;&gt;op CLI&lt;/a&gt; from the 1Password website.&lt;/p&gt;
&lt;p&gt;Once that’s done, create a new vault for storing secrets that are accessible from the CLI:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;op vault create CLI&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;Then create a new item in that vault, making sure to replace &lt;code&gt;XXX&lt;/code&gt; with your actual access key and secret:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; op item create --category Password --vault CLI --title AWSCredentials ACCESS_KEY=XXX SECRET_KEY=XXX&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;blockquote&gt;
&lt;p&gt;The above command is prefixed with a space so that it is not written to your shell history if &lt;code&gt;HIST_IGNORE_SPACE&lt;/code&gt; is enabled&lt;/p&gt;
&lt;/blockquote&gt;
&lt;h2 id=&quot;create-the-credential_process&quot; tabindex=&quot;-1&quot;&gt;Create the credential_process&lt;/h2&gt;
&lt;p&gt;The AWS CLI has the ability to read credentials from a process rather than a static configuration file. It expects that the credential process will return a JSON document containing &lt;code&gt;AccessKeyid&lt;/code&gt; and &lt;code&gt;SecretAccessKey&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;Copy and paste the following in to a terminal to create the credentials script:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;export&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; AWS_HELPER=&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;$&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;HOME&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;/bin/aws-1password&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;mkdir -p &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;$&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;HOME&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;/bin&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;echo&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&#39;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;#!/usr/bin/env bash&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;readonly opVault=&quot;CLI&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;readonly opEntry=&quot;AWSCredentials&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;readonly accessKeyId=$(op read &quot;op://$opVault/$opEntry/ACCESS_KEY&quot;)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;readonly secretAccessKey=$(op read &quot;op://$opVault/$opEntry/SECRET_KEY&quot;)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;# Create JSON object that AWS CLI expects&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;jq -n \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;    --arg accessKeyId &quot;$accessKeyId&quot; \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;    --arg secretAccessKey &quot;$secretAccessKey&quot; \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;    &quot;.Version = 1&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;    | .AccessKeyId = \$accessKeyId&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;    | .SecretAccessKey = \$secretAccessKey&quot;&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&#39;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;&amp;gt;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;$&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;AWS_HELPER&lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;chmod +x &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;$&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;AWS_HELPER&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;h2 id=&quot;configure-aws&quot; tabindex=&quot;-1&quot;&gt;Configure AWS&lt;/h2&gt;
&lt;p&gt;The final thing to do is to create an AWS config file that uses that script to fetch authentication credentials:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;mkdir -p &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;$&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;HOME&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;/.aws&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;echo&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;[default]&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;credential_process = &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;$&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;AWS_HELPER&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;&amp;gt;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;$&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;HOME&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;/.aws/config&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;To check if it worked, run &lt;code&gt;aws configure list&lt;/code&gt;. You should be prompted for your 1Password credentials to unlock the vault.&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;$ aws configure list&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      Name                    Value             Type    Location&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      ----                    -----             ----    --------&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;   profile                &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;&amp;lt;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;not set&lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;&amp;gt;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;             None    None&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;access_key      &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;****************&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;XYZ   custom-process&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;secret_key      &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;****************&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;XYZ   custom-process&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    region                &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;&amp;lt;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;not set&lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;&amp;gt;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;             None    None&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
</content>
  </entry>
  
  <entry>
    <title>Slack channels are free</title>
    <link href="https://michaelheap.com/slack-channels-are-free/"/>
    <updated>2025-02-12T20:51:45Z</updated>
    <id>https://michaelheap.com/slack-channels-are-free/</id>
    <content type="html">&lt;p&gt;“Should we create a new Slack channel for this?”&lt;/p&gt;
&lt;p&gt;I’ve not seen a topic as divisive as this since the days of tabs vs spaces (tl;dr: &lt;a href=&quot;https://adamtuttle.codes/blog/2021/tabs-vs-spaces-its-an-accessibility-issue/&quot;&gt;use tabs&lt;/a&gt;). Whenever there’s a suggestion to create a new channel, there are fervent discussions about why it’s a good/bad idea, with strong feelings on both sides.&lt;/p&gt;
&lt;p&gt;I’m firmly in camp “as many channels as needed, sometimes more channels than employees”. Once you hit a certain size, having a few firehose channels for everything means that 80%+ of the messages in a channel are irrelevant to the majority of the audience.&lt;/p&gt;
&lt;p&gt;Instead, spin up a new channel for each area of focus. This allows you to keep your working groups small (12 rather than 1200 people) and lets people focus on the channels that are important day to day.&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Extra credit:&lt;/strong&gt; If you really want to help people focus, ensure that you use threads to prevent unread notifications. If you see a topic that you want to follow, click the “get notified about new replies” option in the context menu for the top level message.&lt;/p&gt;
&lt;h2 id=&quot;the-power-of-focused-channels&quot; tabindex=&quot;-1&quot;&gt;The Power of Focused Channels&lt;/h2&gt;
&lt;p&gt;Using specific channels for each topic has immediate benefits. Scoping conversations down to a topic rather than it being a free for all provides consumers with:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Notification control&lt;/li&gt;
&lt;li&gt;Easier searching&lt;/li&gt;
&lt;li&gt;Single purpose channels (e.g. discussion, alerts etc)&lt;/li&gt;
&lt;li&gt;The correct audience&lt;/li&gt;
&lt;/ol&gt;
&lt;p&gt;Even Slack recommends using more, topic specific channels:&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;When you set up multiple topic- and project-specific channels, groups can focus their discussions among smaller numbers of people, helping them to align and move faster. And having lots of specific channels means that each person can participate in fewer channels, because only a handful of them will be necessary for their daily work.&lt;br /&gt;
 &lt;br /&gt;
via &lt;a href=&quot;https://slack.com/intl/en-gb/resources/using-slack/how-to-organize-your-slack-channels&quot;&gt;https://slack.com/intl/en-gb/resources/using-slack/how-to-organize-your-slack-channels&lt;/a&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;h3 id=&quot;fewer-unnecessary-notifications&quot; tabindex=&quot;-1&quot;&gt;Fewer Unnecessary Notifications&lt;/h3&gt;
&lt;p&gt;Being able to manage notifications is my favourite reason to use more Slack channels. Not all messages are created equally, but when they land in the same channel I have to manually read and filter the messages in my head.&lt;/p&gt;
&lt;p&gt;For concrete example, imagine a company that has a single &lt;code&gt;#general&lt;/code&gt; channel. It’s a place where company updates are shared, but also a place where people chat about the weekend. As a consumer I have to follow the channel in case I miss anything but the signal to noise ratio is low.&lt;/p&gt;
&lt;p&gt;Now imagine that this channel is split in to &lt;code&gt;#announcements&lt;/code&gt; and &lt;code&gt;#watercooler&lt;/code&gt;. I can safely mute or leave the water cooler channel while paying close attention to &lt;code&gt;#announcements&lt;/code&gt;.&lt;/p&gt;
&lt;h3 id=&quot;find-what-you-need%E2%80%94fast&quot; tabindex=&quot;-1&quot;&gt;Find What You Need—Fast&lt;/h3&gt;
&lt;p&gt;Once you have separate channels, searching becomes much easier. All you need is a keyword or two and the channel that you recall seeing the conversation in.&lt;/p&gt;
&lt;p&gt;When working on some new documentation, I searched in the &lt;code&gt;#support&lt;/code&gt; channel for “flubjam”, the name of the product I was working on (no, thats not the real product name). This surfaced all the issues customers were having with the product that I can now weave in to the updated documentation.&lt;/p&gt;
&lt;h3 id=&quot;dedicated-channels%2C-better-workflows&quot; tabindex=&quot;-1&quot;&gt;Dedicated Channels, Better Workflows&lt;/h3&gt;
&lt;p&gt;If we take the notification control benefit and supercharge it, we get to “single use channels”. Slack can do so much more than be a chat room for your team.&lt;/p&gt;
&lt;p&gt;A &lt;em&gt;large&lt;/em&gt; portion of my Slack usage is monitoring events:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;A new post on Stack Overflow with a specific tag goes to &lt;code&gt;#stack-overflow&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;New GitHub issues and releases for the flubjam project are piped in to &lt;code&gt;#notify-flubjam&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;All GitHub activity for the flubjam project is piped in to &lt;code&gt;#firehose-flubjam&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;Posts elsewhere on Slack that get a floppy disk icon are cross posted to &lt;code&gt;#zmeta-saved&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;Creating single use channels gives people the information that they need, when they need it.&lt;/p&gt;
&lt;h3 id=&quot;reach-the-right-people%2C-every-time&quot; tabindex=&quot;-1&quot;&gt;Reach the Right People, Every Time&lt;/h3&gt;
&lt;p&gt;Finally, using single purpose channels means that your audience is probably the one you’re looking for. Instead of blasting your question to 1200 people in a general channel, you can ask a targeted group your specific question.&lt;/p&gt;
&lt;p&gt;I find this much easier than trying to figure out who’s involved in a project to set up a five way DM (which will inevitably miss out a key person who then feels slighted that I forgot them).&lt;/p&gt;
&lt;h2 id=&quot;finding-the-right-channels&quot; tabindex=&quot;-1&quot;&gt;Finding the Right Channels&lt;/h2&gt;
&lt;p&gt;So if focused channels are so great, why don’t we all do it? There’s an easy answer:&lt;/p&gt;
&lt;p&gt;&lt;strong&gt;Finding new channels is hard&lt;/strong&gt;.&lt;/p&gt;
&lt;p&gt;There are a couple of ways to solve this problem. The most effective ones I’ve seen are:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Have a channel that announces new channels (very meta!)&lt;/li&gt;
&lt;li&gt;Set a reminder to check for new channels weekly using the Channels-&amp;gt;Browse Channels option. Usually there haven’t been that many created in the last 7 days.&lt;/li&gt;
&lt;li&gt;You can rely on people to invite you. Usually they won’t invite you directly. Instead, they’ll mention you by your Slack username, realise that you’re not there and then click “invite”. This means you only join channels when there is something for you to actively participate in&lt;/li&gt;
&lt;li&gt;Finally, update your onboarding documentation with links to relevant channels (you do have onboarding documentation, right? 😁)&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&quot;where-should-you-post%3F&quot; tabindex=&quot;-1&quot;&gt;Where Should You Post?&lt;/h2&gt;
&lt;p&gt;Ok, so you have lots of tightly scoped channels. You’ve joined the channels relevant to your day to day work, and now you have a question about the “flubjam” project.&lt;/p&gt;
&lt;p&gt;Do you post in &lt;code&gt;#team-product&lt;/code&gt;, &lt;code&gt;#flubjam-is-cool&lt;/code&gt; or &lt;code&gt;#general&lt;/code&gt;?&lt;/p&gt;
&lt;p&gt;Channel naming schemes can help with this. One of the patterns I’ve seen at a few different places now is to have an “&lt;code&gt;#ask-team-name&lt;/code&gt;” channel that is public. Have a question for finance? &lt;code&gt;#ask-finance&lt;/code&gt;! Curious about the product roadmap? &lt;code&gt;#ask-product&lt;/code&gt;!&lt;/p&gt;
&lt;p&gt;If you’re small enough that you have 1-3 products, keeping a single &lt;code&gt;#ask-product&lt;/code&gt; channel makes sense.&lt;/p&gt;
&lt;p&gt;As you expand your product offering, you may want to expand to “&lt;code&gt;#ask-product-name&lt;/code&gt;” style channels, such as “&lt;code&gt;#ask-dev-portal&lt;/code&gt;”. This allows the &lt;a href=&quot;https://medium.com/design-bootcamp/the-power-of-the-product-triad-0e76801a384d&quot;&gt;product triad&lt;/a&gt; to answer the questions as a team rather than the questions going to a specific department all the time.&lt;/p&gt;
&lt;p&gt;Finally, each product is made up of various initiatives and deliverables. You likely have a “&lt;code&gt;#private-team-a&lt;/code&gt;” channel that you use to discuss ongoing projects, but I encourage you to bring that conversation in to “&lt;code&gt;#project-name&lt;/code&gt;” channels. Not only does it give you a single place to read for any given project, it invites collaboration with other teams who may have suggestions based on their experience. These channels are short lived and should be archived as soon as the project is completed.&lt;/p&gt;
&lt;p&gt;To recap:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;#ask-team-name&lt;/code&gt; to get started&lt;/li&gt;
&lt;li&gt;&lt;code&gt;#ask-product-name&lt;/code&gt; as the team grows&lt;/li&gt;
&lt;li&gt;&lt;code&gt;#project-name&lt;/code&gt; to stop conversation sprawl and build a culture of collaboration&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;With concrete examples:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;#ask-product&lt;/code&gt; for general product questions&lt;/li&gt;
&lt;li&gt;&lt;code&gt;#ask-flubjam&lt;/code&gt; for all flubjam related questions&lt;/li&gt;
&lt;li&gt;&lt;code&gt;#project-flubjam-capacitors&lt;/code&gt; is a short term channel to talk about implementing capacitors in flubjam&lt;/li&gt;
&lt;/ul&gt;
&lt;h2 id=&quot;create-that-slack-channel&quot; tabindex=&quot;-1&quot;&gt;Create That Slack Channel&lt;/h2&gt;
&lt;p&gt;Focused channels improve notification control, make searching easier, ensure the right audience sees your messages, and unlock powerful workflows beyond just chat. While discoverability can be a challenge, a few simple strategies—like clear naming conventions—can make it easy for people to find the right spaces.&lt;/p&gt;
&lt;p&gt;At the end of the day, good Slack hygiene isn’t about having fewer channels—it’s about having the &lt;strong&gt;right&lt;/strong&gt; channels.&lt;/p&gt;
&lt;h2 id=&quot;update%3A-super-bonus-content&quot; tabindex=&quot;-1&quot;&gt;Update: Super Bonus Content&lt;/h2&gt;
&lt;p&gt;I shared a preview of this post with some colleagues and &lt;a href=&quot;https://www.linkedin.com/in/jasonhnaustin&quot;&gt;Jason&lt;/a&gt; had some great feedback on how to cope with channel sprawl:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;strong&gt;Housecleaning built-in:&lt;/strong&gt; If you have a topic that is not meant to be long-lived, a convention that flags the channel (usually &lt;code&gt;#temp-&lt;/code&gt;) signifies that when the topic is resolved, the channel dies. This helps address the channel sprawl problem, and intentionally redirects folks back to long-lived comms channels, vs tactical problem solving.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;Join many, star few:&lt;/strong&gt; the likelihood that you keep up with the conversation in every channel you join, in a &amp;quot;Slack channels are free&amp;quot; environment, is pretty much zero. Missing critical notifications on people you are working with regularly is a big risk to productivity, and job security in some cases. Star key channels, and mark your closest collaborators and reporting chain as &amp;quot;VIP&amp;quot;, so they are on a short-list to focus your attention.&lt;/li&gt;
&lt;li&gt;&lt;strong&gt;Ruthless prioritization on &amp;quot;Leave Channel&amp;quot;:&lt;/strong&gt; if you&#39;re not contributing or engaging in a channel, leave it immediately. If you&#39;re mentioned, you&#39;ll be notified, and you can rejoin.&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;As someone that left &lt;em&gt;175&lt;/em&gt; Slack channels in his January cleanup, that last point on ruthless priorization is key. I&#39;m already back in some of them, but I know it&#39;s because I&#39;m actively engaged rather than through inertia.&lt;/p&gt;
</content>
  </entry>
  
  <entry>
    <title>Excellent Pull Request Reviews</title>
    <link href="https://michaelheap.com/pull-request-reviews/"/>
    <updated>2025-02-05T03:55:49Z</updated>
    <id>https://michaelheap.com/pull-request-reviews/</id>
    <content type="html">&lt;p&gt;Pull request reviews are a critical part of building high-quality products, but too often, they become a rubber-stamping exercise—skim, “LGTM,” approve. This kind of review can lead to broken code, unclear documentation, and missed opportunities for improvement.&lt;/p&gt;
&lt;p&gt;A great PR review isn’t just about glancing at the code; it’s about &lt;strong&gt;running the changes&lt;/strong&gt;, &lt;strong&gt;thinking critically about what’s missing&lt;/strong&gt;, and &lt;strong&gt;providing actionable feedback&lt;/strong&gt;.&lt;/p&gt;
&lt;h2 id=&quot;run-the-thing&quot; tabindex=&quot;-1&quot;&gt;Run the thing&lt;/h2&gt;
&lt;p&gt;If I could only have one rule for reviewing pull requests, it would be “did you run it?”. Far too often I see people skimming over the content, giving it a “LGTM” and pressing approve.&lt;/p&gt;
&lt;p&gt;This happens &lt;em&gt;everywhere&lt;/em&gt;. My most recent example is a project that is migrating documentation from one platform to another. All of the content already exists, so it’s just about reformatting and publishing it elsewhere, right?&lt;/p&gt;
&lt;p&gt;No. No, no, &lt;em&gt;no&lt;/em&gt;. You see, a lot of the documentation doesn’t work. Maybe it didn’t work when it was originally published (“LGTM!”). Maybe it did, and it’s rotted over time and no longer works.&lt;/p&gt;
&lt;p&gt;So now we have a new definition of done for the migration work. Before you submit a pull request for review, you need to work through the content from top to bottom and ensure it works. Then your reviewer has to do the same.&lt;/p&gt;
&lt;p&gt;Having two people test the same thing ensures that the documentation is clear, isn’t missing implicit knowledge and most of all, that it works.&lt;/p&gt;
&lt;p&gt;If you’re building software rather than writing docs, good news, the same process works! Having two people &lt;em&gt;use&lt;/em&gt; the software makes sure that it meets the requirements, uncovers edge cases and generally helps build better products.&lt;/p&gt;
&lt;h2 id=&quot;what%E2%80%99s-missing%3F&quot; tabindex=&quot;-1&quot;&gt;What’s missing?&lt;/h2&gt;
&lt;p&gt;Looking at a pull request and saying “LGTM” is only half of the review. You also need to think about what you’re &lt;strong&gt;not&lt;/strong&gt; looking at. What should be there, but isn’t?&lt;/p&gt;
&lt;p&gt;Are there any missing tests? Missing docs? How about example configuration or usage examples for the feature that you just added?&lt;/p&gt;
&lt;p&gt;Spotting what isn’t there is one of the hardest things to learn when reviewing PRs, but it’s also one of the most impactful. Being able to say “this looks great, but I think we should add a test for when X” helps build better products.&lt;/p&gt;
&lt;h2 id=&quot;is-this-blocking%3F&quot; tabindex=&quot;-1&quot;&gt;Is this blocking?&lt;/h2&gt;
&lt;p&gt;As you add more comments to a pull request (and you &lt;em&gt;will&lt;/em&gt; add more comments if you’re actually running what’s there and thinking about what’s missing), it can be hard to understand which pieces of feedback are opinions, and which require changes.&lt;/p&gt;
&lt;p&gt;To make it obvious for the original author, I recommend prefixing feedback if it doesn’t need to be actioned immediately.&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;em&gt;No prefix&lt;/em&gt;: This is important feedback for the current PR&lt;/li&gt;
&lt;li&gt;&lt;em&gt;future&lt;/em&gt;: Could we refactor this into something that’s reusable?&lt;/li&gt;
&lt;li&gt;&lt;em&gt;nit&lt;/em&gt;: I find it easier to parse when using early returns rather than else blocks&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;By following this pattern of feedback you can ensure that you provide all the context you have in the PR without worrying about preventing the original author from shipping.&lt;/p&gt;
&lt;p&gt;I’ve been on the receiving end of this type of feedback, and it’s been great to learn what &lt;em&gt;could&lt;/em&gt; be done given more time. I don’t always go back and fix the &lt;em&gt;nit&lt;/em&gt; comments, but it always makes me think about what I can do differently next time.&lt;/p&gt;
&lt;h2 id=&quot;do-the-work&quot; tabindex=&quot;-1&quot;&gt;Do the work&lt;/h2&gt;
&lt;p&gt;Last, but by no means least, do the work yourself. I don’t mean “pull down the branch and make changes” (though in at least one of my teams that &lt;em&gt;is&lt;/em&gt; the default operating model and it works well).&lt;/p&gt;
&lt;p&gt;I mean use GitHub’s suggestions macro when reviewing a pull request. If you have a suggestion how to improve something, instead of trying to explain it in text you can edit the lines yourself using the following format:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;```&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;suggestion&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;This line will be suggested instead of the one that you selected&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;```&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;Not only is making the actual change easier to parse for the original author, they can quickly apply any changes they agree with by clicking “add to batch” in the web UI.&lt;/p&gt;
&lt;h2 id=&quot;go-forth-and-review&quot; tabindex=&quot;-1&quot;&gt;Go forth and review&lt;/h2&gt;
&lt;p&gt;By making sure the code works, thinking critically about what’s missing, and clearly distinguishing between blocking and non-blocking comments, reviewers can significantly improve the quality of the product. And when possible, making direct suggestions instead of just pointing out issues can streamline the process for everyone.&lt;/p&gt;
&lt;p&gt;A great review isn’t just about catching issues. It&#39;s about fostering collaboration, improving maintainability, and ultimately, building better products. So next time you review a PR, take the time to do it right. Your team (and your future self) will thank you.&lt;/p&gt;
</content>
  </entry>
  
  <entry>
    <title>Run go test -tags in VSCode</title>
    <link href="https://michaelheap.com/go-test-tags/"/>
    <updated>2025-01-10T13:01:15Z</updated>
    <id>https://michaelheap.com/go-test-tags/</id>
    <content type="html">&lt;p&gt;I&#39;ve been writing more Go recently, and the &lt;a href=&quot;https://code.visualstudio.com/docs/languages/go#_test&quot;&gt;Go extension&lt;/a&gt; for VSCode provides an awesome &lt;em&gt;Run Test&lt;/em&gt; button inline.&lt;/p&gt;
&lt;p&gt;In many of our projects, we have a combination of unit and integration tests. To keep &lt;code&gt;go test&lt;/code&gt; quick, the integration tests have an &lt;code&gt;integration&lt;/code&gt; tag enabled. This means that the &lt;em&gt;Run Test&lt;/em&gt; button doesn&#39;t work for integration tests.&lt;/p&gt;
&lt;p&gt;To make them work, add the following to &lt;code&gt;.vscode/settings.json&lt;/code&gt; in your project:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;json&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;{&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;go.testFlags&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;[&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;-v&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;],&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;go.testTags&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;integration&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;}&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
</content>
  </entry>
  
  <entry>
    <title>Flatten nested foreach loops with Terraform</title>
    <link href="https://michaelheap.com/terraform-flatten-nested-loops/"/>
    <updated>2024-09-12T09:26:22Z</updated>
    <id>https://michaelheap.com/terraform-flatten-nested-loops/</id>
    <content type="html">&lt;p&gt;Given a list of identifiers and an associated list of values, here&#39;s how to flatten them all down to a single list of unique values.&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;hcl&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #616E88&quot;&gt;# Define your input data. We&#39;ll convert this in to a list of ${name}-${version} values&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;variable&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt; &quot;ai_providers&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; {&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; list(object({&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    name     = string&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    versions = list(string)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  }))&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;default&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; [&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    {&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      name     = &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;OpenAI&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      versions = [&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;gpt-3.5-turbo&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;gpt-4o&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;]&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    },&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    {&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;name&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;     &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;Anthropic&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;versions&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; [&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;Opus&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;Sonnet&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;Haiku&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;]&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    },&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    {&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;name&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;     &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;Mistral&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;versions&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; [&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;7B&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;8x7B&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;8x22B&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;]&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    },&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    {&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;name&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;     &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;llama3&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;versions&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; [&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;8B&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;70B&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;]&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    },&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  ]&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;}&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #616E88&quot;&gt;## Flatmap using nested loops and flatten()&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;locals&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; {&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;ai_providers_flattened&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; flatten([&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    for provider in var&lt;/span&gt;&lt;span style=&quot;color: #B48EAD&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;ai_providers : [&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      for version in provider&lt;/span&gt;&lt;span style=&quot;color: #B48EAD&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;versions : {&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        version  = version&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        provider = provider&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        key      = &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;${provider&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;.name&lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;}&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;-&lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;${version}&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      }&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    ]&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  ])&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;}&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #616E88&quot;&gt;# Iterate over the flattened list to create resources&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;resource&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt; &quot;demo_foo&quot; &quot;my_resource&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; {&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;for_each&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; { for api in local.ai_providers_flattened : api.key =&amp;gt; api }&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;name&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;     &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; each&lt;/span&gt;&lt;span style=&quot;color: #B48EAD&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;value&lt;/span&gt;&lt;span style=&quot;color: #B48EAD&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;provider&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;version&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; each&lt;/span&gt;&lt;span style=&quot;color: #B48EAD&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;value&lt;/span&gt;&lt;span style=&quot;color: #B48EAD&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;version&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;}&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;The &lt;code&gt;for_each = { for api in local.ai_providers_flattened : api.key =&amp;gt; api }&lt;/code&gt; line confused me for a while. This line is used to identify the resource later as &lt;code&gt;my_resource&lt;/code&gt; is now a map of objects rather than a single object. Let&#39;s walk through it step by step&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;demo_foo.my_resource&lt;/code&gt; is a map of objects&lt;/li&gt;
&lt;li&gt;&lt;code&gt;demo_foo.my_resource[api.key]&lt;/code&gt; points to a single resource&lt;/li&gt;
&lt;li&gt;&lt;code&gt;api.key&lt;/code&gt; is defined as &lt;code&gt;&amp;quot;${provider.name}-${version}&amp;quot;&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;Details for the &lt;code&gt;demo_foo&lt;/code&gt; resource for OpenAI gpt-4o is available at &lt;code&gt;demo_foo.my_resource[&amp;quot;OpenAI-gpt-4o&amp;quot;]&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
</content>
  </entry>
  
  <entry>
    <title>Bind a Hyper/Meh key with Keychron Launcher</title>
    <link href="https://michaelheap.com/keychron-launcher-hyper-meh/"/>
    <updated>2024-09-05T07:55:33Z</updated>
    <id>https://michaelheap.com/keychron-launcher-hyper-meh/</id>
    <content type="html">&lt;p&gt;I&#39;ve been using a &lt;a href=&quot;https://www.keychron.com/products/keychron-q1-he-qmk-wireless-custom-keyboard&quot;&gt;Keychron Q1 HE&lt;/a&gt; this week instead of my trusty Ergodox EZ as I&#39;ve been travelling.&lt;/p&gt;
&lt;p&gt;One of the biggest issues I had is that none of my keyboard shortcuts were working as I didn&#39;t have a &lt;code&gt;hyper&lt;/code&gt; key bound. I could have used something like Karabiner to rebind keys, but I knew I could do it at the keyboard level.&lt;/p&gt;
&lt;p&gt;It took me far too long to figure out, so I&#39;m writing it down for future me.&lt;/p&gt;
&lt;h2 id=&quot;configuring-hyper%2Fmeh-keys&quot; tabindex=&quot;-1&quot;&gt;Configuring Hyper/Meh keys&lt;/h2&gt;
&lt;p&gt;First of all, VIA App doesn&#39;t work for the Q1 HE. You have to use the Keychron configuration UI at &lt;a href=&quot;https://www.launcher.keychron.com/#/keymap&quot;&gt;https://www.launcher.keychron.com/&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;I learned about the &lt;code&gt;Any&lt;/code&gt; key definition from &lt;a href=&quot;https://www.reddit.com/r/Keychron/comments/17yv7nk/comment/ks710n9/&quot;&gt;this useful Reddit comment&lt;/a&gt;. On the keymap screen, select &lt;code&gt;Custom&lt;/code&gt; then &lt;code&gt;Any&lt;/code&gt;. It will show a text input where you should put the keys to send.&lt;/p&gt;
&lt;p&gt;&lt;em&gt;Be aware - the key that you&#39;re binding will change as you type on the keyboard. After entering the keys, click on the key that you want to bind before pressing Enter.&lt;/em&gt;&lt;/p&gt;
&lt;p&gt;To create a &lt;code&gt;Hyper&lt;/code&gt; (Left Control + Shift + Alt + GUI) key, enter &lt;code&gt;HYPR(KC_NO)&lt;/code&gt;. To create a &lt;code&gt;Meh&lt;/code&gt; (Left Control + Shift + Alt) key, enter &lt;code&gt;MEH(KC_NO)&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;The &lt;code&gt;GUI&lt;/code&gt; key is &lt;code&gt;cmd&lt;/code&gt; on MacOS, and the Windows key on Windows.&lt;/p&gt;
&lt;p&gt;The &lt;code&gt;KC_NO&lt;/code&gt; parameter tells QMK not to send any additional keycodes with the modifiers. This allows you to press other keys on the keyboard.&lt;/p&gt;
&lt;p&gt;Personally, I like to define a &lt;code&gt;LCAG(KC_NO)&lt;/code&gt; (Left Control + Alt + GUI) key. This means I can have a single key as my keyboard trigger, and double the number of available shortcuts by additionally pressing &lt;code&gt;Shift&lt;/code&gt;.&lt;/p&gt;
&lt;h2 id=&quot;learn-more-about-qmk&quot; tabindex=&quot;-1&quot;&gt;Learn more about QMK&lt;/h2&gt;
&lt;p&gt;The full list of modifier keys is available in the &lt;a href=&quot;https://docs.qmk.fm/feature_advanced_keycodes#modifier-keys&quot;&gt;QMK docs&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;I&#39;ve used prebuilt modifiers such as &lt;code&gt;HYPR&lt;/code&gt; and &lt;code&gt;LCAG&lt;/code&gt;, but you can also nest them to build composite modifiers. e.g. Send &lt;code&gt;ctrl+alt&lt;/code&gt; with &lt;code&gt;LCTL(LALT(KC_NO))&lt;/code&gt;. You can change &lt;code&gt;KC_NO&lt;/code&gt; for a key to send a full key combination, e.g. &lt;code&gt;ctrl+alt+delete&lt;/code&gt; with &lt;code&gt;LCTL(LALT(KC_DEL))&lt;/code&gt;&lt;/p&gt;
</content>
  </entry>
  
  <entry>
    <title>Downloading webcomics with Dosage</title>
    <link href="https://michaelheap.com/download-webcomics/"/>
    <updated>2024-05-20T16:25:59Z</updated>
    <id>https://michaelheap.com/download-webcomics/</id>
    <content type="html">&lt;p&gt;I’ve been reading some webcomics for a few years, but never went back to the beginning to learn how each character was introduced. I liked the idea, but with 5000+ posts in some feeds, I constantly lost my position and/or had better things to do.&lt;/p&gt;
&lt;p&gt;I recently spent some time on holiday and decided to try and copy the whole series on to my iPad to read. I intended to write a small app to download a series and convert to a &lt;code&gt;.cbz&lt;/code&gt; file, but it turns out it already exists.&lt;/p&gt;
&lt;h2 id=&quot;dosage&quot; tabindex=&quot;-1&quot;&gt;Dosage&lt;/h2&gt;
&lt;p&gt;&lt;a href=&quot;https://dosage.rocks/&quot;&gt;Dosage&lt;/a&gt; is a Python CLI designed to download webcomics in to a folder. I always have issues installing Python apps, so I looked to see if Dosage was available as a Docker image. It wasn’t, but it wasn’t too difficult to package up.&lt;/p&gt;
&lt;p&gt;If you want to do the same, create a &lt;code&gt;Dockerfile&lt;/code&gt; with the following contents:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;docker&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;FROM&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; python:bullseye&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #616E88&quot;&gt;# Install pipx&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;RUN&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; python3 -m pip install --user pipx \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    &amp;&amp; python3 -m pipx ensurepath&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #616E88&quot;&gt;# Install dosage&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;RUN&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; /root/.local/bin/pipx install &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;dosage[css,bash] @ git+https://github.com/webcomics/dosage.git&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;ENTRYPOINT&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; [&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;&quot;/root/.local/bin/dosage&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;]&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;Build the image (you don’t need to clone the Dosage repo - the Dockerfile will do it for you):&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;docker build -t dosage &lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;.&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;Then finally, add an alias for the a &lt;code&gt;dosage&lt;/code&gt; command. This is optional, but encouraged:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;alias&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; dosage=&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&#39;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;docker run --rm -v $(pwd):/Comics dosage:latest&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&#39;&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;Finally, run &lt;code&gt;dosage&lt;/code&gt; to download the comic of your choice:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;dosage --list&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;dosage -a TheOrderOfTheStick&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;h2 id=&quot;create-a-cbz&quot; tabindex=&quot;-1&quot;&gt;Create a CBZ&lt;/h2&gt;
&lt;p&gt;A &lt;code&gt;.cbz&lt;/code&gt; file is a renamed zip file. To create one:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;zip -r oots.cbz TheOrderOfTheStick/&lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;*&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;Now you can copy the &lt;code&gt;.cbz&lt;/code&gt; in to the comic app of your choice.&lt;/p&gt;
</content>
  </entry>
  
  <entry>
    <title>Presentations on an ultrawide monitor</title>
    <link href="https://michaelheap.com/presenting-ultrawide/"/>
    <updated>2024-05-13T09:17:51Z</updated>
    <id>https://michaelheap.com/presenting-ultrawide/</id>
    <content type="html">&lt;p&gt;I &lt;em&gt;love&lt;/em&gt; having an ultra wide monitor, but it does make presenting tricky at times. All of the available conferencing systems allow you to share either a single window, or all of your screen. For most people, sharing a single window which is the right size works.&lt;/p&gt;
&lt;p&gt;For me, it doesn’t. Most of the time I’m switching between a code editor, web browser and terminal. I need a way to share a 1080p section of my screen, no matter which window it’s showing.&lt;/p&gt;
&lt;p&gt;Here are the two options I use:&lt;/p&gt;
&lt;ol&gt;
&lt;li&gt;Use Zoom to share a specific area of the screen + Hammerspoon to position the windows&lt;/li&gt;
&lt;li&gt;Use &lt;a href=&quot;https://github.com/Stengo/DeskPad&quot;&gt;DeskPad&lt;/a&gt; + any other conferencing tool&lt;/li&gt;
&lt;/ol&gt;
&lt;h2 id=&quot;zoom-and-hammerspoon&quot; tabindex=&quot;-1&quot;&gt;Zoom and Hammerspoon&lt;/h2&gt;
&lt;p&gt;This is the approach I use 99% of the time. It fits my existing workflow with a single display and allows me to drag things in to view as needed (or rather, use the Hammerspoon shortcut below).&lt;/p&gt;
&lt;p&gt;This approach consists of two sections. The first is to position the window where it needs to be using Hammerspoon. I have a keyboard binding for this:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;lua&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;function&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;setWindowPosition&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;(&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;key&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;,&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;w&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;,&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;h&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;,&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;x&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;,&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;y&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  hs.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;hotkey&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;bind&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;({&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;cmd&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;alt&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;ctrl&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;shift&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;}, key, &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;function&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;()&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;local&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; win &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; hs.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;window&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;focusedWindow&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;()&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;local&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; cursize &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; win:&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;size&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;()&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    cursize.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;w&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; w&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    cursize.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;h&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; h&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;local&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; f &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; win:&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;frame&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;()&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    f.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;x&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; x&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    f.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;y&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; y&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    win:&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;setFrame&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;(f)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    win:&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;setSize&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;(cursize)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;end&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;end&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;setWindowPosition&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;(&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;P&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #B48EAD&quot;&gt;1920&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #B48EAD&quot;&gt;1080&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #B48EAD&quot;&gt;2420&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #B48EAD&quot;&gt;285&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;) &lt;/span&gt;&lt;span style=&quot;color: #616E88&quot;&gt;-- Right&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;&lt;code&gt;2420, 285&lt;/code&gt; places the window 2420px from the left, and 285px down from the top of my screen. This is just below where my camera is mounted, allowing me to see the window and also look at the camera.&lt;/p&gt;
&lt;p&gt;The second trick is to use Zoom’s “Portion of screen” option and select the area of the screen that your window covers.&lt;/p&gt;
&lt;div class=&quot;w-2/3 m-auto&quot;&gt;
&lt;div class=&quot;image-wrapper &quot;&gt;&lt;picture&gt; &lt;source class=&quot;&quot; type=&quot;image/webp&quot; srcset=&quot;https://michaelheap.com/images/presenting-ultrawide/zoom-advanced-share.png/Yxd1gRTGKy-320.webp 320w, https://michaelheap.com/images/presenting-ultrawide/zoom-advanced-share.png/Yxd1gRTGKy-640.webp 640w, https://michaelheap.com/images/presenting-ultrawide/zoom-advanced-share.png/Yxd1gRTGKy-960.webp 960w&quot; sizes=&quot;(max-width: 320px) 320px, (max-width: 640px) 640px, (max-width: 960px) 960px, 100vw&quot; /&gt; &lt;img class=&quot;&quot; alt=&quot;Zoom advanced sharing options&quot; src=&quot;https://michaelheap.com/images/presenting-ultrawide/zoom-advanced-share.png/Yxd1gRTGKy-960.jpeg&quot; sizes=&quot;(max-width: 320px) 320px, (max-width: 640px) 640px, (max-width: 960px) 960px, 100vw&quot; srcset=&quot;https://michaelheap.com/images/presenting-ultrawide/zoom-advanced-share.png/Yxd1gRTGKy-320.jpeg 320w, https://michaelheap.com/images/presenting-ultrawide/zoom-advanced-share.png/Yxd1gRTGKy-640.jpeg 640w, https://michaelheap.com/images/presenting-ultrawide/zoom-advanced-share.png/Yxd1gRTGKy-960.jpeg 960w&quot; width=&quot;960&quot; height=&quot;629&quot; /&gt; &lt;/picture&gt;&lt;/div&gt;
&lt;/div&gt;
&lt;p&gt;At this point the core problem is solved, but there’s one remaining thing that frustrated me. The app switcher shows when I &lt;code&gt;cmd+tab&lt;/code&gt;, but some icons are cut off as I’m only sharing part of the screen.&lt;/p&gt;
&lt;p&gt;To solve this, I bind specific windows to a keyboard shortcut with Hammerspoon and switch using the keyboard. This prevents the app switcher from showing on screen.&lt;/p&gt;
&lt;p&gt;I use &lt;code&gt;cmd+alt+ctrl+shift+y&lt;/code&gt; to bind the focused window to &lt;code&gt;y&lt;/code&gt;, and &lt;code&gt;cmd+alt+ctrl+y&lt;/code&gt; to switch to it instantly. I have six hotkeys bound, which provides plenty of windows if I need them.&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;lua&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;function&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;windowSwitch&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;(&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;binder&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;local&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; windowId &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #B48EAD&quot;&gt;0&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  hs.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;hotkey&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;bind&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;({&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;cmd&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;alt&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;ctrl&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;shift&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; }, binder, &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;function&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;()&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    windowId &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;=&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; hs.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;window&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;focusedWindow&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;():&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;id&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;();&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;end&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  hs.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;hotkey&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;bind&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;({&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;cmd&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;alt&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;ctrl&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;}, binder, &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;function&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;()&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    hs.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;window&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;find&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;(windowId):&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;focus&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;();&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;end&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;end&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;windowSwitch&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;(&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;y&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;windowSwitch&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;(&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;u&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;windowSwitch&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;(&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;i&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;windowSwitch&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;(&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;h&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;windowSwitch&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;(&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;j&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;)&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;windowSwitch&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;(&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;k&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;)&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;h2 id=&quot;deskpad&quot; tabindex=&quot;-1&quot;&gt;DeskPad&lt;/h2&gt;
&lt;p&gt;Not all conferencing systems allow you to share a portion of your screen like Zoom. If I’m presenting through an app that doesn’t allow you to share a specific area &lt;em&gt;and&lt;/em&gt; I need to show multiple windows, I use &lt;a href=&quot;https://github.com/Stengo/DeskPad&quot;&gt;DeskPad&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;DeskPad adds a virtual screen to your Mac, and an app that shows what’s on that screen. This allows you to share your entire “screen” whilst still keeping the majority of your ultra wide available for other things.&lt;/p&gt;
&lt;p&gt;I configure DeskPad’s screen to be above my usual screen to make it easy to drag windows on to it.&lt;/p&gt;
&lt;p&gt;If you’re feeling really fancy, you can combine DeskPad and Hammerspoon to move windows to DeskPad with a keyboard shortcut:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;lua&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;hs.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;hotkey&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;bind&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;({&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;cmd&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;alt&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;ctrl&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; }, &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;, &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;function&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;()&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  hs.&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9&quot;&gt;window&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;.&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;focusedWindow&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;():&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;moveToScreen&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;(&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&#39;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;Deskpad&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&#39;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;):&lt;/span&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;maximize&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;()&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;end&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;)&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;h2 id=&quot;the-end&quot; tabindex=&quot;-1&quot;&gt;The End&lt;/h2&gt;
&lt;p&gt;If you&#39;re using Zoom, I can highly recommend the first approach. I use it daily and it hasn&#39;t failed me yet. If you&#39;re using a conferencing platform that doesn&#39;t allow you to share a portion of your screen, DeskPad is a great tool that lets you share a virtual screen at the resolution you desire.&lt;/p&gt;
</content>
  </entry>
  
  <entry>
    <title>Kong Gateway Quickstart</title>
    <link href="https://michaelheap.com/kong-quickstart/"/>
    <updated>2024-05-07T08:34:54Z</updated>
    <id>https://michaelheap.com/kong-quickstart/</id>
    <content type="html">&lt;p&gt;A &lt;code&gt;$dayjob&lt;/code&gt; related TIL today. Here&#39;s how to quickly deploy Kong Gateway locally with the Dev Portal enabled (you&#39;ll need an enterprise license).&lt;/p&gt;
&lt;p&gt;This is useful for testing things locally.&lt;/p&gt;
&lt;p&gt;Run the Gateway:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;curl -Ls https://get.konghq.com/quickstart &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;|&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; PROXY_PORT=80 bash -s -- -m \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    -e KONG_PASSWORD=changeme \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    -e KONG_ADMIN_GUI_URL=http://manager.example \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    -e KONG_ADMIN_GUI_API_URL=http://admin.example \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    -e KONG_PORTAL_GUI_PROTOCOL=http \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    -e KONG_PORTAL_API_URL=http://portalapi.example \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    -e KONG_PORTAL_GUI_HOST=portal.example \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    -e KONG_PORTAL_SESSION_CONF=&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&#39;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;{&quot;cookie_name&quot;: &quot;portal_session&quot;, &quot;secret&quot;: &quot;PORTAL_SUPER_SECRET&quot;, &quot;storage&quot;: &quot;kong&quot;, &quot;cookie_secure&quot;: false, &quot;cookie_domain&quot;:&quot;.example&quot;}&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&#39;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    -e KONG_PORTAL=&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;on&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    -e KONG_LICENSE_DATA \&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    -t 3.4&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;Create routes that proxy based on host name:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;curl -X POST localhost:8001/services -d name=admin -d url=http://localhost:8001&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;curl -X POST localhost:8001/services -d name=manager -d url=http://localhost:8002&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;curl -X POST localhost:8001/services -d name=portal -d url=http://localhost:8003&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;curl -X POST localhost:8001/services -d name=portalapi -d url=http://localhost:8004&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;curl -X POST localhost:8001/services/admin/routes -d hosts=admin.example&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;curl -X POST localhost:8001/services/manager/routes -d hosts=manager.example&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;curl -X POST localhost:8001/services/portal/routes -d hosts=portal.example&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;curl -X POST localhost:8001/services/portalapi/routes -d hosts=portalapi.example&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;Add those domains to your &lt;code&gt;/etc/hosts&lt;/code&gt; file:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;bash&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #88C0D0&quot;&gt;echo&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&#39;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;127.0.0.1   proxy.example&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;127.0.0.1   admin.example&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;127.0.0.1   manager.example&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;127.0.0.1   portal.example&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;127.0.0.1   portalapi.example&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&#39;&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;|&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; sudo tee -a /etc/hosts&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;Now you can visit &lt;a href=&quot;http://manager.example/&quot;&gt;http://manager.example&lt;/a&gt; and log in with &lt;code&gt;kong_admin&lt;/code&gt; / &lt;code&gt;changeme&lt;/code&gt;.&lt;/p&gt;
</content>
  </entry>
  
  <entry>
    <title>Designing OpenAPI Schemas</title>
    <link href="https://michaelheap.com/openapi-schema-design/"/>
    <updated>2024-04-27T19:36:48Z</updated>
    <id>https://michaelheap.com/openapi-schema-design/</id>
    <content type="html">&lt;p&gt;I’ve written a &lt;em&gt;lot&lt;/em&gt; of OpenAPI schemas over the last couple of years, and have developed a pattern that helps with maintenance. You have a minimum of two logical schemas for every entity in your system, &lt;code&gt;Foo&lt;/code&gt; and &lt;code&gt;FooRequest &lt;/code&gt;. &lt;code&gt;Foo&lt;/code&gt; is a union of &lt;code&gt;FooRequest&lt;/code&gt; and any computed fields from the system.&lt;/p&gt;
&lt;p&gt;Let’s look as a concrete example, a &lt;code&gt;Pet&lt;/code&gt; in an adoption shelter. A pet has two user set fields, &lt;code&gt;name&lt;/code&gt; and &lt;code&gt;type&lt;/code&gt;, and one computed field, &lt;code&gt;created_at&lt;/code&gt;. You can’t set the &lt;code&gt;created_at&lt;/code&gt; field when creating or updating a pet, which means we have two schemas:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;PetRequest &lt;/code&gt;: &lt;code&gt;name&lt;/code&gt;, &lt;code&gt;type&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;Pet&lt;/code&gt;: &lt;code&gt;name&lt;/code&gt;, &lt;code&gt;type&lt;/code&gt;, &lt;code&gt;created_at&lt;/code&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;blockquote&gt;
&lt;p&gt;The following example isn&#39;t the best way to accomplish the GET/POST split! It&#39;s shown as it&#39;s a common pattern used in many specifications, but keep reading for a better solution.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;When you model this with JSON schema, it looks like the following:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;yaml&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;components&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;schemas&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;PetRequest&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;object&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;properties&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;name&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;          &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;string&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;          &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;string&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;Pet&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;allOf&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;-&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;$ref&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;#/components/schemas/PetRequest&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;-&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;object&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;          &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;properties&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;            &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;created_at&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;              &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;string&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;Any updates to the &lt;code&gt;PetRequest&lt;/code&gt; object will automatically be reflected in the &lt;code&gt;Pet&lt;/code&gt; object. However, this is such a common pattern that OpenAPI has keywords to help built in.&lt;/p&gt;
&lt;h2 id=&quot;simplify-with-readonly%3A-true&quot; tabindex=&quot;-1&quot;&gt;Simplify with &lt;code&gt;readOnly: true&lt;/code&gt;&lt;/h2&gt;
&lt;p&gt;If you can split your schema in to &amp;quot;user provided&amp;quot; and &amp;quot;computed&amp;quot; values cleanly, you only need a single schema thanks to the &lt;code&gt;readOnly&lt;/code&gt; keyword.&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;yaml&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;components&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;schemas&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;Pet&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;object&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;properties&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;name&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;          &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;string&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;          &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;string&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;created_at&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;          &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;string&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;          &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;readOnly&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;true&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;The &lt;code&gt;readOnly&lt;/code&gt; keyword causes the schema to be split in to two virtual schemas - one for &lt;code&gt;GET&lt;/code&gt; and one for &lt;code&gt;POST&lt;/code&gt;/&lt;code&gt;PATCH&lt;/code&gt;/&lt;code&gt;PUT&lt;/code&gt;. Any OpenAPI renderer (I tested with Redoc) will remove &lt;code&gt;created_at&lt;/code&gt; from the &lt;code&gt;POST&lt;/code&gt; schema.&lt;/p&gt;
&lt;h2 id=&quot;complex-apis&quot; tabindex=&quot;-1&quot;&gt;Complex APIs&lt;/h2&gt;
&lt;p&gt;In an ideal world, you wouldn’t need more than one single &lt;code&gt;Pet&lt;/code&gt; schema. However, we live in the real world and sometimes there are additional requirements. Here are some examples:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;Pets have an &lt;code&gt;adopted_at&lt;/code&gt; time, which can only be set when updating a pet, not when creating&lt;/li&gt;
&lt;li&gt;Pets have a &lt;code&gt;total_steps&lt;/code&gt; field which is computed from an external source that is not cached and is too expensive to show when listing multiple pets&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;These requirements mean that we have to split &lt;code&gt;Pet&lt;/code&gt; in to two, &lt;code&gt;Pet&lt;/code&gt; and &lt;code&gt;CreatePetRequest&lt;/code&gt;. We also need a &lt;code&gt;MinimalPet&lt;/code&gt; representation for the &lt;code&gt;GET /pets&lt;/code&gt; endpoint. This results in three distinct schemas:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;CreatePetRequest&lt;/code&gt;: &lt;code&gt;name&lt;/code&gt;, &lt;code&gt;type&lt;/code&gt;&lt;/li&gt;
&lt;li&gt;&lt;code&gt;Pet&lt;/code&gt;: &lt;code&gt;name&lt;/code&gt;, &lt;code&gt;type&lt;/code&gt;, &lt;code&gt;adopted_at&lt;/code&gt; (readOnly), &lt;code&gt;created_at&lt;/code&gt; (readOnly)&lt;/li&gt;
&lt;li&gt;&lt;code&gt;PetWithDetails&lt;/code&gt;: &lt;code&gt;name&lt;/code&gt;, &lt;code&gt;type&lt;/code&gt;, &lt;code&gt;adopted_at&lt;/code&gt; (readOnly), &lt;code&gt;total_steps&lt;/code&gt; (readOnly), &lt;code&gt;created_at&lt;/code&gt; (readOnly)&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;These schemas can be composed to build the entities we need at runtime. &lt;code&gt;CreatePetRequest&lt;/code&gt; is the base as it contains the minimum available information. &lt;code&gt;Pet&lt;/code&gt; builds on this by adding &lt;code&gt;adopted_at&lt;/code&gt; and &lt;code&gt;created_at&lt;/code&gt;. Finally, &lt;code&gt;PetWithDetails&lt;/code&gt; adds computed fields that are expensive to calculate such as &lt;code&gt;total_steps&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;&lt;code&gt;CreatePetRequest&lt;/code&gt; -&amp;gt; &lt;code&gt;Pet&lt;/code&gt; -&amp;gt; &lt;code&gt;PetWithDetails&lt;/code&gt;.&lt;/p&gt;
&lt;p&gt;Expressed using JSON schema, it looks like this:&lt;/p&gt;
&lt;pre class=&quot;shiki nord&quot; style=&quot;background-color: #2e3440ff; color: #d8dee9ff&quot;&gt;&lt;div class=&quot;language-id&quot;&gt;yaml&lt;/div&gt;&lt;div class=&quot;code-container&quot;&gt;&lt;code&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;components&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;  &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;schemas&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;CreatePetRequest&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;object&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;properties&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;name&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;          &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;string&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;          &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;string&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;Pet&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;allOf&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;-&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;$ref&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;#/components/schemas/CreatePetRequest&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;-&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;object&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;          &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;properties&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;            &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;adopted_at&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;              &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;string&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;            &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;created_at&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;              &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;string&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;              &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;readOnly&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;true&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;    &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;PetWithDetails&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;      &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;allOf&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;-&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;$ref&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;#/components/schemas/Pet&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;&quot;&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;        &lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;-&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;object&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;          &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;properties&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;            &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;total_steps&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;              &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;type&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #A3BE8C&quot;&gt;string&lt;/span&gt;&lt;/div&gt;&lt;div class=&quot;line&quot;&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt;              &lt;/span&gt;&lt;span style=&quot;color: #8FBCBB&quot;&gt;readOnly&lt;/span&gt;&lt;span style=&quot;color: #ECEFF4&quot;&gt;:&lt;/span&gt;&lt;span style=&quot;color: #D8DEE9FF&quot;&gt; &lt;/span&gt;&lt;span style=&quot;color: #81A1C1&quot;&gt;true&lt;/span&gt;&lt;/div&gt;&lt;/code&gt;&lt;/div&gt;&lt;/pre&gt;
&lt;p&gt;This gets expanded to the following schemas (courtesy of Swagger UI):&lt;/p&gt;
&lt;div class=&quot;image-wrapper &quot;&gt;&lt;picture&gt; &lt;source class=&quot;m-auto&quot; type=&quot;image/webp&quot; srcset=&quot;https://michaelheap.com/images/openapi-schema-design/swagger-ui-schemas.png/5PIDCJlZnV-320.webp 320w, https://michaelheap.com/images/openapi-schema-design/swagger-ui-schemas.png/5PIDCJlZnV-640.webp 640w&quot; sizes=&quot;(max-width: 320px) 320px, (max-width: 640px) 640px, 100vw&quot; /&gt; &lt;img class=&quot;m-auto&quot; alt=&quot;Swagger UI rendering of schemas&quot; src=&quot;https://michaelheap.com/images/openapi-schema-design/swagger-ui-schemas.png/5PIDCJlZnV-640.jpeg&quot; sizes=&quot;(max-width: 320px) 320px, (max-width: 640px) 640px, 100vw&quot; srcset=&quot;https://michaelheap.com/images/openapi-schema-design/swagger-ui-schemas.png/5PIDCJlZnV-320.jpeg 320w, https://michaelheap.com/images/openapi-schema-design/swagger-ui-schemas.png/5PIDCJlZnV-640.jpeg 640w&quot; width=&quot;640&quot; height=&quot;880&quot; /&gt; &lt;/picture&gt;&lt;/div&gt;
&lt;p&gt;Here&#39;s a &lt;a href=&quot;https://gist.github.com/mheap/99d32429e2f579cce925d968aa30e6a9&quot;&gt;complete OpenAPI specification&lt;/a&gt; that uses these schemas.&lt;/p&gt;
&lt;h2 id=&quot;an-ideal-world&quot; tabindex=&quot;-1&quot;&gt;An ideal world&lt;/h2&gt;
&lt;p&gt;Although the model works for APIs that have complex requirements, I consider needing separate models for create and update requests a design flaw. In this example API, you could make &lt;code&gt;adopted_at&lt;/code&gt; a nullable field and use the same schema for both create and update requests.&lt;/p&gt;
&lt;p&gt;I also consider needing a minimal representation of an entity a design flaw.There are cases where there is a real requirement that needs these schemas (e.g. if &lt;code&gt;total_steps&lt;/code&gt; must &lt;em&gt;always&lt;/em&gt; be accurate and can’t be cached) but these cases are rare.&lt;/p&gt;
&lt;p&gt;If you find yourself using more than one schema, take a moment to reconsider your API design and see how you can simplify it.&lt;/p&gt;
</content>
  </entry>
</feed>