Property Class Reference

Inheritance diagram for Property:

Collaboration diagram for Property:

Public Member Functions
	__init__ (self, name)
	load (self, property_json, processor, context)
Public Member Functions inherited from Stringify
	__repr__ (self)

Data Fields
	description
	name
	required
	required_fields
	type

Static Public Attributes
list	required_fields = ['type']

Detailed Description

Model of a Swagger property.

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

Definition at line 471 of file swagger_model.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			name
	)

Definition at line 479 of file swagger_model.py.

    def __init__(self, name):
        self.name = name
        self.type = None
        self.description = None
        self.required = None
 

Member Function Documentation

load()

load	(		self,
			property_json,
			processor,
			context
	)

Definition at line 485 of file swagger_model.py.

    def load(self, property_json, processor, context):
        validate_required_fields(property_json, self.required_fields, context)
        # Bit of a hack, but properties do not self-identify
        context = context.next_stack({'name': self.name}, 'name')
        self.description = property_json.get('description') or ''
        self.required = property_json.get('required') or False
 
        type = property_json.get('type')
        self.type = type and SwaggerType().load(type, processor, context)
 
        processor.process_property(self, context)
        return self
 
 

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

Field Documentation

description

description

Definition at line 482 of file swagger_model.py.

name

name

Definition at line 480 of file swagger_model.py.

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

required

required

Definition at line 483 of file swagger_model.py.

required_fields [1/2]

list required_fields = ['type']

static

Definition at line 477 of file swagger_model.py.

required_fields [2/2]

required_fields

Definition at line 486 of file swagger_model.py.

type

type

Definition at line 481 of file swagger_model.py.

---

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

• swagger_model.py