Uploaded image for project: 'Couchbase Server'
  1. Couchbase Server
  2. MB-3664

[2.0.1 Documentation] 2.0 REST API changes need to be documented

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Critical
    • Resolution: Fixed
    • Affects Version/s: 2.0.1
    • Fix Version/s: 2.0.1
    • Component/s: None
    • Security Level: Public
    • Labels:
      None

      Description

      We've made some changes. Most notably we've added new stats requests. It needs to be documented.

      Moved from MB-6858:

      I'm filing this as a major bug, as the REST api documentation lacks a walkthrough regarding how to perform common operations.

      The Web UI exposes the following operations (current as of 2.0-beta):

      • Creating a new bucket [ram quota and all ] - mostly covered in the REST API
      • Modifying a bucket [ covered ]
      • Failing over a node: This is not clearly covered - there is documentation for failover, eject, and rebalance but it is not clear from the documentation that these three operations are likely to be used in conjunction with each other.
      • Adding a node: Document clearly how to add a node to a cluster by contacting the to-be-joined node. Also there is a 'addNode' function which doesn't seem to be documented - if this is public API it should be documented as a way to join a node to a cluster by contacting the cluster
      • Rebalancing the cluster. Clarify the use of 'otpNode' parameters, what exactly belongs in the ejectedNodes parameters etc. (show examples with adding and removing nodes). Also show a clear example of polling for the rebalance to complete.
      • Compaction: not documented at all
      • Bucket/Node statistics. It would be nice to document these ('self-documenting fields' – self-documenting for who?)

      All of the examples which require multiple steps (or involve performing other requests in order to obtain requisite information) should be demonstrated using a real programming language (not curl). Perl or Python are languages which expose a fairly simple HTTP interface) and through which examples may be scripted and are both common languages used for system administration.

        Issue Links

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

          Hide
          kzeller kzeller added a comment -

          Majority of these items are closed. I'm passing off to you to finish the last 10% and then close.

          Outstanding items:

          -Compaction endpoints/parameters
          -Cross reference the views REST (your discretion on how to handle)

          Show
          kzeller kzeller added a comment - Majority of these items are closed. I'm passing off to you to finish the last 10% and then close. Outstanding items: -Compaction endpoints/parameters -Cross reference the views REST (your discretion on how to handle)
          Hide
          kzeller kzeller added a comment -

          Hi Abhinav,

          Can you send me the compaction endpoints (and any parameters, if they exist) for REST?

          Thanks,

          Karen

          Show
          kzeller kzeller added a comment - Hi Abhinav, Can you send me the compaction endpoints (and any parameters, if they exist) for REST? Thanks, Karen
          Hide
          abhinav Abhinav Dangeti added a comment - - edited

          Here's the command to trigger compaction:

          curl -i -v -X POST -u Administrator:password http://[ip]:[port]/pools/default/buckets/[bucket-name]/controller/compactBucket

          And here's the one to stop/cancel a running compaction:

          curl -i -v -X POST -u Administrator:password http://[ip]:[port]/pools/default/buckets/[bucket-name]/controller/cancelBucketCompaction

          Show
          abhinav Abhinav Dangeti added a comment - - edited Here's the command to trigger compaction: curl -i -v -X POST -u Administrator:password http://[ip]:[port]/pools/default/buckets/[bucket-name]/controller/compactBucket And here's the one to stop/cancel a running compaction: curl -i -v -X POST -u Administrator:password http://[ip]:[port]/pools/default/buckets/[bucket-name]/controller/cancelBucketCompaction
          Hide
          kzeller kzeller added a comment -

          -Add compaction endpoints to REST endpoint in new section on bucket compaction.
          -move spatial compaction to REST chapter
          -Cross ref admin. discussion of compaction from REST chapter.

          Updates will appear in about an hour here:

          http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-restapi.html

          Show
          kzeller kzeller added a comment - -Add compaction endpoints to REST endpoint in new section on bucket compaction. -move spatial compaction to REST chapter -Cross ref admin. discussion of compaction from REST chapter. Updates will appear in about an hour here: http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-restapi.html
          Hide
          kzeller kzeller added a comment -

          -Add compaction endpoints to REST endpoint in new section on bucket compaction.
          -move spatial compaction to REST chapter
          -Cross ref admin. discussion of compaction from REST chapter.

          Updates will appear in about an hour here:

          http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-restapi.html

          Show
          kzeller kzeller added a comment - -Add compaction endpoints to REST endpoint in new section on bucket compaction. -move spatial compaction to REST chapter -Cross ref admin. discussion of compaction from REST chapter. Updates will appear in about an hour here: http://www.couchbase.com/docs/couchbase-manual-2.0/couchbase-admin-restapi.html

            People

            • Assignee:
              kzeller kzeller
              Reporter:
              alkondratenko Aleksey Kondratenko (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Gerrit Reviews

                There are no open Gerrit changes