Inheritance diagram for ResourceListing:

Collaboration diagram for ResourceListing:

Public Member Functions
def	__init__ (self)

def	load (self, resources_json, processor, context)

def	load_file (self, resource_file, processor)

Public Member Functions inherited from Stringify
def	__repr__ (self)

Data Fields
	api_version

	apis

	base_path

	swagger_version

Static Public Attributes
list	required_fields = ['apiVersion', 'basePath', 'apis']

Detailed Description

Model of Swagger's resources.json file.

Definition at line 718 of file swagger_model.py.

Constructor & Destructor Documentation

◆ init()

def __init__ ( self )

Definition at line 724 of file swagger_model.py.

    def __init__(self):
        self.swagger_version = None
        self.api_version = None
        self.base_path = None
        self.apis = None
 

Member Function Documentation

◆ load()

def load	(	self,
		resources_json,
		processor,
		context
	)

Definition at line 745 of file swagger_model.py.

    def load(self, resources_json, processor, context):
        # If the version doesn't match, all bets are off.
        self.swagger_version = resources_json.get('swaggerVersion')
        if not self.swagger_version in SWAGGER_VERSIONS:
            raise SwaggerError(
                "Unsupported Swagger version %s" % self.swagger_version, context)
 
        validate_required_fields(resources_json, self.required_fields, context)
        self.api_version = resources_json['apiVersion']
        self.base_path = resources_json['basePath']
        apis_json = resources_json['apis']
        self.apis = [
            ResourceApi().load(j, processor, context) for j in apis_json]
        processor.process_resource_listing(self, context)
        return self
 
 

References ApiDeclaration.api_version, ResourceListing.api_version, ApiDeclaration.apis, ResourceListing.apis, ApiDeclaration.base_path, ResourceListing.base_path, ResourceListing.load(), 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, ParsingContext.swagger_version, ApiDeclaration.swagger_version, ResourceListing.swagger_version, and swagger_model.validate_required_fields().

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

◆ load_file()

def load_file	(	self,
		resource_file,
		processor
	)

Definition at line 730 of file swagger_model.py.

    def load_file(self, resource_file, processor):
        context = ParsingContext(None, [resource_file])
        try:
            return self.__load_file(resource_file, processor, context)
        except SwaggerError:
            raise
        except Exception as e:
            print("Error: ", traceback.format_exc(), file=sys.stderr)
            raise SwaggerError(
                "Error loading %s" % resource_file, context, e)
 