Restructured Readme for Infra mgmt

infobloxopen · Jan 29, 2025 · 3289e1d · 3289e1d
1 parent bde42e4
commit 3289e1d
Show file tree

Hide file tree

Showing 2 changed files with 65 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ The following Infoblox APIs are supported:
 - [Infrastructure Management](https://github.com/infobloxopen/universal-ddi-python-client/blob/main/src/infra_mgmt/README.md)
 - [Infrastructure Provision (HostActivation API)](https://github.com/infobloxopen/universal-ddi-python-client/blob/main/src/infra_provision/README.md)
 - [Anycast Configuration Manager](https://github.com/infobloxopen/universal-ddi-python-client/blob/main/src/anycast/README.md)
-- [Upgrade Policy](https://github.com/infobloxopen/universal-ddi-python-client/blob/main/src/upgradePolicy/README.md)
+- [Upgrade Policy](https://github.com/infobloxopen/universal-ddi-python-client/blob/main/src/upgrade_policy/README.md)
 
 ## Infoblox Threat Defense
 - [Threat Defense Cloud (FW API)](https://github.com/infobloxopen/universal-ddi-python-client/blob/main/src/fw/README.md)

diff --git a/src/infra_mgmt/README.md b/src/infra_mgmt/README.md
@@ -1,5 +1,68 @@
 # infra-mgmt
-The **Infrastructure Management API** provides a RESTful interface to manage Infrastructure Hosts and Services objects.  The following is a list of the different Services and their string types (the string types are to be used with the APIs for the `service_type` field):  | Service name | Service type |   | ------ | ------ |   | Access Authentication | authn |   | Anycast | anycast |   | Data Connector | cdc |   | DHCP | dhcp |   | DNS | dns |   | DNS Forwarding Proxy | dfp |   | NIOS Grid Connector | orpheus |   | MS AD Sync | msad |   | NTP | ntp |   | BGP | bgp |   | RIP | rip |   | OSPF | ospf |    ---   ### Hosts API  The Hosts API is used to manage the Infrastructure Host resources. These include various operations related to hosts such as viewing, creating, updating, replacing, disconnecting, and deleting Hosts. Management of Hosts is done from the Cloud Services Portal (CSP) by navigating to the Manage -> Infrastructure -> Hosts tab.  ---   ### Services API  The Services API is used to manage the Infrastructure Service resources (a.k.a. NIOS-X applications). These include various operations related to hosts such as viewing, creating, updating, starting/stopping, configuring, and deleting Services. Management of Services is done from the Cloud Services Portal (CSP) by navigating to the Manage -> Infrastructure -> Services tab.  ---   ### Detail APIs  The Detail APIs are read-only APIs used to list all the Infrastructure resources (Hosts and Services). Each resource record returned also contains information about its other associated resources and the status information for itself and the associated resource(s) (i.e., Host/Service status).  ---   
+
+The **Infrastructure Management API** provides a RESTful interface to manage Infrastructure Hosts and Services objects.
+
+The following is a list of the different **Services** and their string types (used with the APIs for the `service_type` field):
+
+| **Service Name**            | **Service Type** |
+|-----------------------------|------------------|
+| Access Authentication       | `authn`          |
+| Anycast                     | `anycast`        |
+| Data Connector              | `cdc`            |
+| DHCP                        | `dhcp`           |
+| DNS                         | `dns`            |
+| DNS Forwarding Proxy        | `dfp`            |
+| NIOS Grid Connector         | `orpheus`        |
+| MS AD Sync                  | `msad`           |
+| NTP                         | `ntp`            |
+| BGP                         | `bgp`            |
+| RIP                         | `rip`            |
+| OSPF                        | `ospf`           |
+
+---
+
+## Hosts API
+
+The **Hosts API** is used to manage the **Infrastructure Host** resources. These include various operations related to hosts, such as:
+
+- Viewing
+- Creating
+- Updating
+- Replacing
+- Disconnecting
+- Deleting
+
+Management of Hosts is done from the **Cloud Services Portal (CSP)** by navigating to:  
+**Manage → Infrastructure → Hosts** tab.
+
+---
+
+## Services API
+
+The **Services API** is used to manage **Infrastructure Service** resources (a.k.a. **NIOS-X applications**). These include various operations related to services, such as:
+
+- Viewing
+- Creating
+- Updating
+- Starting/Stopping
+- Configuring
+- Deleting
+
+Management of Services is done from the **Cloud Services Portal (CSP)** by navigating to:  
+**Manage → Infrastructure → Services** tab.
+
+---
+
+## Detail APIs
+
+The **Detail APIs** are **read-only APIs** used to list all the **Infrastructure resources** (Hosts and Services).
+
+Each resource record returned also contains information about:
+- Its associated resources
+- Status information for itself
+- The status of associated resource(s) (**Host/Service status**)
+
+---
 
 The `infra_mgmt` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: