Skip to content

Commit

Permalink
#50: Create an entity class
Browse files Browse the repository at this point in the history
  • Loading branch information
@keiranjprice101
keiranjprice101 committed Sep 17, 2019
1 parent d34cef8 commit 412a895
Showing 1 changed file with 171 additions and 0 deletions.
171 changes: 171 additions & 0 deletions src/swagger/swagger_generator.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,177 @@ def __init__(self, description, name, param_type, example, location, is_required
}
}


class Entity(object):
WHERE_PARAMETER = Parameter(
"Apply a where filter to all entities. The filter can take the form of {\"field\":{<operator>:\"value\"}, "
"where the possible operators are like, gte, lte and eq",
"where", "object", {"ID": {"eq": 1}}, "query", False).parameter_as_dict
LIMIT_PARAMETER = Parameter("Limit the number of entities returned", "limit", "number", 4,
"query", False).parameter_as_dict
SKIP_PARAMETER = Parameter("Offset the returned entities by a given number", "skip", "number", 5,
"query", False).parameter_as_dict
ORDER_PARAMETER = Parameter("Given a field and direction, order the returned entities", "order", "string",
"ID DESC", "query", False).parameter_as_dict
INCLUDE_PARAMETER = Parameter("Given the names of related entities, include them in the results", "include",
"object", {"Relation 1": ["Relation A", "Relation B"]}, "query", False).parameter_as_dict
DISTINCT_PARAMETER = Parameter("Return unique values for the fields requested", "distinct", "object",
["FIELD 1", "FIELD 2"], "query", False).parameter_as_dict
PATH_PARAMETER = Parameter("The id of an entity", "id", "integer", 4, "path", True).parameter_as_dict

def __init__(self, entity_name):
self.entity_no_id_endpoint = {
f"/{entity_name.lower()}": {
"get": {
"summary": f"Get {SwaggerGenerator.pascal_to_normal(entity_name).lower()} based on filters",
"tags": ["entities"],
"parameters": [self.WHERE_PARAMETER,
self.DISTINCT_PARAMETER,
self.INCLUDE_PARAMETER,
self.LIMIT_PARAMETER,
self.ORDER_PARAMETER,
self.SKIP_PARAMETER],
"responses": {
"200": {
"description": f"The {SwaggerGenerator.pascal_to_normal(entity_name).lower()} found"
},
"404": {
"description": "When no results are found"
},
"401": {
"description": "When no credentials are provided"
},
"403": {
"description": "When bad credentials are provided"
}
}
},
"post": {
"summary": f"Add new {SwaggerGenerator.pascal_to_normal(entity_name).lower()}",
"tags": ["entities"],
"requestBody": {
"description": f"Create one or multiple {SwaggerGenerator.pascal_to_normal(entity_name).lower()}",
"required": True,
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}

},
"responses": {
"200": {
"description": f"The created {SwaggerGenerator.pascal_to_normal(entity_name)}"
},
"401": {
"description": "When no credentials are provided"
},
"403": {
"description": "When bad credentials are provided"
}
}
},
"patch": {
"summary": f"Update {SwaggerGenerator.pascal_to_normal(entity_name).lower()}",
"tags": ["entities"],
"requestBody": {
"description": f"Update one or multiple {SwaggerGenerator.pascal_to_normal(entity_name).lower()}",
"required": True,
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}

},
"responses": {
"200": {
"description": "The updated entity"
},
"404": {
"description": "When the entity to update could not be found"
},
"401": {
"description": "When no credentials are provided"
},
"403": {
"description": "When bad credentials are provided"
}
}
}
}

}
self.entity_count_endpoint = {
f"/{entity_name.lower()}/count": {
"get": {
"summary": f"Return the count of the {SwaggerGenerator.pascal_to_normal(entity_name).lower()}",
"tags": ["entities"],
"parameters": [self.WHERE_PARAMETER],
"responses": {
"200": {
"description": f"The count of the {SwaggerGenerator.pascal_to_normal(entity_name).lower()}"
},
"401": {
"description": f"When no credentials are provided"
},
"403": {
"description": "When bad credentials are given"
}
}

}

}
}
self.entity_id_endpoint = {
f"/{entity_name.lower()}/{{id}}": {
"get": {
"summary": f"Find the {SwaggerGenerator.pascal_to_normal(entity_name).lower()} matching the ID",
"tags": ["entities"],
"parameters": [self.PATH_PARAMETER],
"responses": {
"200": {
"description": f"The matching {SwaggerGenerator.pascal_to_normal(entity_name).lower()}"
},
"404": {
"description": "When no result is found"
},
"401": {
"description": "When no credentials are provided"
},
"403": {
"description": "When bad credentials are provided"
}
}
},
"delete": {
"summary": f"Delete the {SwaggerGenerator.pascal_to_normal(entity_name).lower()} matching the ID",
"tags": ["entities"],
"parameters": [self.PATH_PARAMETER],
"responses": {
"203": {
"description": "Blank response when the entity is deleted"
},
"404": {
"description": "When the entity can't be found"
},
"401": {
"description": "When no credentials are provided"
},
"403": {
"description": "When bad credentials are provided"
}
}
}
}
}


class SwaggerGenerator(object):
FILE_PATH = Path.cwd() / "swagger" / "openapi.yaml"

Expand Down

0 comments on commit 412a895

Please sign in to comment.