CERC/api_v1.4
61
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Redefine api structure

Browse Source 
Add future methods
Update documentation
This commit is contained in:
Guille Gutierrez 2023-07-21 11:48:00 -04:00
parent 72b90557ff
commit 01281e4b31
3 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
bootstrap.py
View File

@ -17,7 +17,7 @@ import threading
import hub_api.helpers.session_helper as sh import hub_api.helpers.session_helper as sh
from hub_api.control.session import SessionStart, SessionEnd, KeepSessionAlive from hub_api.control.session import SessionStart, SessionEnd, KeepSessionAlive
from hub_api.control.uptime import Uptime from hub_api.control.uptime import Uptime
from hub_api.monthly_energy_balance.retrofit_results import RetrofitResults from hub_api.persistence.retrofit_results import RetrofitResults
from hub_api.workflow.insel_montly_energy_balance import InselMonthlyEnergyBalance from hub_api.workflow.insel_montly_energy_balance import InselMonthlyEnergyBalance
from hub_api.workflow.costs import Costs from hub_api.workflow.costs import Costs
from hub_api.workflow.energy_plus import EnergyPlus from hub_api.workflow.energy_plus import EnergyPlus
@ -36,8 +36,8 @@ api.add_resource(SessionStart, '/v1.4/session/start')
api.add_resource(SessionEnd, '/v1.4/session/end') api.add_resource(SessionEnd, '/v1.4/session/end')
api.add_resource(KeepSessionAlive, '/v1.4/session/keep-alive') api.add_resource(KeepSessionAlive, '/v1.4/session/keep-alive')
# monthly_energy_balance # persistence
api.add_resource(RetrofitResults, '/v1.4/monthly-energy-balance/retrofit-results') api.add_resource(RetrofitResults, '/v1.4/persistence/retrofit-results')
# energy plus # energy plus
api.add_resource(IdfGenerator, '/v1.4/energy-plus/idf-generator') api.add_resource(IdfGenerator, '/v1.4/energy-plus/idf-generator')

8
hub_api/docs/openapi-specs.yml
View File

@ -144,7 +144,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/unauthorized' $ref: '#/components/schemas/unauthorized'
/v1.4/monthly-energy-balance/retrofit-results: /v1.4/persistence/retrofit-results:
post: post:
security: security:
- session_id: [ ] - session_id: [ ]
@ -162,10 +162,10 @@ paths:
description: Cities list description: Cities list
example: { "cities": [{ "Montreal current status": ["149_part_0_zone_0", "1_part_0_zone_0"]}]} example: { "cities": [{ "Montreal current status": ["149_part_0_zone_0", "1_part_0_zone_0"]}]}
tags: tags:
- Buildings monthly energy balance monthly_energy_balance - Buildings monthly energy balance persistence
summary: Retrieve the monthly energy balance results for the given monthly_energy_balance in the given cities summary: Retrieve the monthly energy balance results for the given persistence in the given cities
operationId: retrofit_results operationId: retrofit_results
description: Retrieve the monthly energy balance results for the given monthly_energy_balance in the given cities description: Retrieve the monthly energy balance results for the given persistence in the given cities
responses: responses:
'200': '200':
description: Succeed description: Succeed

6
hub_api/monthly_energy_balance/retrofit_results.py → hub_api/persistence/retrofit_results.py
View File

@ -13,7 +13,7 @@ class RetrofitResults(Resource, Config):
def post(self): def post(self):
""" """
API call for requesting a specified list of enriched monthly_energy_balance API call for requesting a specified list of enriched persistence
""" """
session_id = request.headers.get('session_id', None) session_id = request.headers.get('session_id', None)
token = request.headers.get('token', None) token = request.headers.get('token', None)
@ -34,8 +34,8 @@ class RetrofitResults(Resource, Config):
city_name = next(iter(results)) city_name = next(iter(results))
for building_results in results[city_name]: for building_results in results[city_name]:
values = [] values = []
for value in building_results['insel monthly_energy_balance']: for value in building_results['insel persistence']:
key = next(iter(value)) key = next(iter(value))
values.append({key: json.loads(value[key])}) values.append({key: json.loads(value[key])})
building_results['insel monthly_energy_balance'] = values building_results['insel persistence'] = values
return Response(json.dumps({'result': 'succeed', 'results': results}), status=200, headers=token) return Response(json.dumps({'result': 'succeed', 'results': results}), status=200, headers=token)