Qore Swagger Module Reference  1.0.1
Swagger::PathComponent Class Reference

Holds the relative paths to the individual endpoints. More...

Public Member Functions

 constructor (hash oh, string pfx, SwaggerSchema swagger)
 creates the object
 
 getPathOperationHash (reference< hash< string, list< string >>> h)
 returns a hash of URI paths as keys with values as lists of supported HTTP methods More...
 
PathItemObject match (list path)
 returns either a PathItemObject for the path More...
 

Private Member Functions

 add (string full_path, list l, int offset, hash oh, SwaggerSchema swagger)
 adds a component or a Path Item Object to the tree
 
 constructor (string full_path, list l, int offset, hash oh)
 private constructor
 

Private Attributes

string name
 current component name
 
hash< string, PathComponentpaths
 hash of non-wildcard paths to the next level
 
string pfx
 path prefix
 
*PathItemObject pio
 the PathItemObject associated with this path (if any)
 
*PathComponent wildcard
 if there is a wildcard to a PathComponent
 

Detailed Description

Holds the relative paths to the individual endpoints.

The path is appended to the basePath in order to construct the full URL. The Paths may be empty, due to ACL constraints.

This class stores a tree or a component of a path for path matching, supports wildcard matching

Member Function Documentation

◆ getPathOperationHash()

Swagger::PathComponent::getPathOperationHash ( reference< hash< string, list< string >>>  h)

returns a hash of URI paths as keys with values as lists of supported HTTP methods

Returns
a hash of URI paths as keys with values as lists of supported HTTP methods

◆ match()

PathItemObject Swagger::PathComponent::match ( list  path)

returns either a PathItemObject for the path

Exceptions
SCHEMA-VALIDATION-ERRORthe path could not be matched or has no API definition