summaryrefslogtreecommitdiffstats
path: root/nat/nat-api/asciidoc/Readme.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'nat/nat-api/asciidoc/Readme.adoc')
-rw-r--r--nat/nat-api/asciidoc/Readme.adoc11
1 files changed, 11 insertions, 0 deletions
diff --git a/nat/nat-api/asciidoc/Readme.adoc b/nat/nat-api/asciidoc/Readme.adoc
new file mode 100644
index 000000000..300d83885
--- /dev/null
+++ b/nat/nat-api/asciidoc/Readme.adoc
@@ -0,0 +1,11 @@
+= nat-api
+
+The APIs are based on ietf-nat YANG model draft:
+https://tools.ietf.org/html/draft-sivakumar-yang-nat-05
+
+== Notes on model
+* Nat-instances map to VRF in VPP (nat-instance/id mapps to VRF-ID)
+
+== Deviations
+* nat-state/nat-instances/nat-instance/id type changed to uint32 from int32
+* "mandatory true" statements commented to support partial model implementation