Correct OpenAPI specifications

CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Fixed
+
+- Corrected the OpenAPI `Organization.funder` schema to reference the `Funder` schema instead of `DataProvider`. Documentation-only; no behavior change.
+- Corrected the OpenAPI `Source` schema to no longer list the non-existent `relatedEntityId` as a required property. Documentation-only; no behavior change.
+- Corrected the OpenAPI `PresignedPost.fields` schema to allow the dynamic S3 POST form fields (e.g. `policy`, `x-amz-*`) via `additionalProperties`. Documentation-only; no behavior change.
+- Corrected the OpenAPI `BaseField` schema to mark `shortCode` as `readOnly` (it used the misspelled, ignored `read-only` keyword). Documentation-only; no behavior change.
+- Corrected the OpenAPI `BaseFieldLocalization` schema: `description` and `createdAt` are no longer nullable, `createdAt` is now `readOnly` and required, and `baseFieldShortCode` is now `readOnly`, matching the actual payload. Documentation-only; no behavior change.
+- Corrected the OpenAPI `BulkUploadTask.logs` schema to describe an array of `BulkUploadLog` items (it previously used an invalid bundle-style `properties.entries` shape). Documentation-only; no behavior change.
+- Corrected the OpenAPI `BulkUploadLog.details` schema to reference `BulkUploadLogDetails` directly (it previously wrapped the reference in a spurious `entries` property). Documentation-only; no behavior change.
+- Corrected the OpenAPI `BulkUploadLogDetails.cause` schema to reference `BulkUploadLogDetails` recursively, matching the real nested-cause payload. Documentation-only; no behavior change.
+- Corrected the OpenAPI `Opportunity` schema to require `funderShortCode` and `funder`, which are always present in responses. Documentation-only; no behavior change.
+- Corrected the OpenAPI `ProposalVersion` schema to require `source` and `createdBy`, which are always present in responses. Documentation-only; no behavior change.
+- Corrected the OpenAPI `FunderCollaborativeInvitation` schema to require `invitationStatus`, which is always present in responses. Documentation-only; no behavior change.
+- Corrected the OpenAPI `User.keycloakUserName` schema to be nullable, matching the actual payload. Documentation-only; no behavior change.
+
 ## 0.37.0 2026-05-25
 
 ### Fixed

src/openapi/components/schemas/BaseField.json

@@ -3,7 +3,7 @@
 	"properties": {
 		"shortCode": {
 			"$ref": "./shortCode.json",
-			"read-only": true
+			"readOnly": true
 		},
 		"label": {
 			"type": "string",

src/openapi/components/schemas/BaseFieldLocalization.json

@@ -3,7 +3,8 @@
 	"properties": {
 		"baseFieldShortCode": {
 			"type": "string",
-			"example": "first_name"
+			"example": "first_name",
+			"readOnly": true
 		},
 		"language": {
 			"type": "string",
@@ -15,13 +16,20 @@
 			"example": "Applicant Name"
 		},
 		"description": {
-			"type": ["string", "null"],
+			"type": "string",
 			"example": "The Name of the Applicant"
 		},
 		"createdAt": {
-			"type": ["string", "null"],
-			"format": "date-time"
+			"type": "string",
+			"format": "date-time",
+			"readOnly": true
 		}
 	},
-	"required": ["baseFieldShortCode", "language", "label", "description"]
+	"required": [
+		"baseFieldShortCode",
+		"language",
+		"label",
+		"description",
+		"createdAt"
+	]
 }

src/openapi/components/schemas/BulkUploadLog.json

@@ -16,12 +16,7 @@
 			"readOnly": true
 		},
 		"details": {
-			"type": "object",
-			"properties": {
-				"entries": {
-					"$ref": "./BulkUploadLogDetails.json"
-				}
-			},
+			"allOf": [{ "$ref": "./BulkUploadLogDetails.json" }],
 			"readOnly": true
 		}
 	},

src/openapi/components/schemas/BulkUploadLogDetails.json

@@ -14,7 +14,7 @@
 		},
 		"cause": {
 			"description": "A cause when available, another one of these objects.",
-			"type": "object",
+			"allOf": [{ "$ref": "./BulkUploadLogDetails.json" }],
 			"readOnly": true
 		}
 	},

src/openapi/components/schemas/BulkUploadTask.json

@@ -71,10 +71,8 @@
 		},
 		"logs": {
 			"type": "array",
-			"properties": {
-				"entries": {
-					"$ref": "./BulkUploadLog.json"
-				}
+			"items": {
+				"$ref": "./BulkUploadLog.json"
 			},
 			"readOnly": true
 		}

src/openapi/components/schemas/FunderCollaborativeInvitation.json

@@ -28,6 +28,7 @@
 	"required": [
 		"funderCollaborativeShortCode",
 		"invitedFunderShortCode",
+		"invitationStatus",
 		"createdAt",
 		"createdBy"
 	]

src/openapi/components/schemas/Opportunity.json

@@ -30,5 +30,12 @@
 			"readOnly": true
 		}
 	},
-	"required": ["id", "title", "createdAt", "createdBy"]
+	"required": [
+		"id",
+		"title",
+		"funderShortCode",
+		"funder",
+		"createdAt",
+		"createdBy"
+	]
 }

src/openapi/components/schemas/Organization.json

@@ -13,7 +13,7 @@
 			"nullable": true
 		},
 		"funder": {
-			"$ref": "./DataProvider.json",
+			"$ref": "./Funder.json",
 			"readOnly": true,
 			"nullable": true
 		}

src/openapi/components/schemas/PresignedPost.json

@@ -6,13 +6,17 @@
 		},
 		"fields": {
 			"type": "object",
+			"description": "The form fields that must be submitted alongside the file in the S3 POST. Always includes `key`, plus dynamic S3 policy fields (e.g. `policy`, `x-amz-signature`, `x-amz-credential`, `x-amz-algorithm`, `x-amz-date`).",
 			"properties": {
 				"key": {
 					"type": "string",
 					"example": "96ddab90-1931-478d-8c02-a1dc80ae01e5"
 				}
 			},
-			"required": ["key"]
+			"required": ["key"],
+			"additionalProperties": {
+				"type": "string"
+			}
 		}
 	},
 	"required": ["url", "fields"]

src/openapi/components/schemas/ProposalVersion.json

@@ -48,9 +48,11 @@
 		"id",
 		"proposalId",
 		"sourceId",
+		"source",
 		"applicationFormId",
 		"version",
 		"fieldValues",
-		"createdAt"
+		"createdAt",
+		"createdBy"
 	]
 }

src/openapi/components/schemas/Source.json

@@ -25,7 +25,7 @@
 					"readOnly": true
 				}
 			},
-			"required": ["id", "label", "relatedEntityId", "createdAt", "createdBy"]
+			"required": ["id", "label", "createdAt", "createdBy"]
 		},
 		{
 			"oneOf": [

src/openapi/components/schemas/User.json

@@ -7,7 +7,7 @@
 			"format": "uuid"
 		},
 		"keycloakUserName": {
-			"type": "string",
+			"type": ["string", "null"],
 			"description": "The full name of the user (described in OIDC 1.0 'name' standard claim) as of most recent logged-in service activity.",
 			"example": "John Doe"
 		},