Uploaded image for project: 'Couchbase Python Client Library'
  1. Couchbase Python Client Library
  2. PYCBC-480

Search, Admin and ClusterManager API missing/incomplete in API docs

    XMLWordPrintable

Details

    • Bug
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • 2.3.5
    • 2.5.6
    • apidocs
    • None
    • 1

    Description

      Problem
      The following API docs seems missing or incomplete

      • Admin
      • Search and bucket-search
      • The docs says there is a cluster_manager() method, I can't find it in the API docs.

        # Create a user and assign roles
        manager = cluster.cluster_manager()
        manager.user_upsert('cbtestuser', 'cbtestuserpwd', [
            # Roles required for the reading of data from the bucket
            ('data_reader', 'travel-sample'),
            ('query_select', 'travel-sample')])
        

      Attachments

        For Gerrit Dashboard: PYCBC-480
        # Subject Branch Project Status CR V

        Activity

          pvarley Patrick Varley added a comment - 2.3.4 docs don't seems to be affected: http://docs.couchbase.com/sdk-api/couchbase-python-client-2.3.4/api/admin.html
          Ellis.Breen Ellis Breen added a comment -

          Weird, I get the same when I try to rebuild via python from 2.3.4, using Sphinx etc from the dev_requirements.txt file. I saw rumours of issues with numpydoc so perhaps a sub-dependency has broken.

          Ellis.Breen Ellis Breen added a comment - Weird, I get the same when I try to rebuild via python from 2.3.4, using Sphinx etc from the dev_requirements.txt file. I saw rumours of issues with numpydoc so perhaps a sub-dependency has broken.
          Ellis.Breen Ellis Breen added a comment -

          OK, think I've fixed these. Upgraded to the very latests numpydoc and sphinx, applied Sergey's sphinx patches (which were absent from 2.3.4/2.3.5) and it seems to be working.

          Thanks,

          Ellis

          Ellis.Breen Ellis Breen added a comment - OK, think I've fixed these. Upgraded to the very latests numpydoc and sphinx, applied Sergey's sphinx patches (which were absent from 2.3.4/2.3.5) and it seems to be working. Thanks, Ellis
          Ellis.Breen Ellis Breen added a comment -

          NB, it seems also to be required that one has a locally built version of the couchbase module before running build_sphinx.

          Ellis.Breen Ellis Breen added a comment - NB, it seems also to be required that one has a locally built version of the couchbase module before running build_sphinx.
          Ellis.Breen Ellis Breen added a comment - http://docs.couchbase.com/sdk-api/couchbase-python-client-2.3.4/search.html?q=cluster_manager was also broken, so this looks like an older problem.

          People

            Ellis.Breen Ellis Breen
            pvarley Patrick Varley
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty