summaryrefslogtreecommitdiffstats
path: root/vpp-integration/api-docs/api/asciidoc/Readme.adoc
diff options
context:
space:
mode:
authorJan Srnicek <jsrnicek@cisco.com>2017-07-21 15:10:46 +0200
committerMarek Gradzki <mgradzki@cisco.com>2017-07-25 12:28:32 +0200
commitaa44951faf04e2cddfc537bbc9f6a18d76c76ec1 (patch)
tree5d12ef3105e49495db20dcb052a76d23c953cc03 /vpp-integration/api-docs/api/asciidoc/Readme.adoc
parent4f15c1ba2bec17a5e62e3bb2656454abb86ca6e5 (diff)
HC2VPP-180 - Doc coverage generator
TODO - links to specific vpp api section(now points just to section with apis) TODO - links to specific java binding code(now points to class thats doing binding) TODO - operational coverage(ASM does not support lambda processing) TODO - generate coverage adoc links Change-Id: I44c85012da3bd2e7cdd41930753e5aae6955cd7b Signed-off-by: Jan Srnicek <jsrnicek@cisco.com> Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
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