api_downgrade.h

#ifndef NMOS_API_DOWNGRADE_H
#define NMOS_API_DOWNGRADE_H

#include "cpprest/json.h"

// "Downgrade queries permit old-versioned responses to be provided to clients which are confident
// that they can handle any missing attributes between the specified API versions."
// See https://specs.amwa.tv/is-04/releases/v1.2.0/docs/2.5._APIs_-_Query_Parameters.html#downgrade-queries
namespace nmos
{
    struct api_version;
    struct resource;
    struct type;

    bool is_permitted_downgrade(const nmos::resource& resource, const nmos::api_version& version);
    bool is_permitted_downgrade(const nmos::resource& resource, const nmos::api_version& version, const nmos::api_version& downgrade_version);
    bool is_permitted_downgrade(const nmos::api_version& resource_version, const nmos::api_version& resource_downgrade_version, const nmos::type& resource_type, const nmos::api_version& version, const nmos::api_version& downgrade_version);

    namespace details
    {
        // make user error information (to be used with status_codes::NotFound)
        utility::string_t make_permitted_downgrade_error(const nmos::resource& resource, const nmos::api_version& version);
        utility::string_t make_permitted_downgrade_error(const nmos::resource& resource, const nmos::api_version& version, const nmos::api_version& downgrade_version);
        utility::string_t make_permitted_downgrade_error(const nmos::api_version& resource_version, const nmos::type& resource_type, const nmos::api_version& version, const nmos::api_version& downgrade_version);
    }

    web::json::value downgrade(const nmos::resource& resource, const nmos::api_version& version);
    web::json::value downgrade(const nmos::resource& resource, const nmos::api_version& version, const nmos::api_version& downgrade_version);
    web::json::value downgrade(const nmos::api_version& resource_version, const nmos::api_version& resource_downgrade_version, const nmos::type& resource_type, const web::json::value& resource_data, const nmos::api_version& version, const nmos::api_version& downgrade_version);
}

#endif