Update documentation for create key

Open Beginner friendly
#45 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
java
Domain
documentation

Research direction

Open the linked IBM Cloud Key Protect Java create-key documentation and compare the shown CreateKeyOptions.Builder example with the reported API usage. Update the example to use keyCreateBody(inputstream), then verify that the create-key snippet matches the current Java client API.

Written by the indexing model from the issue text.

Description

The documentation here shows:

    createKeyOptionsModel = new CreateKeyOptions.Builder()
      .bluemixInstance("<instance_id>")
      .createKeyOneOf(inputstream)
      .prefer("return=representation")
      .build();

But I believe it should be:

    createKeyOptionsModel = new CreateKeyOptions.Builder()
      .bluemixInstance("<instance_id>")
      .keyCreateBody(inputstream)
      .prefer("return=representation")
      .build();
Dominant language
Java
Stars
1
Forks
9
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from IBM/keyprotect-java-client

All issues in IBM/keyprotect-java-client

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.