yahoo-eng-team team mailing list archive

[Matt Riedemann <mriedem.os@xxxxxxxxx>]

Public bug reported:

- [x] This doc is inaccurate in this way:

The servers_links parameter description says:

"""
Links to the next server. It is available when the number of servers exceeds limit parameter or [api]/max_limit in the configuration file. See API Guide / Links and References for more info.
"""

The link to the API guide goes here:

https://docs.openstack.org/api-guide/compute/links_and_references.html

But that doesn't talk about paging or servers_links. The API reference
description should link here for talking about paging:

https://docs.openstack.org/api-guide/compute/paginated_collections.html

-----------------------------------
Release:  on 2019-10-08 09:22:51
SHA: b6107c8b97bc6a662237873098179841b766ab19
Source: https://opendev.org/openstack/nova/src/api-ref/source/index.rst
URL: https://docs.openstack.org/api-ref/compute/

** Affects: nova
     Importance: Low
         Status: Triaged


** Tags: api-ref doc low-hanging-fruit

** Changed in: nova
       Status: New => Triaged

** Changed in: nova
   Importance: Undecided => Low

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1856241

Title:
  Compute API in nova - servers_links should link to paging doc

Status in OpenStack Compute (nova):
  Triaged

Bug description:
  - [x] This doc is inaccurate in this way:

  The servers_links parameter description says:

  """
  Links to the next server. It is available when the number of servers exceeds limit parameter or [api]/max_limit in the configuration file. See API Guide / Links and References for more info.
  """

  The link to the API guide goes here:

  https://docs.openstack.org/api-guide/compute/links_and_references.html

  But that doesn't talk about paging or servers_links. The API reference
  description should link here for talking about paging:

  https://docs.openstack.org/api-
  guide/compute/paginated_collections.html

  -----------------------------------
  Release:  on 2019-10-08 09:22:51
  SHA: b6107c8b97bc6a662237873098179841b766ab19
  Source: https://opendev.org/openstack/nova/src/api-ref/source/index.rst
  URL: https://docs.openstack.org/api-ref/compute/

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1856241/+subscriptions