Skip to content

Fixes docs errors #1332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
caphrim007 merged 1 commit into from
Nov 30, 2017
Merged

Fixes docs errors #1332

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/userguide/endpoints/collection.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ Collection

``kind``: ``collectionstate``

A :dfn:`collection` is similar to an |Organizing Collection Section| in it is not a configurable object. Unlike an organiziont collection, however, a collection only contains references to objects (or, resources) of the same type.
A :dfn:`collection` is similar to an |Organizing Collection Section| in it is not a configurable object. Unlike an `OrganizingCollection` collection,
however, a `Collection` only contains references to objects (or, resources) of the same type.

.. include:: ../SDK_plural_note.rst

.. topic:: Example: Use :meth:`f5.bigip.resource.Collection.get_collection` to get a list of the objects in the :mod:`f5.bigip.tm.ltm.pool` collection.
.. topic:: Example: Use :meth:`f5.bigip.tm.ltm.pools.get_collection` to get a list of the objects in the :mod:`f5.bigip.tm.ltm.pool` collection.

The ``items`` attribute in the JSON returned contains |Resource Section| objects that all share the same ``kind``. We can tell that these objects are resources because the ``kind`` ends in ``state``.

Expand Down