Congratulations!

[Valid RSS] This is a valid RSS feed.

Recommendations

This feed is valid, but interoperability with the widest range of feed readers could be improved by implementing the following recommendations.

Source: http://akrabat.com/feed/

  1. <?xml version="1.0" encoding="UTF-8"?><rss version="2.0"
  2. xmlns:content="http://purl.org/rss/1.0/modules/content/"
  3. xmlns:wfw="http://wellformedweb.org/CommentAPI/"
  4. xmlns:dc="http://purl.org/dc/elements/1.1/"
  5. xmlns:atom="http://www.w3.org/2005/Atom"
  6. xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
  7. xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
  8. >
  9.  
  10. <channel>
  11. <title>Rob Allen</title>
  12. <atom:link href="https://akrabat.com/feed/" rel="self" type="application/rss+xml" />
  13. <link>https://akrabat.com</link>
  14. <description>Pragmatism in the real world</description>
  15. <lastBuildDate>Thu, 19 Jun 2025 10:43:01 +0000</lastBuildDate>
  16. <language>en-US</language>
  17. <sy:updatePeriod>
  18. hourly </sy:updatePeriod>
  19. <sy:updateFrequency>
  20. 1 </sy:updateFrequency>
  21. <generator>https://wordpress.org/?v=6.8.1</generator>
  22. <item>
  23. <title>FIxing Linux Tailscale exit node routing</title>
  24. <link>https://akrabat.com/fixing-linux-tailscale-exit-node-routing/</link>
  25. <comments>https://akrabat.com/fixing-linux-tailscale-exit-node-routing/#respond</comments>
  27. <dc:creator><![CDATA[Rob]]></dc:creator>
  28. <pubDate>Tue, 24 Jun 2025 09:00:00 +0000</pubDate>
  29. <category><![CDATA[Computing]]></category>
  30. <guid isPermaLink="false">https://akrabat.com/?p=7401</guid>
  31.  
  32. <description><![CDATA[I run a Tailscale network so that remote computers can access local services. I also have a Linux box at home on that network that advertises itself as an exit node and recently noticed that it wasn't working. I had some time recently to sit down and work out what was going on. My initial suspicion was that it was DNS related as a cursory search brought up lots of results related to DNS. However,… <a href="https://akrabat.com/fixing-linux-tailscale-exit-node-routing/">continue reading</a>.]]></description>
  33. <content:encoded><![CDATA[<p>I run a <a href="https://tailscale.com/">Tailscale</a> network so that remote computers can access local services. I also have a Linux box at home on that network that advertises itself as an <a href="https://tailscale.com/kb/1103/exit-nodes">exit node</a> and recently noticed that it wasn't working.</p>
  34. <p>I had some time recently to sit down and work out what was going on. My initial suspicion was that it was DNS related as a cursory search brought up lots of results related to DNS. However, some quick tests with <tt>nslookup</tt> and <tt>dig</tt> showed that DNS was correctly resolving, so it seemed to be a routing issue.</p>
  35. <p>Further searching led me to realise that my Linux box needs to masquerade the traffic. This can be done using:</p>
  36. <pre>
  37. sudo iptables -t nat -A POSTROUTING -o {network interface} -j MASQUERADE
  38. </pre>
  39. <p>I used <tt>ifconfig</tt> to look up my network interface which was <tt>enp3s0</tt> and then all was well. </p>
  40. <p>I connected my Mac to the exit node from a remote location and could browse the web with my remote IP address correctly set to my home's IP address.</p>
  41. <p>Given that this was working, I'm unclear what has changed such that this setting needed configuring. I have found <a href="https://github.com/tailscale/tailscale/issues/15708">issue 15708</a> which may be related so potentially a future Tailscale update will solve this. I don't rebook this box often, so maybe I set this flag before and forgot?</p>
  42. <p>I've written it up here now though, so I can find it again if I need it!</p>
  43. ]]></content:encoded>
  45. <wfw:commentRss>https://akrabat.com/fixing-linux-tailscale-exit-node-routing/feed/</wfw:commentRss>
  46. <slash:comments>0</slash:comments>
  49. </item>
  50. <item>
  51. <title>Renaming files with Hazel</title>
  52. <link>https://akrabat.com/renaming-files-with-hazel/</link>
  53. <comments>https://akrabat.com/renaming-files-with-hazel/#respond</comments>
  55. <dc:creator><![CDATA[Rob]]></dc:creator>
  56. <pubDate>Tue, 17 Jun 2025 10:00:00 +0000</pubDate>
  57. <category><![CDATA[Mac]]></category>
  58. <guid isPermaLink="false">https://akrabat.com/?p=7390</guid>
  59.  
  60. <description><![CDATA[I'm a member of a number of groups that publish a magazine, either paper-based or PDF. I prefer the PDF version, so download from the website and then move to the relevant directory. Recently, I realised that I could use Hazel to do this for me. To take one example, the filename of the PDF that I download is of the format PE-{issue number}-web{some random characters}.pdf, for example: PE-123-web9j45s3gd.pdf. There's sometimes a hyphen after web,… <a href="https://akrabat.com/renaming-files-with-hazel/">continue reading</a>.]]></description>
  61. <content:encoded><![CDATA[<p>I'm a member of a number of groups that publish a magazine, either paper-based or PDF. I prefer the PDF version, so download from the website and then move to the relevant directory.</p>
  62. <p>Recently, I realised that I could use Hazel to do this for me.</p>
  63. <p>To take one example, the filename of the PDF that I download is of the format <tt>PE-{issue number}-web{some random characters}.pdf</tt>, for example: <tt>PE-123-web9j45s3gd.pdf</tt>. There's sometimes a hyphen after <tt>web</tt>, but not always.</p>
  64. <p>I want the filename to <tt>PE Magazine {issue number}</tt></p>
  65. <p>The rule in Hazel looks like this:</p>
  66. <picture><source  
  67. srcset="https://akrabat.com/wp-content/uploads/2025/06/2025hazel-rename-pe-mag-dark.png"
  68.        media="(prefers-color-scheme: dark)"
  69.    /><source
  70. srcset="https://akrabat.com/wp-content/uploads/2025/06/2025hazel-rename-pe-mag-light.png"
  71.        media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
  72.    /><br />
  73.    <img decoding="async" src="https://akrabat.com/wp-content/uploads/2025/06/2025hazel-rename-pe-mag-light.png" loading="lazy" alt="Screenshot of Hazel rename rule" width="500"/>
  74. </picture>
  75. <h2>Matching the name</h2>
  76. <p>Breaking it down, we detect that this is a file of interest with a <em>Name matches</em> rule. We can start with the literal string <tt>PE-</tt> as that's constant, but then we need to match the number and also give it a name so that we can refer to it later.</p>
  77. <p>This is done using the "Custom Text" element. You can then click on it to edit its attributes where I set its name to "issue" and the pattern to "Number" which matches sequential digits.</p>
  78. <picture><source  
  79. srcset="https://akrabat.com/wp-content/uploads/2025/06/2025hazel-match-attributes-dark.png"
  80.        media="(prefers-color-scheme: dark)"
  81.    /><source
  82. srcset="https://akrabat.com/wp-content/uploads/2025/06/2025hazel-match-attributes-light.png"
  83.        media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
  84.    /><br />
  85.    <img decoding="async" src="https://akrabat.com/wp-content/uploads/2025/06/2025hazel-match-attributes-light.png" loading="lazy" alt="Screenshot of Hazel match attributes screen" class="border" width="300"/>
  86. </picture>
  87. <p>The rest of the name match is a hyphen followed by an "Anything" element as we don't care about any other characters.</p>
  88. <p><tt>Renaming</tt></p>
  89. <p>Now that we have we can use the <em>Rename with pattern</em> action with the literal "<tt>PE Magazine - </tt>" followed by our "issue" custom element that we created in the match rule, followed by the extension.</p>
  90. <h2>Finishing it off</h2>
  91. <p>Once the file has been renamed, there's a "Move to folder" action to move it the right place and then the folder is opened, so that I can grab the file if I need to.</p>
  92. <p>That's it. Automating the rename and move means that I don't have to think about it again.</p>
  93. ]]></content:encoded>
  95. <wfw:commentRss>https://akrabat.com/renaming-files-with-hazel/feed/</wfw:commentRss>
  96. <slash:comments>0</slash:comments>
  99. </item>
  100. <item>
  101. <title>Updating SMTP relay in postfix</title>
  102. <link>https://akrabat.com/updating-smtp-relay-in-postfix/</link>
  103. <comments>https://akrabat.com/updating-smtp-relay-in-postfix/#respond</comments>
  105. <dc:creator><![CDATA[Rob]]></dc:creator>
  106. <pubDate>Tue, 10 Jun 2025 10:00:00 +0000</pubDate>
  107. <category><![CDATA[Computing]]></category>
  108. <category><![CDATA[Sysadmin]]></category>
  109. <guid isPermaLink="false">https://akrabat.com/?p=7383</guid>
  110.  
  111. <description><![CDATA[On a server that I help to maintain, it has postfix installed for emailing results of cron jobs and other status updates. This was set up to relay through SendGrid as they had a 100 email per month plan and we send out significantly fewer than that. Unfortunately, SendGrid are retiring their free plan, so I had to move to a new service and picked SMTP2GO and so had to update the postfix configuration. As… <a href="https://akrabat.com/updating-smtp-relay-in-postfix/">continue reading</a>.]]></description>
  112. <content:encoded><![CDATA[<p>On a server that I help to maintain, it has <a href="https://www.postfix.org">postfix</a> installed for emailing results of cron jobs and other status updates. This was set up to relay through SendGrid as they had a 100 email per month plan and we send out significantly fewer than that.</p>
  113. <p>Unfortunately, SendGrid are retiring their free plan, so I had to move to a new service and picked <a href="https://www.smtp2go.com">SMTP2GO</a> and so had to update the postfix configuration. As I didn't have this written down, I'm noting in here.</p>
  114. <h2>Get SMTP details</h2>
  115. <p>You need the <tt>SMTP hostname</tt>, <tt>SMTP username</tt> and <tt>SMTP password</tt>. SMTP2GO allows you to have multiple usernames and usefully allows you to rate limit each one individually, should you need that.</p>
  116. <h2>Configure postfix</h2>
  117. <h3>Firstly, update <tt>/etc/postfix/main.cf</tt></h3>
  118. <p>Find <tt>relayhost</tt> and change to <tt>[mail.smtp2go.com]:587</tt>. I'm just updating, so the rest of the settings I left alone. </p>
  119. <p>However, the relevant settings are:</p>
  120. <pre>
  121. relayhost = [mail.smtp2go.com]:587
  122. smtp_sasl_auth_enable = yes
  123. smtp_sasl_password_maps = hash:/etc/postfix/sasl_passwd
  124. smtp_sasl_security_options = noanonymous
  125. smtp_tls_CAfile = /etc/ssl/certs/ca-certificates.crt
  126. smtp_use_tls = yes
  127. </pre>
  128. <h3>Secondly, add the new SMTP user's credentials</h3>
  129. <p>Edit <tt>/etc/postfix/sasl_passwd</tt>. This needs to be done as root as the permissions on this file are <tt>600</tt> and it's owned by <tt>root:root</tt>.</p>
  130. <p>Add a new line with this format:</p>
  131. <pre>
  132. [mail.smtp2go.com]:587 {username}:{password}
  133. </pre>
  134. <p>Where <tt>{username}</tt> is the SMTP username and <tt>{password}</tt> is the SMTP password.</p>
  135. <p>Save the file and then create the hash database:</p>
  136. <pre>
  137. sudo postmap /etc/postfix/sasl_passwd
  138. </pre>
  139. <h3>Restart postfix</h3>
  140. <p>That's it, so just restart postfix with <tt>sudo service postfix restart</tt></p>
  141. ]]></content:encoded>
  143. <wfw:commentRss>https://akrabat.com/updating-smtp-relay-in-postfix/feed/</wfw:commentRss>
  144. <slash:comments>0</slash:comments>
  147. </item>
  148. <item>
  149. <title>Global word count on Mac using Shortcuts</title>
  150. <link>https://akrabat.com/global-word-count-on-mac-using-shortcuts/</link>
  151. <comments>https://akrabat.com/global-word-count-on-mac-using-shortcuts/#respond</comments>
  153. <dc:creator><![CDATA[Rob]]></dc:creator>
  154. <pubDate>Tue, 03 Jun 2025 10:00:00 +0000</pubDate>
  155. <category><![CDATA[Computing]]></category>
  156. <category><![CDATA[Mac]]></category>
  157. <guid isPermaLink="false">https://akrabat.com/?p=7361</guid>
  158.  
  159. <description><![CDATA[I've had a few cases recently when I wanted to know the number of words that I had written. To do this, I've copied the text to BBEdit which displays the word count in its status bar, but this is a bit of a faff. I finally sat down and created a Shortcut for it that took 10 mins. This is the shortcut: The idea is that I want to select the text and run… <a href="https://akrabat.com/global-word-count-on-mac-using-shortcuts/">continue reading</a>.]]></description>
  160. <content:encoded><![CDATA[<p>I've had a few cases recently when I wanted to know the number of words that I had written. To do this, I've copied the text to BBEdit which displays the word count in its status bar, but this is a bit of a faff.</p>
  161. <p>I finally sat down and created a Shortcut for it that took 10 mins.</p>
  162. <p>This is the shortcut:</p>
  163. <picture><source  
  164. srcset="https://akrabat.com/wp-content/uploads/2025/05/2025-05-word-count-shortcut-light.png"
  165.        media="(prefers-color-scheme: dark)"
  166.    /><source
  167. srcset="https://akrabat.com/wp-content/uploads/2025/05/2025-05-word-count-shortcut-light.png"
  168.        media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
  169.    /><br />
  170.    <img decoding="async" src="https://akrabat.com/wp-content/uploads/2025/05/2025-05-word-count-shortcut-light.png" loading="lazy" alt="Screenshort of Word Count shortcut" width="600"/>
  171. </picture>
  172. <p>The idea is that I want to select the text and run the shortcut without having to copy to the clipboard, so to do this, I enable "Use as Quick Action" on the Services menu. I also assigned a global shortcut of <tt>⌃⌥⇧⌘W</tt> for convenience, though going to the Services menu isn't hard.</p>
  173. <p>A Quick Action shortcut automatically gets a "Receive" input block, which I set to be just accept text input as it makes no sense to count words in other types of text. I also set it to look in the clipboard if there's no selection. Once we have input, we run it through the "Count" action and then pipe to a "Show Alert" so that the value can be seen. It's all quite easy.</p>
  174. <p>That's it. I can now select text and press </p>
  175. <pre>⌃⌥⇧⌘W</pre>
  176. <p> and the number of words is displayed!</p>
  177. <picture><source  
  178. srcset="https://akrabat.com/wp-content/uploads/2025/05/2025-05-wordcount-screenshot-dark.png"
  179.        media="(prefers-color-scheme: dark)"
  180.    /><source
  181. srcset="https://akrabat.com/wp-content/uploads/2025/05/2025-05-wordcount-screenshot-light.png"
  182.        media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
  183.    /><br />
  184.    <img decoding="async" src="https://akrabat.com/wp-content/uploads/2025/05/2025-05-wordcount-screenshot-light.png" loading="lazy" alt="Screenshort of output of Word Count shortcut" width="300"/>
  185. </picture>
  186. ]]></content:encoded>
  188. <wfw:commentRss>https://akrabat.com/global-word-count-on-mac-using-shortcuts/feed/</wfw:commentRss>
  189. <slash:comments>0</slash:comments>
  192. </item>
  193. <item>
  194. <title>Moving a Perforce P4 P4ROOT to a different drive</title>
  195. <link>https://akrabat.com/moving-a-perforce-p4-p4root-to-a-different-drive/</link>
  196. <comments>https://akrabat.com/moving-a-perforce-p4-p4root-to-a-different-drive/#respond</comments>
  198. <dc:creator><![CDATA[Rob]]></dc:creator>
  199. <pubDate>Tue, 27 May 2025 10:00:00 +0000</pubDate>
  200. <category><![CDATA[Software]]></category>
  201. <guid isPermaLink="false">https://akrabat.com/?p=7349</guid>
  202.  
  203. <description><![CDATA[On one of my servers here, I run a local Perforce P4 server for my son. He's a game developer and as they use P4 at work, he wanted to learn it in a sandbox and to have somewhere familiar to put his own work. Installation onto Ubuntu was easy enough and I provided access outside of our local network via Tailscale and all was well. Recently, I was doing some admin-stuff on the server… <a href="https://akrabat.com/moving-a-perforce-p4-p4root-to-a-different-drive/">continue reading</a>.]]></description>
  204. <content:encoded><![CDATA[<p>On one of my servers here, I run a local <a href="https://www.perforce.com/products/helix-core">Perforce P4</a> server for my son. He's a game developer and as they use P4 at work, he wanted to learn it in a sandbox and to have somewhere familiar to put his own work.</p>
  205. <p>Installation onto Ubuntu was easy enough and I provided access outside of our local network via <a href="https://tailscale.com">Tailscale</a> and all was well.</p>
  206. <p>Recently, I was doing some admin-stuff on the server and realised that the drive that P4 was using was the local 256GB drive rather than one of the big 8TB drives in the box, so I needed to move it. The directory that the instance was using was <tt>/opt/perforce/servers/p4d-holland1</tt>. This needed moving to <tt>/media/ssd1/data/perforce/servers/p4d-holland1</tt>.</p>
  207. <p><strong>Note</strong> I run a single instance, very default, not-very-important  P4 server. Don't just copy these steps blindly if your setup is more complicated or mission critical! Make sure that you <a href="https://help.perforce.com/helix-core/server-apps/p4sag/2024.1/Content/P4SAG/moving-same-machine.html">read the docs</a>.</p>
  208. <p>These are the steps I followed:</p>
  209. <ul>
  210. <li>Stop the instance: <tt>p4dctl stop p4d-holland1</tt></li>
  211. <li>Move the data by copying it and renaming the old directory (just in case):
  212. <pre>
  213. mkdir -p /media/ssd1/data/perforce/servers/p4d-holland1
  214. cp -r /opt/perforce/servers/p4d-holland1/* /media/ssd1/data/perforce/servers/p4d-holland1/
  215. mv /opt/perforce/servers/p4d-holland1 /opt/perforce/servers/p4d-holland1-old
  216. </pre>
  217. </li>
  218. <li>Edit <tt>/etc/perforce/p4dctl.conf.d/p4d-holland1.conf</tt> and update the <tt>P4ROOT</tt> to the new directory</li>
  219. <li>Start the instance again: <tt>p4dctl start p4d-holland1</tt></li>
  220. </ul>
  221. <p>I didn't see any errors, so I got my son to check it. After he said it was all good, I removed the old <tt>/opt/perforce/servers/p4d-holland1-old</tt> directory.</p>
  222. <p>My son now has more than enough space to continue his side-projects.</p>
  223. ]]></content:encoded>
  225. <wfw:commentRss>https://akrabat.com/moving-a-perforce-p4-p4root-to-a-different-drive/feed/</wfw:commentRss>
  226. <slash:comments>0</slash:comments>
  229. </item>
  230. <item>
  231. <title>Updated rst2pdf website</title>
  232. <link>https://akrabat.com/updated-rst2pdf-website/</link>
  233. <comments>https://akrabat.com/updated-rst2pdf-website/#respond</comments>
  235. <dc:creator><![CDATA[Rob]]></dc:creator>
  236. <pubDate>Tue, 20 May 2025 10:00:00 +0000</pubDate>
  237. <category><![CDATA[rst2pdf]]></category>
  238. <guid isPermaLink="false">https://akrabat.com/?p=7355</guid>
  239.  
  240. <description><![CDATA[Earlier this year, Lorna spent some time updating rst2pdf's website to use Sphinx. The nice thing about Sphinx is that it uses restructuredText, the same as rst2pdf does, so we now stay in the same ecosystem. While, we could have continued using Jekyll, it makes much more sense for us to use the same markup language as we use for the main tool, and our manual is written in it too. With the Jekyll system,… <a href="https://akrabat.com/updated-rst2pdf-website/">continue reading</a>.]]></description>
  241. <content:encoded><![CDATA[<p>Earlier this year, <a href="https://lornajane.net/about">Lorna</a> spent some time updating <a href="https://rst2pdf.org">rst2pdf</a>'s website to use <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a>. The nice thing about Sphinx is that it uses <a href="https://docutils.sourceforge.io/rst.html">restructuredText</a>, the same as rst2pdf does, so we now stay in the same ecosystem.</p>
  242. <p>While, we could have continued using Jekyll, it makes much more sense for us to use the same markup language as we use for the main tool, and our manual is written in it too. With the Jekyll system, we used docutils with a generic and simple CSS file to create the HTML version of the manual, but now as Sphinx is rST native, it builds the HTML version of the manual and it as it is now styled the same as the website, it looks much better. Of course, we use rst2pdf to generate the PDF version ;)</p>
  243. <p>Rather handily, we now have search on the site and also have a dark mode which you can see in this screenshot if your OS is in dark mode as you view this page. I also like that you can click on the "eye" icon and view the rST source for the page.</p>
  244. <picture><source  
  245. srcset="https://akrabat.com/wp-content/uploads/2025/05/2025-05-rst2pdf.org-dark.png"
  246.        media="(prefers-color-scheme: dark)"
  247.    /><source
  248. srcset="https://akrabat.com/wp-content/uploads/2025/05/2025-05-rst2pdf.org-light.png"
  249.        media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
  250.    /><br />
  251.    <img decoding="async" src="https://akrabat.com/wp-content/uploads/2025/05/2025-05-rst2pdf.org-light.png" loading="lazy" alt="2025 05 rst2pdf.org light." width="600"/>
  252. </picture>
  253. <p>This required a fair amount of work. Thanks Lorna for taking the time to do it!</p>
  254. ]]></content:encoded>
  256. <wfw:commentRss>https://akrabat.com/updated-rst2pdf-website/feed/</wfw:commentRss>
  257. <slash:comments>0</slash:comments>
  260. </item>
  261. <item>
  262. <title>Using OneOf for a property in an OpenAPI spec</title>
  263. <link>https://akrabat.com/using-oneof-for-a-property-in-an-openapi-spec/</link>
  264. <comments>https://akrabat.com/using-oneof-for-a-property-in-an-openapi-spec/#respond</comments>
  266. <dc:creator><![CDATA[Rob]]></dc:creator>
  267. <pubDate>Tue, 13 May 2025 10:00:00 +0000</pubDate>
  268. <category><![CDATA[API]]></category>
  269. <category><![CDATA[OpenAPI]]></category>
  270. <guid isPermaLink="false">https://akrabat.com/?p=7330</guid>
  271.  
  272. <description><![CDATA[When writing an OpenAPI specification, I came across the need for a particular property in an error response to be either a string or an object. This situation came about when validating a POST request that takes an items property that is a list of objects As a contrived example of a pet with accessories, consider this example request in curl: curl -X "POST" "http://api.example.com/pets" \ -H 'Content-Type: application/json' \ -d $'{ "name": "Rover", "items": [… <a href="https://akrabat.com/using-oneof-for-a-property-in-an-openapi-spec/">continue reading</a>.]]></description>
  273. <content:encoded><![CDATA[<p>When writing an <a href="https://www.openapis.org">OpenAPI specification</a>, I came across the need for a particular property in an error response to be either a string or an object.</p>
  274. <p>This situation came about when validating a POST request that takes an <tt>items</tt> property that is a list of objects</p>
  275. <p>As a contrived example of a pet with accessories, consider this example request in <tt>curl</tt>:</p>
  276. <pre>
  277. curl -X "POST" "http://api.example.com/pets" \
  278.     -H 'Content-Type: application/json' \
  279.     -d $'{
  280.  "name": "Rover",
  281.  "items": [
  282.    {
  283.      "name": "collar"
  284.      "count": 1
  285.    },
  286.    {
  287.      "name": "bowl"
  288.      "count": 2
  289.    }
  290.  ],
  291. }'
  292. </pre>
  293. <p>For the <tt>items</tt> property, there are two error responses if validation fails:</p>
  294. <ol>
  295. <li>Property missing or wrong type.<br />For example:
  296. <pre>
  297. {
  298.  "items": "Items property is required"
  299. }
  300. </pre>
  301. </li>
  302. <li>Missing or invalid sub property<br />For example on the <tt>count</tt> property of the second item:
  303. <pre>
  304. {
  305.  "items": [
  306.    {
  307.    },
  308.    {
  309.        "count": "Item count must be a positive integer"
  310.    }
  311.  ]
  312. }
  313. </pre>
  314. </li>
  315. </ol>
  316. <p>To document this in OpenAPI, I wrote the following for my <tt>'400'</tt> response (simplified):</p>
  317. <pre>
  318. '400':
  319.  description: Validation failed
  320.  content:
  321.      application/json:
  322.        schema:
  323.          type: object
  324.          properties:
  325.            errors:
  326.              type: object
  327.              properties:
  328.                name:
  329.                  type: string
  330.                  example: "Pet name must not be empty"
  331.                items:
  332.                  oneOf:
  333.                    - $ref: '#/components/schemas/ValidationErrorPetItemsObject'
  334.                    - $ref: '#/components/schemas/ValidationErrorPetItemsString'
  335.  
  336. </pre>
  337. <p>Within the <tt>components</tt> -&gt; <tt>schemas</tt> section, we define both schemas:</p>
  338. <pre>
  339. ValidationErrorPetItemsString:
  340.  type: string
  341.  example: "Items property is required"
  342.  
  343.  
  344. ValidationErrorPetItemsPropertyObject:
  345.  type: array
  346.  items:
  347.    type: object
  348.    properties:
  349.      id:
  350.        type: string
  351.        example: "Item name is required"
  352.      count:
  353.        type: string
  354.        example: "Item count must be a positive integer"
  355. </pre>
  356. <p>I don't know how to specify that an empty array will be included so that the client can work out which item object has the problem, so for now it is documented in the description.</p>
  357. <p>There's probably other ways to solve this, but this is the one I came up with. If there's a better way, let me know.</p>
  358. ]]></content:encoded>
  360. <wfw:commentRss>https://akrabat.com/using-oneof-for-a-property-in-an-openapi-spec/feed/</wfw:commentRss>
  361. <slash:comments>0</slash:comments>
  364. </item>
  365. <item>
  366. <title>Additional parameters on a PHP interface method</title>
  367. <link>https://akrabat.com/additional-parameters-on-a-php-interface-method/</link>
  368. <comments>https://akrabat.com/additional-parameters-on-a-php-interface-method/#comments</comments>
  370. <dc:creator><![CDATA[Rob]]></dc:creator>
  371. <pubDate>Tue, 06 May 2025 10:00:00 +0000</pubDate>
  372. <category><![CDATA[PHP]]></category>
  373. <guid isPermaLink="false">https://akrabat.com/?p=7333</guid>
  374.  
  375. <description><![CDATA[On the Roave Discord recently, there was a discussion about not breaking BC in interfaces inspired by this post by Jérôme Tamarelle: It's clearly true that if you add a new parameter to a method on an interface, then that's a BC break as every concrete implementation of the interface needs to change their signature. However, Gina commented that you don't need to use func_get_arg() as concrete implementations can add additional optional arguments. WHAT?!!! I… <a href="https://akrabat.com/additional-parameters-on-a-php-interface-method/">continue reading</a>.]]></description>
  376. <content:encoded><![CDATA[<p>On the <a href="http://discord.gg/roave">Roave Discord</a> recently, there was a discussion about not breaking BC in interfaces inspired by <a href="https://phpc.social/@gromnan/114347134096322334">this post by Jérôme Tamarelle</a>:</p>
  377. <p><img fetchpriority="high" decoding="async" src="https://akrabat.com/wp-content/uploads/2025/04/2025gromnan-post.jpeg" alt="Gromnan post." title="gromnan-post.jpeg" border="0" width="500" height="379" /></p>
  378. <p>It's clearly true that if you add a new parameter to a method on an interface, then that's a BC break as every concrete implementation of the interface needs to change their signature.</p>
  379. <p>However, Gina commented that you don't need to use <tt>func_get_arg()</tt> as concrete implementations can <em>add additional optional arguments</em>.</p>
  380. <p><strong>WHAT?!!!</strong></p>
  381. <p>I didn't know this and it had never occurred to me to try, so I had to go <a href="https://3v4l.org/#live">3v4l.org</a> and check</p>
  382. <pre>&lt;?php
  383.  
  384. interface Foo
  385. {
  386.    public function bar(int $a): void;
  387. }
  388.  
  389. class Baz implements Foo
  390. {
  391.    public function bar(int $a, int $b=2): void
  392.    {
  393.        echo "$a: $b";
  394.    }
  395. }
  396.  
  397. (new Baz)->bar(1,3);
  398. </pre>
  399. <p>Sure enough, this code <a href="https://3v4l.org/judRV">works</a>!</p>
  400. <p>I don't have much of a need for this, but it's useful to know.</p>
  401. ]]></content:encoded>
  403. <wfw:commentRss>https://akrabat.com/additional-parameters-on-a-php-interface-method/feed/</wfw:commentRss>
  404. <slash:comments>2</slash:comments>
  407. </item>
  408. <item>
  409. <title>Some thoughts on LLM usage in my work</title>
  410. <link>https://akrabat.com/some-thoughts-on-llm-usage-in-my-work/</link>
  411. <comments>https://akrabat.com/some-thoughts-on-llm-usage-in-my-work/#respond</comments>
  413. <dc:creator><![CDATA[Rob]]></dc:creator>
  414. <pubDate>Tue, 29 Apr 2025 10:00:00 +0000</pubDate>
  415. <category><![CDATA[AI]]></category>
  416. <guid isPermaLink="false">https://akrabat.com/?p=7339</guid>
  417.  
  418. <description><![CDATA[While it would be nice to put the genie back in the bottle, that hasn't happened often in human history, so for the foreseeable future, AI in the form of LLMs are here to stay. I imagine that what we use them for will change over time as we collectively internalise their limitations. Personally, I'm now using them for my work as much as I reasonably can. This is involving many different areas, such as… <a href="https://akrabat.com/some-thoughts-on-llm-usage-in-my-work/">continue reading</a>.]]></description>
  419. <content:encoded><![CDATA[<p>While it would be nice to put the genie back in the bottle, that hasn't happened often in human history, so for the foreseeable future, AI in the form of LLMs are here to stay. I imagine that what we use them for will change over time as we collectively internalise their limitations. </p>
  420. <p>Personally, I'm now using them for my work as much as I reasonably can. This is involving many different areas, such as asking questions that I would previously have just googled. While the LLM does make things up, the first 40 answers on Google can be decidedly less than helpful nowadays too. The LLM will read many more webpage results than I can be bothered to, provide a summary and cite its sources so that I can click a few to get a feel for how much I trust it.</p>
  421. <p>When developing, I'm using the LLM for multiple tasks. It can help me find bugs when I paste in snippets of code and say "this code is getting X wrong. Tell me why and propose a fix". I generally find that this level of focussed question works quite well, though sometimes, it will go off on a tangent and never come back.</p>
  422. <p>In an IDE, I've found LLM-based smart-autocomplete from something like Copilot works quite well. Again, it's a focussed small task and so tends to work reasonably well for me. I've also found that writing a comment as I would normally do helps the LLM get it right.</p>
  423. <p>New to me is Claude Code. This command line tool reads the files in the current directory and can operate on them. I've found that it is able to do bigger chunks of work as a result and I use <tt>git diff</tt> to assess its work and tweak as necessary before I personally commit. </p>
  424. <p>One thing that is obvious in hindsight, but if I don't have a clear idea in my mind of what I need, then the tools will do worse. This can be more clearly seen with the larger blocks of work, so now, if I'm exploring how and what I want to do, I will talk with the LLM more conversationally more like a brainstorming session to get to the point where I know what I want to do. Then I can instruct it to do the work. This works no differently from trying to delegate a job to a junior and sounds so obvious when written down. However, in the excitement of seeing the magic of the LLM doing the right thing, it's easy to forget and then be surprised when it goes so so wrong.</p>
  425. <p>Not every tool is useful for everyone or useful in every situation. There are also ethical and environmental considerations that affect how people view any given technology and I do not want to suggest that LLM tools must be used; they don't. </p>
  426. <p>I realise that I'm not using these tools are much as others, however, I'm finding them useful.</p>
  427. ]]></content:encoded>
  429. <wfw:commentRss>https://akrabat.com/some-thoughts-on-llm-usage-in-my-work/feed/</wfw:commentRss>
  430. <slash:comments>0</slash:comments>
  433. </item>
  434. <item>
  435. <title>Previewing OpenAPI specs using redocly&#039;s Docker container</title>
  436. <link>https://akrabat.com/previewing-openapi-specs-using-redoclys-docker-container/</link>
  437. <comments>https://akrabat.com/previewing-openapi-specs-using-redoclys-docker-container/#respond</comments>
  439. <dc:creator><![CDATA[Rob]]></dc:creator>
  440. <pubDate>Tue, 22 Apr 2025 10:00:00 +0000</pubDate>
  441. <category><![CDATA[API]]></category>
  442. <category><![CDATA[Docker]]></category>
  443. <category><![CDATA[OpenAPI]]></category>
  444. <guid isPermaLink="false">https://akrabat.com/?p=7325</guid>
  445.  
  446. <description><![CDATA[To provide consistency between the environments of our developers, I'm a strong proponent of using containers so that every developer is using the same versions of our tools. This is really important for command line tooling that depends on a separately installed language such as NodeJS or PHP as a simple npm i -g can install wildly different versions if a dev is running an older (or newer!) version of Node. For OpenAPI specs, listing… <a href="https://akrabat.com/previewing-openapi-specs-using-redoclys-docker-container/">continue reading</a>.]]></description>
  447. <content:encoded><![CDATA[<p>To provide consistency between the environments of our developers, I'm a strong proponent of using containers so that every developer is using the same versions of our tools. This is really important for command line tooling that depends on a separately installed language such as NodeJS or PHP as a simple <tt>npm i -g</tt> can install wildly different versions if a dev is running an older (or newer!) version of Node.</p>
  448. <p>For OpenAPI specs, listing is a must and I currently use <a href="https://stoplight.io/open-source/spectral">Spectral</a> for that, but it can be handy to have rendered documentation visible when writing specs. I don't know about you, but I find it easier to proofread text when in a different context to the editor that I'm currently writing it in. </p>
  449. <p>To render OpenAPI docs in real-time as I write, I picked <a href="https://redocly.com/docs/cli">Redocly</a> which has a <tt>preview-docs</tt> option.</p>
  450. <p>The local command is: <tt>redocly/cli preview-docs openapi.yaml</tt> which will render the OpenAPI spec in <tt>openapi.yaml</tt> as an HTML page at http://localhost:8080. You can then edit the spec file and it will hot reload the browser which is super-convenient.</p>
  451. <h2>Using preview-docs in the Docker container</h2>
  452. <p>To preview the docs using the <a href="https://hub.docker.com/r/redocly/cli">redocly/cli Docker image</a>, you need this command:</p>
  453. <pre>
  454. docker run --init --rm \
  455. -p 8080:8080 -p 32201:32201 \
  456. -v $(PWD):/spec \
  457. redocly/cli preview-docs --use-community-edition openapi.yaml --host 0.0.0.0
  458. </pre>
  459. <p>There's quite a lot going on here, so let's look at the key options:</p>
  460. <ul>
  461. <li><tt>--init</tt> is required so that ctrl+c will exit cleanly.</li>
  462. <li><tt>--rm</tt> deletes the container on exit, so we tidy up after ourselves.</li>
  463. <li><tt>-p 8080:8080 -p 32201:32201</tt> maps ports 8080 and 32201 from the container to our local computer. We need 32201 so that hot reloading works.</li>
  464. <li><tt>-v $(PWD):/spec</tt> maps our current directory to the container's <tt>/spec</tt> directory which is its working directory.</li>
  465. <li><tt>redocly/cli preview-docs openapi.yaml</tt> runs Redocly's <tt>preview-docs</tt> command against our <tt>openapi.yaml</tt> OpenAPI spec file.</li>
  466. <li><tt>--host 0.0.0.0</tt> to make the app accessible from all network interfaces in the container so that we can view the preview from our local computer.</li>
  467. </ul>
  468. <p>We can now open <a href="http://localhost:8080/">http://localhost:8080/</a> and view our nicely rendered OpenAPI spec!</p>
  469. <p><img decoding="async" src="https://akrabat.com/wp-content/uploads/2025/04/2025redocli-cli-rps-openapi.png" alt="Redocli cli rps openapi." title="redocli-cli-rps-openapi.png" border="0" width="700" height="462" /></p>
  470. ]]></content:encoded>
  472. <wfw:commentRss>https://akrabat.com/previewing-openapi-specs-using-redoclys-docker-container/feed/</wfw:commentRss>
  473. <slash:comments>0</slash:comments>
  476. </item>
  477. </channel>
  478. </rss>
  479.  

If you would like to create a banner that links to this page (i.e. this validation result), do the following:

  1. Download the "valid RSS" banner.

  2. Upload the image to your own server. (This step is important. Please do not link directly to the image on this server.)

  3. Add this HTML to your page (change the image src attribute if necessary):

If you would like to create a text link instead, here is the URL you can use:

http://www.feedvalidator.org/check.cgi?url=http%3A//akrabat.com/feed/

Home · About · News · Docs · Terms

 
Copyright © 2002-9 Sam Ruby, Mark Pilgrim, Joseph Walton, and Phil Ringnalda