summaryrefslogtreecommitdiffstats
path: root/vpp-integration/api-docs/api/asciidoc/Readme.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'vpp-integration/api-docs/api/asciidoc/Readme.adoc')
-rw-r--r--vpp-integration/api-docs/api/asciidoc/Readme.adoc13
1 files changed, 13 insertions, 0 deletions
diff --git a/vpp-integration/api-docs/api/asciidoc/Readme.adoc b/vpp-integration/api-docs/api/asciidoc/Readme.adoc
new file mode 100644
index 000000000..145404972
--- /dev/null
+++ b/vpp-integration/api-docs/api/asciidoc/Readme.adoc
@@ -0,0 +1,13 @@
+= docs-api
+
+Defines general api for VPP binary api coverage
+
+== Elements
+
+* PluginCoverage - Contains coverage data for single JVPP plugin, including supported
+ VPP binary equivalents in JVpp, what Yang nodes are bind to such api and what operations are
+ supported
+* VppApiMessage - Reference to single VPP binary api with link to its documentation
+* JavaApiMessage - Reference to JVpp equivalent of VPP binary api
+* YangType - Reference to single Yang type with link to its model
+* Operation - reference to single CRUD operation with link to binding class \ No newline at end of file