helper.sh

source ./config.sh

# Retrieve the type from the JSON of a component for a given argument.
# ex: get_type_direct "$(jq .components.schemas.ReadVmsRequest.properties.VmId < osc-api.json)"
get_type_direct() {
    arg_info="$1"
    local direct_ref=$(jq -r '.["$ref"]' 2> /dev/null <<< $arg_info)
    local have_direct_ref=$?
    if [ $have_direct_ref == 0 -a "$direct_ref" != 'null' ]; then
    	ref_path=$(cut -c 2- <<< $direct_ref | sed 's|/|.|g')
	local direct_ref_properties=$(jq $ref_path.properties < osc-api.json 2> /dev/null)
	if [ "$direct_ref_properties" == 'null' ]; then
    	    arg_info="$(jq $ref_path < osc-api.json)"
	fi
    fi
    local types=$(jq -r .type 2> /dev/null <<< $arg_info)
    local have_type=$?
    local one_of=$(jq -r .oneOf 2> /dev/null <<< $arg_info)
    local have_one_of=$?
    local any_of=$(jq -r .anyOf 2> /dev/null <<< $arg_info)
    local have_any_of=$?
    if [[ $have_any_of == 0 && "$any_of" != 'null'  ]]; then
	one_of="$any_of"
	have_one_of=$have_any_of
    fi
    if [[ $have_type == 0 && "$types" != 'null' ]]; then
	if [[ "$types" == 'integer' ]]; then
	    echo "long long int"
	    return 0
	elif [[ "$types" == 'number' ]]; then
	    echo double
	    return 0
	elif [[ "$types" == 'boolean' ]]; then
	    echo bool
	    return 0
	elif [[ "$types" == 'array' ]]; then
	    local item_one_off=$(jq -r .items.oneOf 2> /dev/null <<< $arg_info)
	    local item_is_one_of=$?
	    local item_any_of=$(jq -r .items.anyOf 2> /dev/null <<< $arg_info)
	    local item_have_any_of=$?
	    local sub_type=$(jq -r .items.type 2> /dev/null <<< $arg_info)
	    have_stype=$?
	    if [[ $item_have_any_of == 0 && "$item_any_of" != 'null'  ]]; then
		local the_one=$(jq .[0] <<< $item_any_of)
		sub_type=$(get_type_direct "$the_one")
		have_stype=0
	    fi
	    if [[ $item_is_one_of == 0 && "$item_one_off" != 'null'  ]]; then
		local the_one=$(jq .[0] <<< $item_one_off)
		sub_type=$(get_type_direct "$the_one")
		have_stype=0
	    fi
	    if [[ $have_stype == 0 ]]; then
		if [[ "$sub_type" == 'string' ]]; then
		    types="array string"
		elif [[ "$sub_type" == 'integer' ]]; then
		    types="array integer"
		elif [[ "$sub_type" == 'number' ]]; then
		    types="array double"
		elif [[ "$sub_type" == 'null' ]]; then
		    local osub_ref=$(json-search -Rn '$ref' <<< ${arg_info})
		    if [[ $osub_ref == "null" ]]; then
			echo "array string"
			return 0
		    fi
		    local sub_ref=$(cut  -d '/' -f 4 <<< $osub_ref 2> /dev/null)
		    osub_ref=$(cut -c 2- <<< $osub_ref | sed 's|/|.|g')
		    local sub_ref_properties=$(jq $osub_ref.properties < osc-api.json 2> /dev/null)
		    if [[ "$sub_ref_properties" == 'null'  ||  "$sub_ref_properties" == '' ]]; then
    			local arg_info="$(jq $osub_ref < osc-api.json)"
			local dtypes=$(json-search $limit -R type 2> /dev/null <<< $arg_info)
			types="array $dtypes"
		    else
			types="array ref $sub_ref"
		    fi
		else
		    types="array ${sub_type}"
		fi
	    fi
	fi
	echo $types
    elif [[ $have_one_of == 0 && "$one_of" != 'null'  ]]; then
	local the_one=$(jq .[0] <<< $one_of)
	get_type_direct "$the_one"
    else
	local ref=$(json-search -R '$ref' <<< ${arg_info})
	if [[ $ref == "null" ]]; then
	    echo "ref null"
	else
	    echo ref $(cut  -d '/' -f 4 <<< $ref)
	fi
    fi
}

