yumapro  20.10-14
YumaPro SDK
RESTCONF Data Structures

RESTCONF Data Structures. More...

Collaboration diagram for RESTCONF Data Structures:

Data Structures

struct  yangapi_param_t
 YANG-API Query string parameter. More...
 
struct  yangapi_accept_t
 Restapi Accept header string entries. More...
 
struct  yangapi_cb_t
 Restapi Control Block Used by RESTCONF to hold parse and request processing state. More...
 

Macros

#define YANGAPI_RET_OK   200
 HTTP 200 OK return code.
 
#define YANGAPI_RET_CREATE_OK   201
 HTTP 201 Created return code.
 
#define YANGAPI_RET_BAD_METHOD   405
 HTTP 405 Method Not Allowed return code.
 

Enumerations

enum  yangapi_method_t {
  YANGAPI_METHOD_NONE,
  YANGAPI_METHOD_OPTIONS,
  YANGAPI_METHOD_HEAD,
  YANGAPI_METHOD_GET,
  YANGAPI_METHOD_POST,
  YANGAPI_METHOD_PUT,
  YANGAPI_METHOD_PATCH,
  YANGAPI_METHOD_DELETE
}
 HTTP methods used by YANG-API and RESTCONF. More...
 
enum  yangapi_launchpt_t {
  YANGAPI_LAUNCHPT_NONE,
  YANGAPI_LAUNCHPT_TOP,
  YANGAPI_LAUNCHPT_DATASTORE,
  YANGAPI_LAUNCHPT_DATA,
  YANGAPI_LAUNCHPT_NEW_DATA,
  YANGAPI_LAUNCHPT_MODULES,
  YANGAPI_LAUNCHPT_MODULE,
  YANGAPI_LAUNCHPT_OPERATIONS,
  YANGAPI_LAUNCHPT_OPERATION,
  YANGAPI_LAUNCHPT_YANG,
  YANGAPI_LAUNCHPT_YANG_PLAIN,
  YANGAPI_LAUNCHPT_VERSION,
  YANGAPI_LAUNCHPT_STREAMS,
  YANGAPI_LAUNCHPT_STREAM,
  YANGAPI_LAUNCHPT_EVENTS,
  YANGAPI_LAUNCHPT_YANGLIB_VERSION,
  YANGAPI_LAUNCHPT_ACTION
}
 describes the type of node indicated by the RequestURI path Used internally in the server to process the target resource URI More...
 
enum  restconf_content_t {
  RESTCONF_CONTENT_NONE,
  RESTCONF_CONTENT_CONFIG,
  RESTCONF_CONTENT_NONCONFIG,
  RESTCONF_CONTENT_ALL
}
 RESTCONF content query param enumeration. More...
 

Detailed Description

RESTCONF Data Structures.

Enumeration Type Documentation

◆ restconf_content_t

RESTCONF content query param enumeration.

Enumerator
RESTCONF_CONTENT_NONE 

not set

RESTCONF_CONTENT_CONFIG 

return only configuration data nodes

RESTCONF_CONTENT_NONCONFIG 

only non-configuration data nodes

RESTCONF_CONTENT_ALL 

all descendant data nodes

◆ yangapi_launchpt_t

describes the type of node indicated by the RequestURI path Used internally in the server to process the target resource URI

Enumerator
YANGAPI_LAUNCHPT_NONE 

not set

YANGAPI_LAUNCHPT_TOP 

/restconf launch point

YANGAPI_LAUNCHPT_DATASTORE 

/restconf/data launch point

YANGAPI_LAUNCHPT_DATA 

/restconf/data/foo launch point

YANGAPI_LAUNCHPT_NEW_DATA 

/restconf/data/foo/new-bar launch point

YANGAPI_LAUNCHPT_MODULES 

modules launch point

YANGAPI_LAUNCHPT_MODULE 

modules/module launch point

YANGAPI_LAUNCHPT_OPERATIONS 

/restconf/operations launch point

YANGAPI_LAUNCHPT_OPERATION 

/restconf/operations/some-operation launch point

YANGAPI_LAUNCHPT_YANG 

YANG launch point.

YANGAPI_LAUNCHPT_YANG_PLAIN 

RESTCONF 'schema' resource class.

YANGAPI_LAUNCHPT_VERSION 

version launch point

YANGAPI_LAUNCHPT_STREAMS 

streams launch point

YANGAPI_LAUNCHPT_STREAM 

streams/stream launch point

YANGAPI_LAUNCHPT_EVENTS 

events launch point

YANGAPI_LAUNCHPT_YANGLIB_VERSION 

/restconf/yang-library-version launch point

YANGAPI_LAUNCHPT_ACTION 

action launch point

◆ yangapi_method_t

HTTP methods used by YANG-API and RESTCONF.

Enumerator
YANGAPI_METHOD_NONE 

not set

YANGAPI_METHOD_OPTIONS 

OPTIONS method.

YANGAPI_METHOD_HEAD 

HEAD method.

YANGAPI_METHOD_GET 

GET method.

YANGAPI_METHOD_POST 

POST method.

YANGAPI_METHOD_PUT 

PUT method.

YANGAPI_METHOD_PATCH 

PATCH method.

YANGAPI_METHOD_DELETE 

DELETE method.