hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MXS-1220: Factor out common code from JSON object creation

Browse Source 
The JSON objects that are created from the various core MaxScale objects
share a lot of common code. Moving this into a separate files removes the
redundant code.
This commit is contained in:
Markus Mäkelä
2017-05-03 13:32:43 +03:00
parent 5ae9ff9663
commit ca62749f25
9 changed files with 156 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
include/maxscale/config.h
View File

@ -102,6 +102,7 @@ extern const char CN_SERVERS[];
extern const char CN_SERVER[];
extern const char CN_SERVICES[];
extern const char CN_SERVICE[];
extern const char CN_SESSIONS[];
extern const char CN_SKIP_PERMISSION_CHECKS[];
extern const char CN_SOCKET[];
extern const char CN_STATE[];

64
include/maxscale/json_api.h Normal file
View File

@ -0,0 +1,64 @@
#pragma once
/*
* Copyright (c) 2016 MariaDB Corporation Ab
*
* Use of this software is governed by the Business Source License included
* in the LICENSE.TXT file and at www.mariadb.com/bsl11.
*
* Change Date: 2019-07-01
*
* On the date above, in accordance with the Business Source License, use
* of this software will be governed by version 2 or later of the General
* Public License.
*/
/**
* @file Helper functions for creating JSON API conforming objects
*/
#include <maxscale/cppdefs.hh>
#include <maxscale/jansson.hh>
MXS_BEGIN_DECLS
/** Resource endpoints */
#define MXS_JSON_API_SERVERS "/servers/"
#define MXS_JSON_API_SERVICES "/services/"
#define MXS_JSON_API_FILTERS "/filters/"
#define MXS_JSON_API_MONITORS "/monitors/"
#define MXS_JSON_API_SESSIONS "/sessions/"
#define MXS_JSON_API_MAXSCALE "/maxscale/"
/**
* @brief Create a JSON object
*
* The caller should add a `data` field to the returned object.
*
* @param host Hostname of this server
* @param self Endpoint of this resource
* @param data The JSON data, either an array or an object
*
* @return A valid top-level JSON API object
*/
json_t* mxs_json_resource(const char* host, const char* self, json_t* data);
/**
* @brief Create an empty relationship object
*
* @param host Hostname of this server
* @param endpoint The endpoint for the resource's collection
*
* @return New relationship object
*/
json_t* mxs_json_relationship(const char* host, const char* endpoint);
/**
* @brief Add an item to a relationship object
*
* @param rel Relationship created with mxs_json_relationship
* @param id The resource identifier
* @param type The resource type
*/
void mxs_json_add_relation(json_t* rel, const char* id, const char* type);
MXS_END_DECLS