Parameter Class Reference

Inheritance diagram for Parameter:

Collaboration diagram for Parameter:

Public Member Functions
def	__init__ (self)
def	is_type (self, other_type)
def	load (self, parameter_json, processor, context)
Public Member Functions inherited from Stringify
def	__repr__ (self)

Data Fields
	allow_multiple
	allowable_values
	data_type
	default_value
	description
	name
	param_type
	required

Static Public Attributes
list	required_fields = ['name', 'paramType', 'dataType']

Detailed Description

Model of an operation's parameter.

See https://github.com/wordnik/swagger-core/wiki/parameters

Definition at line 266 of file swagger_model.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Definition at line 274 of file swagger_model.py.

    def __init__(self):
        self.param_type = None
        self.name = None
        self.description = None
        self.data_type = None
        self.required = None
        self.allowable_values = None
        self.allow_multiple = None
 

Member Function Documentation

is_type()

def is_type	(		self,
			other_type
	)

Definition at line 302 of file swagger_model.py.

    def is_type(self, other_type):
        return self.param_type == other_type
 
 

References Parameter.param_type.

load()

def load	(		self,
			parameter_json,
			processor,
			context
	)

Definition at line 283 of file swagger_model.py.

    def load(self, parameter_json, processor, context):
        context = context.next_stack(parameter_json, 'name')
        validate_required_fields(parameter_json, self.required_fields, context)
        self.name = parameter_json.get('name')
        self.param_type = parameter_json.get('paramType')
        self.description = parameter_json.get('description') or ''
        self.data_type = parameter_json.get('dataType')
        self.required = parameter_json.get('required') or False
        self.default_value = parameter_json.get('defaultValue')
        self.allowable_values = load_allowable_values(
            parameter_json.get('allowableValues'), context)
        self.allow_multiple = parameter_json.get('allowMultiple') or False
        processor.process_parameter(self, context)
        if parameter_json.get('allowedValues'):
            raise SwaggerError(
                "Field 'allowedValues' invalid; use 'allowableValues'",
                context)
        return self
 

References Parameter.data_type, dahdi_pvt.description, iax2_peer.description, ast_calendar_tech.description, ast_calendar_event.description, ast_channel_tech.description, ast_codec.description, ast_http_uri.description, ast_tone_zone.description, manager_action.description, ast_module_info.description, ast_switch.description, ast_fax_tech.description, stasis_subscription_change.description, ast_test_info.description, ast_xml_doc_item.description, ast_xmpp_resource.description, ast_value_translation.description, media_variant.description, ast_app.description, Parameter.description, Api.description, Property.description, Model.description, ResourceApi.description, tables.name, wait_bridge_wrapper.name, ooh323_user.name, ooh323_peer.name, columns.name, adsi_event.name, adsi_key_cmd.name, multi_autochan.name, pickup_by_name_args.name, mixmonitor.name, strategy.name, autopause.name, call_queue.name, skel_level.name, sla_trunk.name, wait_type.name, confbridge_state.name, console_pvt.name, name, iax2_user.name, iax2_peer.name, jingle_endpoint.name, grab_desc.name, iax2_ie.name, iax_flag.name, video_codec_desc.name, Vardesc.name, Namelist.name, lock_frame.name, dsn.name, ael_extension.name, ast_bridge_methods.name, ast_bridge_snapshot.name, ast_bridge.name, ast_bridge_technology.name, ast_bucket_metadata.name, ast_calendar.name, ast_party_id.name, ast_set_party_id.name, ast_var_t.name, ast_codec.name, ast_variable.name, ast_config_engine.name, aco_type.name, ast_dns_query.name, ast_dns_query_recurring.name, ast_dns_resolver.name, ast_applicationmap_item.name, ast_websocket_protocol.name, ast_imager.name, ast_tone_zone_sound.name, ast_msg_tech.name, ast_msg_handler.name, ast_module_info.name, ast_custom_function.name, ast_switch.name, ast_refer_tech.name, ast_aeap_message_handler.name, ast_aeap_message_type.name, odbc_cache_columns.name, ast_sip_contact_status.name, ast_sip_cli_formatter_entry.name, prometheus_metrics_provider.name, prometheus_callback.name, ast_rtp_engine.name, ast_sip_api_tech.name, ast_sorcery_wizard.name, ast_speech_engine.name, stasis_app_recording_options.name, ast_channel_snapshot_caller.name, ast_channel_snapshot_connected.name, ast_channel_snapshot_base.name, ast_tcptls_session_args.name, ast_test_info.name, ast_timing_interface.name, ast_xml_doc_item.name, ast_xmpp_client.name, dscp_codepoint.name, profile_entry.name, ast_bucket_scheme.name, cel_backend.name, category_t.name, media_info.name, topic_pool_entry.name, locale_entry.name, ast_stream.name, ast_taskprocessor.name, permission.name, direntry.name, odbc_txn_frame.name, sip_options_endpoint_aor_status.name, sip_options_endpoint_state_compositor.name, sip_options_aor.name, ast_sip_sched_task.name, exten_state_publisher.name, notify_option.name, namelist.name, test1.name, namedgroup_member.name, cdr_beitem.name, callerid_state.name, minivm_template.name, minivm_zone.name, rule_list.name, vm_zone.name, unistim_line.name, ast_netsock.name, iax_template.name, ast_format_def.name, ast_translator.name, ast_value_translation.name, cdr_object_fn_table.name, cdr_object.name, causes_map.name, ast_party_id_ies.name, ast_channel.name, ast_config_map.name, ast_category_template_instance.name, ast_category.name, cfg_hook.name, aco_option.name, progalias.name, ie_map.name, featuregroup.name, ast_format.name, ast_http_server.name, load_results_map.name, logformatter.name, msg_data.name, ast_exten.name, ast_context.name, ast_include.name, ast_sw.name, refer_data.name, stasis_topic.name, topic_proxy.name, stasis_message_type.name, thr_arg.name, dundi_ie.name, ast_ari_bridges_create_args.name, ast_ari_bridges_create_with_id_args.name, ast_ari_bridges_record_args.name, ast_ari_channels_record_args.name, parking_lot_cfg.name, parking_lot.name, bridge_metric_defs.name, channel_metric_defs.name, endpoint_metric_defs.name, category_and_metric.name, realtime_sqlite3_db.name, ast_key.name, odbc_class.name, manager_channel_variable.name, method_logging_info.name, stasis_app.name, ast_acl.name, named_acl.name, aoc_ie_currency.name, group_entry.name, ast_jb_impl.name, pbx_builtin.name, signalitem.name, directory_item.name, ast_unreal_pvt.name, call_followme.name, group.name, unistim_device.name, confbridge_conference.name, moh_files_state.name, mohclass.name, ast_sorcery_object_field.name, ast_sorcery_object_type.name, conf_menu.name, user_profile.name, bridge_profile.name, prometheus_label.name, prometheus_metric.name, ast_smdi_interface.name, ast_smdi_mwi_message.name, ast_smdi_md_message.name, state.name, geoloc_gml_attr_def.name, extension.name, phone_profile.name, endpoint_identifier_list.name, header.name, notify_option_item.name, sorcery_memory_cache.name, speech_param.name, enum_name_xref_entry.name, ast_xmpp_client_config.name, chanvar.name, stasis_app_stored_recording.name, PathSegment.name, Parameter.name, SwaggerType.name, Property.name, cid_set.name, pair.name, test_item.name, test_val.name, test.name, ast_chan.name, Parameter.param_type, ast_module.required, load_order_entry.required, Parameter.required, Property.required, Parameter.required_fields, ErrorResponse.required_fields, Operation.required_fields, Api.required_fields, Property.required_fields, Model.required_fields, ApiDeclaration.required_fields, ResourceApi.required_fields, ResourceListing.required_fields, and swagger_model.validate_required_fields().

Referenced by ApiDeclaration.load_file(), and ResourceListing.load_file().

Field Documentation

allow_multiple

allow_multiple

Definition at line 281 of file swagger_model.py.

allowable_values

allowable_values

Definition at line 280 of file swagger_model.py.

data_type

data_type

Definition at line 278 of file swagger_model.py.

Referenced by Parameter.load().

default_value

default_value

Definition at line 291 of file swagger_model.py.

description

description

Definition at line 277 of file swagger_model.py.

Referenced by Api.load(), ResourceApi.load(), Model.load(), Parameter.load(), and Property.load().

name

name

Definition at line 276 of file swagger_model.py.

Referenced by PathSegment.get_child(), Parameter.load(), Property.load(), and SwaggerType.load().

param_type

param_type

Definition at line 275 of file swagger_model.py.

Referenced by Parameter.is_type(), and Parameter.load().

required

required

Definition at line 279 of file swagger_model.py.

Referenced by Parameter.load(), and Property.load().

required_fields

list required_fields = ['name', 'paramType', 'dataType']

static

Definition at line 272 of file swagger_model.py.

Referenced by ApiDeclaration.load(), Api.load(), ResourceApi.load(), ErrorResponse.load(), Model.load(), Operation.load(), Parameter.load(), Property.load(), and ResourceListing.load().

---

The documentation for this class was generated from the following file:

• swagger_model.py