Skip to content

Commit

Permalink
#92: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
keiranjprice101 committed Oct 17, 2019
1 parent 067873c commit 7d4b1b0
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,8 @@ This is illustrated below.
├── src
│ ├── resources
│ │ ├── entities
│ │ │ └── <entity>_endpoints.py
│ │ │ ├── entity_endpoint.py
│ │ │ └── entity_map.py
│ │ └── non_entities
│ │ └── <non_entity>_endpoints.py
│ ├── swagger
Expand Down Expand Up @@ -110,11 +111,11 @@ When debugging is enabled the api will restart every time code changes are detec


#### Endpoints:
The logic for each endpoint are within `/src/resources`. They are split into entities
and non entities. Each endpoint has its own file within these folders e.g. the datafile endpoint
is in `/src/resources/entities/datafiles_endpoints.py`. Inside of this file there is a class for
each type of endpoint e.g. `/datafiles/count`. Each class is then imported to `/main.py` and added
as a resource.
The logic for each endpoint are within `/src/resources`. They are split into entities, non_entities and
table_endpoints. The entities package contains `entities_map` which maps entity names to their sqlalchemy
model. The `entity_endpoint` module contains the function that is used to generate endpoints at start up.
`table_endpoints` contains the endpoint classes that are table specific. Finally, non_entities contains the
session endpoint.


#### Mapped classes:
Expand Down

0 comments on commit 7d4b1b0

Please sign in to comment.