Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCS-14648

CSFLE: Make code sample templates more clear that a substitution is needed

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Minor - P4
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: drivers
    • Labels:
      None
    • Last comment by Customer:
      true
    • Story Points:
      2
    • Sprint:
      DET: Cybertruck - Sprint 2, DET: Sienna - Sprint 3

      Description

      In the following article it was found that some users fail to correctly substitute values in the code sample templates. For example:

      // We have 
      providerDetails.put("privateKey", new BsonString("<GCP service account private key>"));
      // User used
      providerDetails.put("privateKey", new BsonString("<GCP $privateKey>"));
      // Instead of
      providerDetails.put("privateKey", new BsonString("$privateKey"));
      

      Can we consider make it more clear what sort of substitution is needed?

        Attachments

          Activity

            People

            Assignee:
            kailie.yuan Kailie Yuan
            Reporter:
            dmitry.ryabtsev Dmitry Ryabtsev
            Participants:
            Last commenter:
            Kailie Yuan Kailie Yuan
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:
              Days since reply:
              20 weeks ago
              Date of 1st Reply: