VK Cloud logo

schemas sectionBeta

The schemas section in the service configuration JSON file describes the tariff options of a specific plan. The section has the following structure:

"schemas": {            "service_instance": {              "create": {                "parameters": {                  "$schema": "http://json-schema.org/draft-04/schema#",                  "type": "object",                  "properties": {                  }                }              },              "update": {                "parameters": {                  "$schema": "http://json-schema.org/draft-04/schema#",                  "type": "object",                  "properties": {                  }                }              },              "resource_usages": {                "parameters": {                  "$schema": "http://json-schema.org/draft-04/schema#",                  "type": "object",                  "properties": {                  }                }              }            },            "service_binding": {              "create": {                "parameters": {                  "type": "object",                  "properties": {                  }                }              }            }          }

Here:

  • The service_instance section describes the plan's tariff options and defines the way funds are charged for paid options.

    • The service_instance.create section describes free and prepaid tariff options that will be active in the tariff plan configuration wizard when connecting the service.
    • The service_instance.update section describes free and prepaid tariff options that will be active in the tariff plan configuration wizard when updating the service's tariff plan.
    • The service_instance.resource_usages section describes postpaid tariff options. All options from this section must be described in the broker.
  • The service_binding section describes the creation of service bindings.

All sections inside schemas are mandatory to declare in the JSON file. The sections can be empty.

For a SaaS application, all tariff option types are supported except datasource. Tariff option parameters are described using JSON schemas. The same parameters are used as the tariff option parameters for an image-based application. Examples of describing different option types and their display in the store interface for an image-based application are provided in the section Filling in YAML files of tariff options.

The cost of paid options and the change step for an option of the integer type are specified in the billing section.

Requirements for option names:

  • If SaaS application metrics are collected using the pull model, the option name in the JSON file must match the value of the kind parameter specified in the broker method for submitting the report to Marketplace.
  • If metrics are collected using the push model, the option name in the JSON file must match the value of the param parameter in the API request for submitting metrics.

Examples of describing different option types in JSON format

Was this article helpful?