Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-5401

Admin REST API -> default is not working

    XMLWordPrintable

Details

    • 1

    Description

      default is not working

      Attachments

        Issue Links

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

          Activity

            Ian.bridge Ian Bridge added a comment - - edited

            Jay Vavachan  (see also DOC-6017) can you clarify, please? Are you saying that selecting API REFERENCES neither expands nor collapses the topic group, to allow selection of a topic? Or that selecting it does not display a topic?

            The latter is an (annoying) but integral feature; provision of content for the category headers is optional.

            The former would be a bug, but it is not one I can observe in Chrome 79.0.3945, Firefox 72.0.2 or Safari 13.0.4. Where I can expand the topic group and select, say, admin-rest-api.

            Ian.bridge Ian Bridge added a comment - - edited Jay Vavachan   (see also DOC-6017 ) can you clarify, please? Are you saying that selecting  API REFERENCES  neither expands nor collapses the topic group, to allow selection of a topic? Or that selecting it does not display a topic? The latter is an (annoying) but integral feature; provision of content for the category headers is optional. The former would be a bug, but it is not one I can observe in Chrome 79.0.3945, Firefox 72.0.2 or Safari 13.0.4. Where I can expand the topic group and select, say, admin-rest-api.
            Jayahari.Vavachan Jay Vavachan added a comment -

            this ticket was meant about, default option not expands nor collapse. I am using Firefox 72.0.2, and i cannot expand or collapse it.

            Jayahari.Vavachan Jay Vavachan added a comment - this ticket was meant about, default option not expands nor collapse. I am using Firefox 72.0.2, and i cannot expand or collapse it.
            Ian.bridge Ian Bridge added a comment - - edited

            Thanks Jay Vavachan. Sorry I was a bit slow grasping the context. 

            I've looked at the yaml for this. At 2.1 the default category contained only a db_revs_diffs property. This had no tag to associate it to a category. At 2.5 a tag: database was added to db_revs_diffs, allowing it to be correctly grouped under the database category but now leaving default empty; hence although it does expand, its expanded content is nil.

            I don't know why, yet, we are showing the empty category and continue to investigate.

            Ian.bridge Ian Bridge added a comment - - edited Thanks Jay Vavachan . Sorry I was a bit slow grasping the context.  I've looked at the yaml for this. At 2.1 the  default category contained only a db_revs_diffs property. This had no tag to associate it to a category. At 2.5 a tag: database was added to db_revs_diffs , allowing it to be correctly grouped under the database category but now leaving default empty; hence although it does expand, its expanded content is nil. I don't know why, yet, we are showing the empty category and continue to investigate.
            Ian.bridge Ian Bridge added a comment - - edited

            Ben Brooks Jay Vavachan This ticket was duplicated by DOC-6017 I am going to close that ticket and progress a resolution on DOC-5401 (Release 2.5), which is when the issue first became noticeable. Although at the moment it is looking like a 'feature' of Swagger. 

            It seems the ‘default’ tag is a catchall that is output to cover any untagged operations (endpoints) and that it is output regardless of there being any or not

            That being the case we may need to address it in CSS.

            Ian.bridge Ian Bridge added a comment - - edited Ben Brooks Jay Vavachan This ticket was duplicated by  DOC-6017 I am going to close that ticket and progress a resolution on DOC-5401 (Release 2.5), which is when the issue first became noticeable. Although at the moment it is looking like a 'feature' of Swagger.  It seems the ‘default’ tag is a catchall that is output to cover any untagged operations (endpoints) and that it is output regardless of there being any or not https://github.com/swagger-api/swagger-ui/issues/1311 https://github.com/swagger-api/swagger-ui/issues/4879 That being the case we may need to address it in CSS.
            Ian.bridge Ian Bridge added a comment -

            To summarise progress so far:

            The mobile rest api (public and admin) is showing an empty 'tag' default. This manifests as a default group that seems not to expand when clicked.

            The issue became visible in Release 2.5. Prior to Release 2.5 the default tag showed a revs_diffs endpoint. But since that endpoint was properly tagged in 2.5 DOC-3851 the default is now empty.

            From swagger documentation, it seems the ‘default’ tag is a catchall that is output to cover any untagged operations (endpoints) and that it is output regardless of there being any or not:

            This may need to be addressed in CSS.

            Ian.bridge Ian Bridge added a comment - To summarise progress so far: The mobile rest api (public and admin) is showing an empty 'tag' default. This manifests as a default group that seems not to expand when clicked. The issue became visible in Release 2.5. Prior to Release 2.5 the default tag showed a revs_diffs endpoint. But since that endpoint was properly tagged in 2.5 DOC-3851 the default is now empty. From swagger documentation, it seems the ‘ default ’ tag is a catchall that is output to cover any untagged operations (endpoints) and that it is output regardless of there being any or not: https://github.com/swagger-api/swagger-ui/issues/1311 https://github.com/swagger-api/swagger-ui/issues/4879 This may need to be addressed in CSS.

            Ian Bridge, Jay Vavachan Is this a blocker issue?

            priya.rajagopal Priya Rajagopal added a comment - Ian Bridge , Jay Vavachan  Is this a blocker issue?
            Ian.bridge Ian Bridge added a comment -

            Priya Rajagopal Jay Vavachan

            I think it's a quirk, a possible minor distraction. It's a link that appears not to work because it has no content. I haven't found a way to suppress it, but maybe we can add a dummy entry in Default that states it is 'intentionally empty' or that 'No default entries are defined' so at least if anyone does click on it, they have an explanation. 

            Ian.bridge Ian Bridge added a comment - Priya Rajagopal Jay Vavachan I think it's a quirk, a possible minor distraction. It's a link that appears not to work because it has no content. I haven't found a way to suppress it, but maybe we can add a dummy entry in Default that states it is 'intentionally empty' or that 'No default entries are defined' so at least if anyone does click on it, they have an explanation. 
            priya.rajagopal Priya Rajagopal added a comment - - edited

            Any reason why we need to have that empty tag default ? If thats removed, then  this section wouldn't show

             

            Also, not sure why this is was a Blocker issue  to begin with (In the bigger scheme of things , would appear far more pressing issues to be resolved. This is just an empty section that doesn't expand)

            priya.rajagopal Priya Rajagopal added a comment - - edited Any reason why we need to have that empty tag default ? If thats removed, then  this section wouldn't show   Also, not sure why this is was a Blocker issue  to begin with (In the bigger scheme of things , would appear far more pressing issues to be resolved. This is just an empty section that doesn't expand)

            Ian Bridge unless you disagree, I view this as a minor issue...at most major issue.

            priya.rajagopal Priya Rajagopal added a comment - Ian Bridge  unless you disagree, I view this as a minor issue...at most major issue.

            People

              Ian.bridge Ian Bridge
              Jayahari.Vavachan Jay Vavachan
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty