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

{{role}} in apiargs represents the interface:operation, rather than the name of the arg

    XMLWordPrintableJSON

Details

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Minor - P4 Minor - P4
    • DOCS Q3 W10
    • None
    • None
    • None
    • giza: 0.5.6
      libgiza: 0.2.7
    • 1

    Description

      For this block of yaml:

      arg_name: option
      name: autoIndexId
      type: boolean
      description: |
       
        *Default: true*. Specify false to disable the automatic creation of
        an index on the _id field.
       
        .. important::
          
           For replica sets, do not set {{role}} to ``false``.
       
        .. deprecated:: 3.2. The {{role}} option will be removed in MongoDB v3.4.
       
      optional: true
      interface: phpmethod
      operation: MongoDB\\Database::createCollection
      position: 1
      

      Based on the behavior of the {{role}} replacement in options/settings directives, I would expect {{role}} to be replaced with autoIndexId.

      {{role}} is actually replaced with :phpmethod:MongoDB\Database::createCollection.

      We should fix that.

      Attachments

        Activity

          People

            allison.moore@mongodb.com Allison Reinheimer Moore
            allison.moore@mongodb.com Allison Reinheimer Moore
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              7 years, 29 weeks ago