experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

CHANGELOG formatting

Browse source
This commit is contained in:
Olof hagsand 2018-04-02 11:15:24 +02:00
parent 79e3fbdaa9
commit 0e52e86c0f
1 changed files with 20 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

44
CHANGELOG.md
View file

@ -4,40 +4,36 @@
### Major changes: ### Major changes:
* Restructure and more generic plugin API (cli,backend,restconf,netconf) * Restructure and more generic plugin API (cli,backend,restconf,netconf) as preparation for authorization RFC8341
* For preparation for authorization RFC8341 * New design with single `clixon_plugin_init()` returning an api struct with function pointers, see example below. This means that there are no hardcoded plugin functions, except `clixon_plugin_init()`.
* Plugins add clixon_plugin_init() and api struct for function pointers, eg:
```
static const struct clixon_plugin_api api = {
"example",
clixon_plugin_init,
...
}
clixon_plugin_api *clixon_plugin_init(clicon_handle h)
{
return (void*)&api;
}
```
* Moved specific plugin functions from apps/ to generic functions in lib/ * Moved specific plugin functions from apps/ to generic functions in lib/
* New generic plugin load function: clixon_plugins_load() * Added authentication plugin callback (ca_auth)
* Removed client-local netconf plugins netconf_plugin_callbacks() * Added clicon_username_get() / clicon_username_set()
* This was code used before generic YANG rpc calls * Authorization
* Added username to clixon handle: * Example extended with authorization
* clicon_username_get() / clicon_username_set() * Test added with http basic authorization (test/test_auth.sh)
* Added authentication plugin callback * Documentation in FAQ.md
* Removed some obscure plugin code that seem not to be used (please report if needed!) * Removed some obscure plugin code that seem not to be used (please report if needed!)
* Client-local netconf plugins netconf_plugin_callbacks()
* CLI parse hook * CLI parse hook
* CLICON_FIND_PLUGIN * CLICON_FIND_PLUGIN
* clicon_valcb() * clicon_valcb()
* Example of new plugin module:
```
static const struct clixon_plugin_api api = {
"example",
clixon_plugin_init,
...
}
clixon_plugin_api *clixon_plugin_init(clicon_handle h){
return (void*)&api;
}
```
* Added Clixon Restconf library * Added Clixon Restconf library
* Builds and installs a new restconf library: libclixon_restconf.so and clixon_restconf.h * Builds and installs a new restconf library: libclixon_restconf.so and clixon_restconf.h
* The restconf library can be included by a restconf plugin. * The restconf library can be included by a restconf plugin.
* Example code in example/Makefile.in and example/restconf_lib.c * Example code in example/Makefile.in and example/restconf_lib.c
* Authorization
* Example extended with authorization
* Test added with http basic authorization (test/test_auth.sh)
* Documentation in FAQ.md
* Restconf error handling for get, put and post. Several cornercases remain. Available both as xml and json (set accept header), pretty-printed and not (set clixon config option). * Restconf error handling for get, put and post. Several cornercases remain. Available both as xml and json (set accept header), pretty-printed and not (set clixon config option).
* Proper RFC 6241 Netconf error handling * Proper RFC 6241 Netconf error handling
* New functions added in clixon_netconf_lib.[ch] * New functions added in clixon_netconf_lib.[ch]