proto: fix CreateUser Openapi3 doc (#1038)

it uses the entire user object in REST, without the request wrapper type.
redpanda-data · Jan 26, 2024 · d2553b0 · d2553b0
1 parent 6c8f916
commit d2553b0
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 6 deletions.
diff --git a/backend/pkg/tools/openapi-generator/main.go b/backend/pkg/tools/openapi-generator/main.go
@@ -393,7 +393,7 @@ func updateUsers(doc3 *openapi3.T) {
  Password: "secure-password",
  Mechanism: v1alpha1.SASLMechanism_SASL_MECHANISM_SCRAM_SHA_256,
  }}
- doc3.Paths.Value("/v1alpha1/users").Post.RequestBody.Value.Content["application/json"].Example = toExample(createUserReq, "Create User", "Create user", false).Value
+ doc3.Paths.Value("/v1alpha1/users").Post.RequestBody.Value.Content["application/json"].Example = toExample(createUserReq.User, "Create User", "Create user", false).Value
 
  // Responses
  response := &v1alpha1.CreateUserResponse{User: &v1alpha1.CreateUserResponse_User{

diff --git a/proto/gen/openapi/openapi.json b/proto/gen/openapi/openapi.json
diff --git a/proto/gen/openapi/openapi.yaml b/proto/gen/openapi/openapi.yaml
@@ -2333,10 +2333,9 @@ paths:
  content:
  application/json:
  example:
- user:
- mechanism: SASL_MECHANISM_SCRAM_SHA_256
- name: payment-service
- password: secure-password
+ mechanism: SASL_MECHANISM_SCRAM_SHA_256
+ name: payment-service
+ password: secure-password
  schema:
  $ref: '#/components/schemas/CreateUserRequest.User'
  required: true