docs: note that JSON Schema should be pinned

jamietanna · jamietanna · commit f459fd71fe71 · 2026-03-02T16:01:24.000Z
Plus add Renovate configuration to update this in the future.
diff --git a/README.md b/README.md
@@ -112,11 +112,13 @@ For full details of what is supported, it's worth checking out [the GoDoc for `c
 We also have [a JSON Schema](configuration-schema.json) that can be used by IDEs/editors with the Language Server Protocol (LSP) to perform intelligent suggestions, i.e.:
 
 ```yaml
-# yaml-language-server: $schema=https://raw.githubusercontent.com/oapi-codegen/oapi-codegen/HEAD/configuration-schema.json
+# yaml-language-server: $schema=https://raw.githubusercontent.com/oapi-codegen/oapi-codegen/v2.6.0/configuration-schema.json
 package: api
 # ...
 ```
 
+Note that it's recommended to pin to a specific version of the configuration schema, so it matches the version of `oapi-codegen` you're using. For instance, if you're using [Renovate](https://docs.renovatebot.com/), you can [have Renovate automagically update this version for you](https://www.jvt.me/posts/2026/03/01/oapi-codegen-config-renovate/).
+
 ### Backwards compatibility
 
 Although we strive to retain backwards compatibility - as a project that's using a stable API per SemVer - there are sometimes opportunities we must take to fix a bug that could cause a breaking change for [people relying upon the behaviour](https://xkcd.com/1172/).
diff --git a/renovate.json b/renovate.json
@@ -69,5 +69,18 @@
 				"executionMode": "branch"
 			}
 		}
+	],
+	"customManagers": [
+		{
+			"customType": "regex",
+			"managerFilePatterns": [
+				"README.md"
+			],
+			"matchStrings": [
+				"# yaml-language-server: \\$schema=https://raw.githubusercontent.com/oapi-codegen/oapi-codegen/(?<currentValue>[^/]+)/configuration-schema.json"
+			],
+			"depNameTemplate": "github.com/oapi-codegen/oapi-codegen/v2",
+			"datasourceTemplate": "go"
+		}
 	]
 }

Original file line number	Diff line number	Diff line change
`@@ -69,5 +69,18 @@`
`69`	`69`	`"executionMode": "branch"`
`70`	`70`	`}`
`71`	`71`	`}`
	`72`	`+ ],`
	`73`	`+ "customManagers": [`
	`74`	`+ {`
	`75`	`+ "customType": "regex",`
	`76`	`+ "managerFilePatterns": [`
	`77`	`+ "README.md"`
	`78`	`+ ],`
	`79`	`+ "matchStrings": [`
	`80`	`+ "# yaml-language-server: \\$schema=https://raw.githubusercontent.com/oapi-codegen/oapi-codegen/(?<currentValue>[^/]+)/configuration-schema.json"`
	`81`	`+ ],`
	`82`	`+ "depNameTemplate": "github.com/oapi-codegen/oapi-codegen/v2",`
	`83`	`+ "datasourceTemplate": "go"`
	`84`	`+ }`
`72`	`85`	`]`
`73`	`86`	`}`