From b7d473f436ea7c33186d1b61f4deee3c03d86cf8 Mon Sep 17 00:00:00 2001 From: Keiran Price Date: Tue, 15 Oct 2019 10:39:46 +0100 Subject: [PATCH] #87: Update main.py --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 50c5403e..e9210a8d 100644 --- a/README.md +++ b/README.md @@ -105,10 +105,12 @@ This is illustrated below. └── config.json ````` #### Main: -The main entry point is in `/src/main.py`. This is where each endpoint route is defined and its -related class imported e.g. - `api.add_resource(DatafilesWithID, "/datafiles/")` +`main.py` is where the flask_restful api is set up. This is where each endpoint resource class is +imported and mapped to an endpoint. +Example: + `api.add_resource(DatafilesWithID, "/datafiles/")` +This means that the http methods defined in the `DatafilesWithID` class are mapped to `/datafiles/` #### Endpoints: The logic for each endpoint are within `/src/resources`. They are split into entities