Model Class Reference

Inheritance diagram for Model:

Collaboration diagram for Model:

Public Member Functions
def	__init__ (self)
def	all_subtypes (self)
def	discriminator (self)
def	extends (self)
def	has_properties (self)
def	has_subtypes (self)
def	load (self, id, model_json, processor, context)
def	properties (self)
def	set_extends_type (self, extends_type)
def	set_subtype_types (self, subtype_types)
Public Member Functions inherited from Stringify
def	__repr__ (self)

Data Fields
	description
	id
	model_json
	notes
	subtypes

Static Public Attributes
list	required_fields = ['description', 'properties']

Detailed Description

Model of a Swagger model.

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

Definition at line 491 of file swagger_model.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Definition at line 499 of file swagger_model.py.

    def __init__(self):
        self.id = None
        self.subtypes = []
        self.__subtype_types = []
        self.notes = None
        self.description = None
        self.__properties = None
        self.__discriminator = None
        self.__extends_type = None

Member Function Documentation

all_subtypes()

def all_subtypes

(

self

)

Returns the full list of all subtypes, including sub-subtypes.

Definition at line 572 of file swagger_model.py.

References Model.__subtype_types.

    def all_subtypes(self):
        """Returns the full list of all subtypes, including sub-subtypes.
        """
        res = self.__subtype_types + \
              [subsubtypes for subtype in self.__subtype_types
               for subsubtypes in subtype.all_subtypes()]
        return sorted(res, key=lambda m: m.id)

discriminator()

def discriminator

(

self

)

Returns the discriminator, digging through base types if needed.

Definition at line 557 of file swagger_model.py.

References Model.__discriminator, and Model.__extends_type.

    def discriminator(self):
        """Returns the discriminator, digging through base types if needed.
        """
        return self.__discriminator or \
            self.__extends_type and self.__extends_type.discriminator()

extends()

def extends

(

self

)

Definition at line 548 of file swagger_model.py.

References Model.__extends_type.

    def extends(self):
        return self.__extends_type and self.__extends_type.id

has_properties()

def has_properties

(

self

)

Definition at line 569 of file swagger_model.py.

References len(), ast_rtp_instance.properties, Model.properties(), and ast_channel_tech.properties.

    def has_properties(self):
        return len(self.properties()) > 0

has_subtypes()

def has_subtypes

(

self

)

Returns True if type has any subtypes.

Definition at line 580 of file swagger_model.py.

References len(), and Model.subtypes.

    def has_subtypes(self):
        """Returns True if type has any subtypes.
        """
        return len(self.subtypes) > 0

load()

def load	(		self,
			id,
			model_json,
			processor,
			context
	)

Definition at line 509 of file swagger_model.py.

References Model.__discriminator, Model.__properties, ast_codec.description, media_variant.description, ast_app.description, ast_xml_doc_item.description, ast_calendar_tech.description, ast_tone_zone.description, ast_xmpp_resource.description, ast_calendar_event.description, ast_http_uri.description, manager_action.description, ast_switch.description, ast_fax_tech.description, ast_test_info.description, Parameter.description, ast_module_info.description, Api.description, dahdi_pvt.description, Property.description, Model.description, iax2_peer.description, ast_channel_tech.description, stasis_subscription_change.description, ast_value_translation.description, sip_peer.description, category_t.id, stasis_state_proxy.id, ast_framehook.id, stasis_message_type.id, internal_state.id, ast_codec.id, Section.id, ast_ari_asterisk_get_object_args.id, audiosocket_instance.id, native_rtp_framehook_data.id, ast_endpoint_snapshot.id, ast_channel_snapshot_bridge.id, io_rec.id, ast_endpoint.id, ast_ari_asterisk_update_object_args.id, calendar_id.id, stun_trans_id.id, exten_state_subscription.id, sched_id.id, stun_header.id, stasis_app_playback.id, srv_result_datastore.id, corosync_node.id, adsi_event.id, sync_payload.id, unbound_resolver_data.id, app_forwards.id, ast_ari_asterisk_delete_object_args.id, ast_sip_transport_state.id, adapter_pvt.id, bridge_sync.id, ast_xmpp_message.id, ast_xmpp_buddy.id, ast_fax_session_details.id, mbl_pvt.id, dns_HEADER.id, ast_sorcery_object.id, mwi_subscription.id, adsi_soft_key.id, adsi_subscript.id, worker_thread.id, adsi_state.id, adsi_flag.id, adsi_display.id, cel_linkedid.id, cache_entry_key.id, ast_aoc_charging_association.id, ast_fax_session.id, ast_sip_session.id, hep_ctrl.id, enum_result_datastore.id, ast_sip_outbound_publish_state.id, aoc_ie_billing.id, ast_state_cb.id, mgcp_subchannel.id, ast_sip_session_sdp_handler.id, ast_party_caller.id, unistim_device.id, ast_set_party_caller.id, ast_party_connected_line.id, ast_rtp_engine_ice_candidate.id, ast_set_party_connected_line.id, Model.id, ast_cc_monitor.id, cfsip_methods.id, conf_menu_action.id, ast_sip_endpoint.id, adsi_key_cmd.id, smdi_msg_datastore.id, sip_mailbox.id, id, cfsip_options.id, dundi_result_datastore.id, local_optimization.id, Parameter.required_fields, ErrorResponse.required_fields, Operation.required_fields, Api.required_fields, Property.required_fields, Model.required_fields, Model.subtypes, and swagger_model.validate_required_fields().

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

    def load(self, id, model_json, processor, context):
        context = context.next_stack(model_json, 'id')
        validate_required_fields(model_json, self.required_fields, context)
        # The duplication of the model's id is required by the Swagger spec.
        self.id = model_json.get('id')
        if id != self.id:
            raise SwaggerError("Model id doesn't match name", context)
        self.subtypes = model_json.get('subTypes') or []
        if self.subtypes and context.version_less_than("1.2"):
            raise SwaggerError("Type extension support added in Swagger 1.2",
                               context)
        self.description = model_json.get('description')
        props = model_json.get('properties').items() or []
        self.__properties = [
            Property(k).load(j, processor, context) for (k, j) in props]
        self.__properties = sorted(self.__properties, key=lambda p: p.name)

        discriminator = model_json.get('discriminator')

        if discriminator:
            if context.version_less_than("1.2"):
                raise SwaggerError("Discriminator support added in Swagger 1.2",
                                   context)

            discr_props = [p for p in self.__properties if p.name == discriminator]
            if not discr_props:
                raise SwaggerError(
                    "Discriminator '%s' does not name a property of '%s'" % (
                        discriminator, self.id),
                    context)

            self.__discriminator = discr_props[0]

        self.model_json = json.dumps(model_json,
                                     indent=2, separators=(',', ': '))

        processor.process_model(self, context)
        return self

properties()

def properties

(

self

)

Definition at line 563 of file swagger_model.py.

References Model.__extends_type, and Model.__properties.

Referenced by Model.has_properties().

    def properties(self):
        base_props = []
        if self.__extends_type:
            base_props = self.__extends_type.properties()
        return base_props + self.__properties

set_extends_type()

def set_extends_type	(		self,
			extends_type
	)

Definition at line 551 of file swagger_model.py.

References Model.__extends_type.

    def set_extends_type(self, extends_type):
        self.__extends_type = extends_type

set_subtype_types()

def set_subtype_types	(		self,
			subtype_types
	)

Definition at line 554 of file swagger_model.py.

References Model.__subtype_types.

    def set_subtype_types(self, subtype_types):
        self.__subtype_types = subtype_types

Field Documentation

description

description

Definition at line 504 of file swagger_model.py.

Referenced by Model.load(), and ResourceApi.load().

id

id

Definition at line 500 of file swagger_model.py.

Referenced by Model.load().

model_json

model_json

Definition at line 542 of file swagger_model.py.

notes

notes

Definition at line 503 of file swagger_model.py.

required_fields

list required_fields = ['description', 'properties']

static

Definition at line 497 of file swagger_model.py.

Referenced by Model.load(), ApiDeclaration.load(), ResourceApi.load(), and ResourceListing.load().

subtypes

subtypes

Definition at line 501 of file swagger_model.py.

Referenced by Model.has_subtypes(), and Model.load().

---

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

• swagger_model.py