Operation Class Reference

Inheritance diagram for Operation:

Collaboration diagram for Operation:

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

Data Fields
	body_parameter
	error_responses
	has_body_parameter
	has_error_responses
	has_header_parameters
	has_parameters
	has_path_parameters
	has_query_parameters
	header_parameters
	http_method
	is_binary_response
	is_req
	is_websocket
	nickname
	nickname_lc
	notes
	parameters
	path_parameters
	query_parameters
	response_class
	since
	summary
	websocket_protocol

Static Public Attributes
list	required_fields = ['httpMethod', 'nickname', 'responseClass', 'summary']

Detailed Description

Model of an operation on an API

See https://github.com/wordnik/swagger-core/wiki/API-Declaration#apis

Definition at line 359 of file swagger_model.py.

Constructor & Destructor Documentation

__init__()

def __init__

(

self

)

Definition at line 367 of file swagger_model.py.

    def __init__(self):
        self.http_method = None
        self.nickname = None
        self.nickname_lc = None
        self.response_class = None
        self.parameters = []
        self.summary = None
        self.notes = None
        self.error_responses = []
        self.since = []
 

Member Function Documentation

load()

def load	(		self,
			op_json,
			processor,
			context
	)

Definition at line 378 of file swagger_model.py.

    def load(self, op_json, processor, context):
        context = context.next_stack(op_json, 'nickname')
        validate_required_fields(op_json, self.required_fields, context)
        self.http_method = op_json.get('httpMethod')
        self.nickname = op_json.get('nickname')
        self.nickname_lc = self.nickname.lower() 
        response_class = op_json.get('responseClass')
        self.response_class = response_class and SwaggerType().load(
            response_class, processor, context)
        since = op_json.get('since') or []
        self.since = ", ".join(since)
 
        # Specifying WebSocket URL's is our own extension
        self.is_websocket = op_json.get('upgrade') == 'websocket'
        self.is_req = not self.is_websocket
 
        if self.is_websocket:
            self.websocket_protocol = op_json.get('websocketProtocol')
            if self.http_method != 'GET':
                raise SwaggerError(
                    "upgrade: websocket is only valid on GET operations",
                    context)
 
        params_json = op_json.get('parameters') or []
        self.parameters = [
            Parameter().load(j, processor, context) for j in params_json]
        self.query_parameters = [
            p for p in self.parameters if p.is_type('query')]
        self.has_query_parameters = self.query_parameters and True
        self.path_parameters = [
            p for p in self.parameters if p.is_type('path')]
        self.has_path_parameters = self.path_parameters and True
        self.header_parameters = [
            p for p in self.parameters if p.is_type('header')]
        self.has_header_parameters = self.header_parameters and True
        self.has_parameters = self.has_query_parameters or \
            self.has_path_parameters or self.has_header_parameters
        self.is_binary_response = self.response_class.is_binary
 
        # Body param is different, since there's at most one
        self.body_parameter = [
            p for p in self.parameters if p.is_type('body')]
        if len(self.body_parameter) > 1:
            raise SwaggerError("Cannot have more than one body param", context)
        self.body_parameter = self.body_parameter and self.body_parameter[0]
        self.has_body_parameter = self.body_parameter and True
 
        self.summary = op_json.get('summary')
        self.notes = op_json.get('notes')
        err_json = op_json.get('errorResponses') or []
        self.error_responses = [
            ErrorResponse().load(j, processor, context) for j in err_json]
        self.has_error_responses = self.error_responses != []
        processor.process_operation(self, context)
        return self
 
 

References Operation.http_method, Operation.load(), Operation.nickname, Operation.nickname_lc, 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, Operation.response_class, agi_command.since, ast_xml_doc_item.since, ast_app.since, Operation.since, ApiDeclaration.since, and swagger_model.validate_required_fields().

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

Field Documentation

body_parameter

body_parameter

Definition at line 418 of file swagger_model.py.

error_responses

error_responses

Definition at line 375 of file swagger_model.py.

has_body_parameter

has_body_parameter

Definition at line 423 of file swagger_model.py.

has_error_responses

has_error_responses

Definition at line 430 of file swagger_model.py.

has_header_parameters

has_header_parameters

Definition at line 412 of file swagger_model.py.

has_parameters

has_parameters

Definition at line 413 of file swagger_model.py.

has_path_parameters

has_path_parameters

Definition at line 409 of file swagger_model.py.

has_query_parameters

has_query_parameters

Definition at line 406 of file swagger_model.py.

header_parameters

header_parameters

Definition at line 410 of file swagger_model.py.

http_method

http_method

Definition at line 368 of file swagger_model.py.

Referenced by Operation.load().

is_binary_response

is_binary_response

Definition at line 415 of file swagger_model.py.

is_req

is_req

Definition at line 392 of file swagger_model.py.

is_websocket

is_websocket

Definition at line 391 of file swagger_model.py.

nickname

nickname

Definition at line 369 of file swagger_model.py.

Referenced by Operation.load().

nickname_lc

nickname_lc

Definition at line 370 of file swagger_model.py.

Referenced by Operation.load().

notes

notes

Definition at line 374 of file swagger_model.py.

parameters

parameters

Definition at line 372 of file swagger_model.py.

path_parameters

path_parameters

Definition at line 407 of file swagger_model.py.

query_parameters

query_parameters

Definition at line 404 of file swagger_model.py.

required_fields

list required_fields = ['httpMethod', 'nickname', 'responseClass', 'summary']

static

Definition at line 365 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().

response_class

response_class

Definition at line 371 of file swagger_model.py.

Referenced by Operation.load().

since

since

Definition at line 376 of file swagger_model.py.

Referenced by Operation.load().

summary

summary

Definition at line 373 of file swagger_model.py.

websocket_protocol

websocket_protocol

Definition at line 395 of file swagger_model.py.

---

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

• swagger_model.py