ResourceListing Class Reference

Inheritance diagram for ResourceListing:

Collaboration diagram for ResourceListing:

Public Member Functions
	__init__ (self)
	load (self, resources_json, processor, context)
	load_file (self, resource_file, processor)
Public Member Functions inherited from Stringify
	__repr__ (self)

Data Fields
	api_version
	apis
	base_path
	required_fields
	swagger_version

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

Detailed Description

Model of Swagger's resources.json file.

Definition at line 724 of file swagger_model.py.

Constructor & Destructor Documentation

__init__()

__init__

(

self

)

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

load	(		self,
			resources_json,
			processor,
			context
	)

Definition at line 751 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 ParsingContext.swagger_version, ApiDeclaration.swagger_version, and ResourceListing.swagger_version.

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

load_file()

load_file	(		self,
			resource_file,
			processor
	)

Definition at line 736 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)
 

References ApiDeclaration.__load_file(), ResourceListing.__load_file(), ApiDeclaration.load(), Api.load(), ResourceApi.load(), ErrorResponse.load(), Model.load(), Operation.load(), Parameter.load(), Property.load(), ResourceListing.load(), SwaggerType.load(), ast_speech_engine.load, ast_sorcery_wizard.load, and ast_module_info.load.

Field Documentation

api_version

api_version

Definition at line 732 of file swagger_model.py.

apis

apis

Definition at line 734 of file swagger_model.py.

base_path

base_path

Definition at line 733 of file swagger_model.py.

required_fields [1/2]

list required_fields = ['apiVersion', 'basePath', 'apis']

static

Definition at line 728 of file swagger_model.py.

required_fields [2/2]

required_fields

Definition at line 758 of file swagger_model.py.

swagger_version

swagger_version

Definition at line 731 of file swagger_model.py.

Referenced by ParsingContext.__repr__(), ApiDeclaration.load(), ResourceListing.load(), ParsingContext.next_stack(), and ParsingContext.version_less_than().

---

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

• swagger_model.py