Skip to content

Commit

Permalink
wip: u.pro.services.dependencies.v1
Browse files Browse the repository at this point in the history
  • Loading branch information
orndorffgrant committed Apr 23, 2024
1 parent 1a787e6 commit 93aa294
Showing 1 changed file with 61 additions and 0 deletions.
61 changes: 61 additions & 0 deletions docs/references/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ The currently available endpoints are:
- `u.pro.security.fix.usn.plan.v1`_
- `u.pro.security.status.livepatch_cves.v1`_
- `u.pro.security.status.reboot_required.v1`_
- `u.pro.services.dependencies.v1`_
- `u.pro.status.enabled_services.v1`_
- `u.pro.status.is_attached.v1`_
- `u.apt_news.current_news.v1`_
Expand Down Expand Up @@ -2183,6 +2184,66 @@ are:
"reboot_required": "yes|no|yes-kernel-livepatches-applied"
}
u.pro.services.dependencies.v1
========================================

This endpoint will return a full list of all service dependencies,
regardless of the current system state. That means it will always return
the same thing until new services are added, or until we add/remove
dependencies between services.

- Introduced in Ubuntu Pro Client Version: ``32~``
- Args:

- This endpoint takes no arguments.

.. tab-set::

.. tab-item:: Python API interaction
:sync: python

- Calling from Python code:

.. code-block:: python
from uaclient.api.u.pro.services.dependencies.v1 import dependencies
result = dependencies()
- Expected return object:

- ``uaclient.api.u.pro.services.dependencies.v1.DependenciesResult``

.. list-table::
:header-rows: 1

* - Field Name
- Type
- Description
* - ``services``
- *List[ServiceWithDependencies]*
- Each Pro service gets an item in this list

- Raised exceptions:

- No exceptions raised by this endpoint.

.. tab-item:: CLI interaction
:sync: CLI

- Calling from the CLI:

.. code-block:: bash
pro api u.pro.services.dependencies.v1
- Expected attributes in JSON structure:

.. code-block:: json
{
"services": []
}
u.pro.status.enabled_services.v1
================================

Expand Down

0 comments on commit 93aa294

Please sign in to comment.