Merge pull request #120 from holgerstolzenberg/feature/add-security-section-to-openapi-specs

tstirrat15 · web-flow · commit 9ce037a2e9e0 · 2024-11-12T08:33:06.000-08:00
Add missing global 'security' declaration to openapi.proto
diff --git a/authzed/api/v1/openapi.proto b/authzed/api/v1/openapi.proto
@@ -37,8 +37,13 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
 				type: TYPE_API_KEY;
 				in: IN_HEADER;
 				name: "Authorization";
+				description: "SpiceDB preshared-key, prefixed by Bearer: Bearer <preshared-key>";
 			}
 		}
+	},
+	security: {
+		security_requirement: {
+			key: "ApiKeyAuth"
+		}
 	}
 };
-

Original file line number	Diff line number	Diff line change
`@@ -37,8 +37,13 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {`
`37`	`37`	`type: TYPE_API_KEY;`
`38`	`38`	`in: IN_HEADER;`
`39`	`39`	`name: "Authorization";`
	`40`	`+ description: "SpiceDB preshared-key, prefixed by Bearer: Bearer <preshared-key>";`
`40`	`41`	`}`
`41`	`42`	`}`
	`43`	`+ },`
	`44`	`+ security: {`
	`45`	`+ security_requirement: {`
	`46`	`+ key: "ApiKeyAuth"`
	`47`	`+ }`
`42`	`48`	`}`
`43`	`49`	`};`
`44`		`-`