# Retrieve the type directly from the full component JSON rather than using the
# API function Name in get_type.
# ex: get_type3 "$(jq .components.schemas.ReadVmsRequest < osc-api.json)" "VmId"
get_type3() {
    st_info="$1"
    arg="$2"
    local path_type=$(bin/get_path_type "$st_info" $arg)
    if [[ "$path_type" != "null" ]]; then
	if [[ "$path_type" != "string" ]]; then
	    debug "get_type3 of $2: '$path_type'"
	    st_info=$(jq .components.schemas.$path_type < osc-api.json)
	else
	    debug "info: $path_type"
    	    echo $path_type
    	    return 0
	fi
    fi
    arg_info=$(jq .properties[\"$arg\"] <<< $st_info)
    get_type_direct "$arg_info"
    return 0
}

# Retrieve the type directly from the full component JSON rather than using the
# API function name in get_type.
# ex: get_type2 "ReadVmsRequest" "vmId"
get_type2() {
    struct="$1"
    arg="$2"
    local path_type=$(bin/get_path_type ./osc-api.json $struct $arg)
    if [[ "$path_type" != "$struct" ]]; then
	if [[ "$path_type" != 'string' && 'path_type' != 'null' ]]; then
	    struct=$path_type
	else
    	    echo $path_type
    	    return 0
	fi
    fi
    st_info=$(jq .components.schemas.$struct < osc-api.json)

    get_type3 "$st_info" "$arg"
}

# helper for get_type_description
get_type_description_() {
    jq .properties.$2.description <<< "$1"
}

# helper for get_type_description
get_sub_type_description() {
    local st_info=$(jq .components.schemas.$1 < osc-api.json)
    jq .description <<< $st_info | fold -s -w74 | sed "s/^/${2}/"
    local properties=$(json-search -Kn properties <<< $st_info | tr -d '"[],')
    local o_type="$4"
    if [[ "$properties" == "null" ]]; then
	return
    fi
    for p in $properties; do
	local properties=$(jq .properties[\"$p\"] <<< $st_info)

	local desc=$(jq .description <<< $properties)
	local type=$(get_type_direct "$properties")
	local show_idx=""

	if [[ ${o_type%% *} == "array" ]]; then
	    show_idx="INDEX."
	fi
	echo "${2}--${3}.${show_idx}$p: $type"
	if [[ "$desc" != "null" ]]; then
	    fold -s -w74 <<< $desc | sed "s/^/${2}  /"
	fi
	local sub=$(json-search -R '$ref' <<< $properties 2>&1 )
	if [[ "$sub" != 'null' && "$sub" != "nothing found" ]]; then
	    local sub_type=$(cut  -d '/' -f 4 <<< $sub)
	    get_sub_type_description "$sub_type" "${2}    " "${3}.${show_idx}${p}" "$type"
	fi
	#get_sub_type_description "$st_info" "$p"
    done
}

# Write the description of a component.
# useful for generating SDK documentation.
# usage: get_type_description "{FULL COMPONANT JSON}" "ARGUMENT"
# ex: get_type_description "$(jq .components.schemas.ReadVmsRequest < osc-api.json)" "VmId"
get_type_description() {
    PATH_DESC=$(bin/get_path_description "$1" "$2")
    local PATH_RET=$?

    if [[ "$PATH_RET" == "0" ]]; then
	echo $PATH_DESC
	return
    fi


    local properties=$(jq .properties.$2 <<< "$1")
    local desc=$(jq .description <<< "$properties")
    local ref=$(json-search '$ref' <<< "$properties" 2>&1 )

    if [[ "$desc" != "null" ]]; then
	echo $desc
    fi
    if [[ "$ref" != "null" && "$ref" != "nothing found" ]]; then
	local sub_type=$(jq .properties.$2 <<< "$1" | json-search -R '$ref' | cut  -d '/' -f 4)
	local o_type=$(get_type3 "$1" "$2")
	get_sub_type_description "$sub_type" "  " "$2" "$o_type"
    fi
}


# Takes two arguments: an API function name and one of its arguments.
# ex: get_type ReadVms VmId
# will write on stdout the type of VmId in ReadVms
get_type() {
    x=$2
    func=$1
    local path_type=$(bin/get_path_type ./osc-api.json $func $x)
    if [[ "$path_type" != "$func" ]]; then
	if [[ "$path_type" != 'string' && 'path_type' != 'null' ]]; then
	    func=$path_type
	else
    	    echo $path_type
    	    return 0
	fi
    fi

    local arg_info=$(json-search ${func}${FUNCTION_SUFFIX} < osc-api.json | json-search $x)
    local direct_ref=$(jq -r '.["$ref"]' 2> /dev/null <<< $arg_info)
    local have_direct_ref=$?
    if [[ $have_direct_ref == 0 && "$direct_ref" != 'null' ]]; then
    	ref_path=$(cut -c 2- <<< $direct_ref | sed 's|/|.|g')
	local direct_ref_properties=$(jq $ref_path.properties < osc-api.json 2> /dev/null)
	if [[ "$direct_ref_properties" == 'null' ]]; then
    	    arg_info="$(jq $ref_path < osc-api.json)"
	fi
    fi


    local one_of=$(jq -r .oneOf 2> /dev/null <<< $arg_info)
    local have_one_of=$?
    local limit=""
    if [[ $have_one_of == 0 && "$one_of" != 'null'  ]]; then
	limit="-M 1"
    fi
    types=$(json-search $limit -R type 2> /dev/null <<< $arg_info)
    have_type=$?
    if [ $have_type == 0 ]; then
	if [[ "$types" == 'integer' ]]; then
	    echo "long long int"
	    return 0
	elif [[ "$types" == 'number' ]]; then
	    echo double
	    return 0
	elif [[ "$types" == 'boolean' ]]; then
	    echo bool
	    return 0
	elif [[ "$types" == 'array' ]]; then
	    local osub_ref=$(json-search -R '$ref' <<< ${arg_info})
	    local have_sref=$?
	    local sub_ref=$(cut  -d '/' -f 4 <<< $osub_ref 2> /dev/null)
	    osub_ref=$(cut -c 2- <<< $osub_ref | sed 's|/|.|g')

	    if [[ $have_sref == 0 ]]; then
		local sub_ref_properties=$(jq $osub_ref.properties < osc-api.json 2> /dev/null)
		if [[ "$sub_ref_properties" == '' ]]; then
    		    local arg_info="$(jq $osub_ref < osc-api.json)"
		    local dtypes=$(json-search $limit -R type 2> /dev/null <<< $arg_info)
		    types="array $dtypes"
		else
		    types="array ref $sub_ref"
		fi
	    fi
	fi
	echo $types
    else
	echo ref $(json-search -R '$ref' <<< ${arg_info} | cut  -d '/' -f 4)
    fi
    return 0
}

alias to_snakecase="sed 's/\([a-z0-9]\)\([A-Z]\)/\1_\L\2/g;s/[A-Z]/\L&/g'"