.. _site-capabilities-api:

.. note::
   - **Last modified by**: Rob Barnsley
   - **Last modified date**: 14/11/2024
   - **Support**: https://skao.slack.com/archives/C05A1D147FV

Site Capabilities
=================

The Site Capabilities API exposes functionality related to SRCNet site storage/service discovery and management. It is
used by a variety of other services as a centralised source of site information.

From an operator perspective, it will be required to keep this database up to date with the storages and services that
sites offer.

Editing a Site
--------------

To edit site information in the database, one must be a member of the required groups. The process for applying to
groups begins at the `SKAO IAM dashboard interface <https://ska-iam.stfc.ac.uk/dashboard#!/home>`_.

The exact groups required depends on the :doc:`SRC naming scheme </standards/src_naming>`. For an SRC with name
``<src>``, the expected group membership (for edit privileges) is:

.. code-block:: bash

  services/site-capabilities-api/roles/<src>/manager

e.g. for ``ESPSRC``

.. code-block:: bash

  services/site-capabilities-api/roles/ESPSRC/manager

If such a group doesn't exist, please contact an SKA IAM administrator. Requests will be forwarded to the corresponding
group manager(s) for the parent group, i.e. ``services/site-capabilities-api/roles/<src>``.

Once the request is accepted you will be able to edit the site via the web interface:

1. Go to the add/edit SRCNet site frontend here: `https://site-capabilities.srcdev.skao.int/api/v1/www/sites/add/\<src\> <https://site-capabilities.srcdev.skao.int/api/v1/www/sites/add/\<src\>>`_,
   substituting ``<src>`` as above
2. Log in with your SKAO IAM credentials; on success you will see ``You are now logged in``
3. Go back to the same link as 1. You will see a web form with your site's information prepopulated (if it has been
   previously populated!)
4. Edit
5. Once edits have been made, click "Add" at the bottom of the page. A green box below the form should be made
   temporarily visible indicating if the site was edited successfully