From c4be8ca2919fd7191f9885619789b33e48b8a33e Mon Sep 17 00:00:00 2001
From: Nurmatov Mamatisa <nurmatov.mamatisa@huawei.com>
Date: Tue, 13 Jun 2023 13:44:24 +0300
Subject: [PATCH] Add subnet onboard API ref

Closes-Bug: #2016413
Change-Id: Iefd9700ca999c7ab3ff1ea99252539692b66b4c3
---
 api-ref/source/v2/index.rst                   |  1 +
 .../subnets/subnets-onboard-request.json      |  1 +
 .../subnets/subnets-onboard-response.json     |  4 ++
 api-ref/source/v2/subnet_onboard_ops.inc      | 46 +++++++++++++++++++
 4 files changed, 52 insertions(+)
 create mode 100644 api-ref/source/v2/samples/subnets/subnets-onboard-request.json
 create mode 100644 api-ref/source/v2/samples/subnets/subnets-onboard-response.json
 create mode 100644 api-ref/source/v2/subnet_onboard_ops.inc

diff --git a/api-ref/source/v2/index.rst b/api-ref/source/v2/index.rst
index 1c2f67b33..4e3b1573d 100644
--- a/api-ref/source/v2/index.rst
+++ b/api-ref/source/v2/index.rst
@@ -36,6 +36,7 @@ Layer 3 Networking
 .. include:: subnetpools.inc
 .. include:: subnetpool_prefix_ops.inc
 .. include:: subnets.inc
+.. include:: subnet_onboard_ops.inc
 .. include:: local-ips.inc
 ########
 Security
diff --git a/api-ref/source/v2/samples/subnets/subnets-onboard-request.json b/api-ref/source/v2/samples/subnets/subnets-onboard-request.json
new file mode 100644
index 000000000..30d333340
--- /dev/null
+++ b/api-ref/source/v2/samples/subnets/subnets-onboard-request.json
@@ -0,0 +1 @@
+{"network_id": "30640c16-a281-4ec5-8ec0-da05a0a5578d"}
diff --git a/api-ref/source/v2/samples/subnets/subnets-onboard-response.json b/api-ref/source/v2/samples/subnets/subnets-onboard-response.json
new file mode 100644
index 000000000..adbbdc3ea
--- /dev/null
+++ b/api-ref/source/v2/samples/subnets/subnets-onboard-response.json
@@ -0,0 +1,4 @@
+{
+  "subnetpool_id": "5b3d3ffd-109a-4bda-a03c-57b17989b215",
+  "cidr": "10.0.2.0/24"
+}
diff --git a/api-ref/source/v2/subnet_onboard_ops.inc b/api-ref/source/v2/subnet_onboard_ops.inc
new file mode 100644
index 000000000..3dc1cb042
--- /dev/null
+++ b/api-ref/source/v2/subnet_onboard_ops.inc
@@ -0,0 +1,46 @@
+.. -*- rst -*-
+
+==============================================
+Subnet onboard operations (subnet-onboard-ops)
+==============================================
+
+Onboard network subnets into a subnet pool
+
+Onboard subnets
+===============
+
+.. rest_method::  PUT /v2.0/subnetpools/{subnetpool_id}/onboard_network_subnets
+
+Onboard network subnets to a subnet pool.
+
+Normal response codes: 200
+
+Error response codes: 400
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+   - network_id: network_id
+   - subnetpool_id: subnetpool_id
+
+Request Example
+---------------
+
+.. literalinclude:: samples/subnets/subnets-onboard-request.json
+   :language: javascript
+
+Response Parameters
+-------------------
+
+.. rest_parameters:: parameters.yaml
+
+   - subnetpool_id: subnetpool_id
+   - cidr: cidr
+
+Response Example
+----------------
+
+.. literalinclude:: samples/subnets/subnets-onboard-response.json
+   :language: javascript