Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 389 publish sensor data api documentation #390

Merged
merged 99 commits into from Mar 22, 2022

Commits on Mar 7, 2022

  1. Move sensor data API from dev to v2 and use flask-classful

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 7, 2022
    Copy the full SHA
    f6f1b91 View commit details
    Browse the repository at this point in the history

Commits on Mar 8, 2022

  1. Publish dev API

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    f92d182 View commit details
    Browse the repository at this point in the history
  2. Add quickrefs

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    84f4169 View commit details
    Browse the repository at this point in the history
  3. Add type annotations

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    9eb7299 View commit details
    Browse the repository at this point in the history
  4. Refactor use of auth_required in SensorAPI

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    ea7a77d View commit details
    Browse the repository at this point in the history
  5. Add type annotations

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    9d2f329 View commit details
    Browse the repository at this point in the history
  6. Add more quickrefs

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    25ba2de View commit details
    Browse the repository at this point in the history
  7. Indentation

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    0126169 View commit details
    Browse the repository at this point in the history
  8. valid JSON, rather than a python dict

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    7ce3f14 View commit details
    Browse the repository at this point in the history
  9. Move import to its preferred position

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    cb205ba View commit details
    Browse the repository at this point in the history
  10. Rename and add type annotation

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    841f1d3 View commit details
    Browse the repository at this point in the history
  11. Allow AssetIdField and SensorIdField to be used for API requests, too…

    …, besides for CLI scripts
    
    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    f126561 View commit details
    Browse the repository at this point in the history
  12. Update tutorial for posting data

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    2e3bf11 View commit details
    Browse the repository at this point in the history
  13. Implement [GET] sensorData

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    e6db62f View commit details
    Browse the repository at this point in the history
  14. Add example GET request

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    de46436 View commit details
    Browse the repository at this point in the history
  15. Update docstring for unit conversion

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    2ab771b View commit details
    Browse the repository at this point in the history
  16. Respect the passed horizon and prior fields

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    1a7414e View commit details
    Browse the repository at this point in the history
  17. Convert NaN to null (otherwise invalid JSON)

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    70e3793 View commit details
    Browse the repository at this point in the history
  18. Pass event resolution to enable additional unit conversions

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    2ef234f View commit details
    Browse the repository at this point in the history
  19. Smarter unit conversion for BeliefsSeries

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    bc5ffbe View commit details
    Browse the repository at this point in the history
  20. Revert to auth_token_required instead of login_required

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    3e85a5e View commit details
    Browse the repository at this point in the history
  21. Deserialize to BeliefsDataFrame using post_load decorator, and run th…

    …rough post_load decorators in a specific sequence
    
    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    5738a29 View commit details
    Browse the repository at this point in the history
  22. Move serialization logic to schema

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    9cd8f9b View commit details
    Browse the repository at this point in the history
  23. Fix tutorial for posting data

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    c76766e View commit details
    Browse the repository at this point in the history
  24. Introduce util function to check for a valid price unit

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    271c435 View commit details
    Browse the repository at this point in the history
  25. Comment out tutorial sections on posting data for multiple connection…

    …s at once
    
    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    56a5f25 View commit details
    Browse the repository at this point in the history
  26. Update tutorial for posting data: change connection to sensor and sto…

    …p mentioning separate endpoints for postMeterData and postPrognosis
    
    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    8a14c64 View commit details
    Browse the repository at this point in the history
  27. Add validation based on POST message type

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    e878f5c View commit details
    Browse the repository at this point in the history
  28. Publish documentation for SensorDataAPI

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    dfa64b8 View commit details
    Browse the repository at this point in the history
  29. Add validation based on GET message type

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    7de8b6f View commit details
    Browse the repository at this point in the history
  30. mypy

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    c0f0bee View commit details
    Browse the repository at this point in the history
  31. Update getting-started.rst

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    29d3381 View commit details
    Browse the repository at this point in the history
  32. Undoc old endpoints

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 8, 2022
    Copy the full SHA
    852bee8 View commit details
    Browse the repository at this point in the history

Commits on Mar 10, 2022

  1. Rename with_appcontext_if_needed

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 10, 2022
    Copy the full SHA
    eef5d42 View commit details
    Browse the repository at this point in the history
  2. refactor auth logic - separate checking access from the permission_re…

    …quired_for_context decorator
    
    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    nhoening committed Mar 10, 2022
    Copy the full SHA
    83b774e View commit details
    Browse the repository at this point in the history

Commits on Mar 12, 2022

  1. add modern auth for sensor data get & post, remove checking account r…

    …ole auth
    
    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    nhoening committed Mar 12, 2022
    Copy the full SHA
    52b3ba9 View commit details
    Browse the repository at this point in the history
  2. more freedom to create inside accounts: allow all account members to …

    …create on generic assets and sensors
    
    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    nhoening committed Mar 12, 2022
    Copy the full SHA
    9c0695e View commit details
    Browse the repository at this point in the history
  3. use a user from the same account as the sensor for sensor data tests

    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    nhoening committed Mar 12, 2022
    Copy the full SHA
    bc9a100 View commit details
    Browse the repository at this point in the history
  4. adapt asset tests w.r.t. to a change in dev api conftest

    Signed-off-by: Nicolas Höning <nicolas@seita.nl>
    nhoening committed Mar 12, 2022
    Copy the full SHA
    2f31a17 View commit details
    Browse the repository at this point in the history

Commits on Mar 14, 2022

  1. Remove unneeded import

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    352ae60 View commit details
    Browse the repository at this point in the history
  2. GET endpoints work for logged-in users when tried in the browser with…

    … auth_required but not with auth_token_required
    
    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    210ecbc View commit details
    Browse the repository at this point in the history
  3. Add docstring

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    b76ebdb View commit details
    Browse the repository at this point in the history
  4. Make type a required field

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    9b3f281 View commit details
    Browse the repository at this point in the history
  5. Move @route to top

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    7b67a1f View commit details
    Browse the repository at this point in the history
  6. SensorDataDescriptionSchema doesn't need the type field

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    2037394 View commit details
    Browse the repository at this point in the history
  7. Revert "Undoc old endpoints"

    This reverts commit 852bee8.
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    b17a9b8 View commit details
    Browse the repository at this point in the history
  8. Move sensor data API documentation to v3

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    4e804ba View commit details
    Browse the repository at this point in the history
  9. Move sensor data API to v3

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    24ffc1a View commit details
    Browse the repository at this point in the history
  10. Move user API to class for v3

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    77ffdaf View commit details
    Browse the repository at this point in the history
  11. Move user UI to v3

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    daa43c6 View commit details
    Browse the repository at this point in the history
  12. Update user API tests

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    3abb649 View commit details
    Browse the repository at this point in the history
  13. Move user API tests to v3 module

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    c4ea13b View commit details
    Browse the repository at this point in the history
  14. Separate view for user index

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    41371c7 View commit details
    Browse the repository at this point in the history
  15. Fix test

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    d2a2e5f View commit details
    Browse the repository at this point in the history
  16. Update documentation tutorials to v3

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    0c2d199 View commit details
    Browse the repository at this point in the history
  17. No trailing slash

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    482cde9 View commit details
    Browse the repository at this point in the history
  18. Make type field in v3

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    820521e View commit details
    Browse the repository at this point in the history
  19. Add v3 to API index

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    0fc14b6 View commit details
    Browse the repository at this point in the history
  20. Update introduction

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    70a9406 View commit details
    Browse the repository at this point in the history
  21. Fix comment about where to request auth token

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    281af3b View commit details
    Browse the repository at this point in the history
  22. flake8

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    d14d85e View commit details
    Browse the repository at this point in the history
  23. black

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    89e8dff View commit details
    Browse the repository at this point in the history
  24. Revert some documentation changes that are ahead of code changes

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    2f2cee0 View commit details
    Browse the repository at this point in the history
  25. Use one common base route

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    abfc41a View commit details
    Browse the repository at this point in the history
  26. Prefer plural base route

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    3fec582 View commit details
    Browse the repository at this point in the history
  27. different shade of black

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 14, 2022
    Copy the full SHA
    80ed32d View commit details
    Browse the repository at this point in the history

Commits on Mar 15, 2022

  1. typos

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 15, 2022
    Copy the full SHA
    a26fad1 View commit details
    Browse the repository at this point in the history
  2. Transition SensorDataAPI:post to SensorAPI:post_data and SensorDataAP…

    …I:get to SensorAPI:get_data
    
    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 15, 2022
    Copy the full SHA
    6f34010 View commit details
    Browse the repository at this point in the history
  3. Rename module

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 15, 2022
    Copy the full SHA
    0f2a8f0 View commit details
    Browse the repository at this point in the history
  4. Update documentation for moving from SensorDataAPI:post to SensorAPI:…

    …post_data
    
    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 15, 2022
    Copy the full SHA
    bf277b0 View commit details
    Browse the repository at this point in the history
  5. Update introduction

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 15, 2022
    Copy the full SHA
    dcb46f3 View commit details
    Browse the repository at this point in the history
  6. API changelog entry

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 15, 2022
    Copy the full SHA
    d392423 View commit details
    Browse the repository at this point in the history
  7. Implement /sensors [GET] to replace getConnection

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 15, 2022
    Copy the full SHA
    64e1100 View commit details
    Browse the repository at this point in the history
  8. Complete docstring

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 15, 2022
    Copy the full SHA
    c06d768 View commit details
    Browse the repository at this point in the history
  9. Add extra tips to API changelog on how to upgrade from v2 to v3

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 15, 2022
    Copy the full SHA
    257b5b5 View commit details
    Browse the repository at this point in the history
  10. Fix check for belief timing against message type

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 15, 2022
    Copy the full SHA
    b889992 View commit details
    Browse the repository at this point in the history

Commits on Mar 16, 2022

  1. No need to use implementations folder anymore

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 16, 2022
    Copy the full SHA
    6037d60 View commit details
    Browse the repository at this point in the history
  2. Contain endpoint logic within SensorAPI class

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 16, 2022
    Copy the full SHA
    16130a1 View commit details
    Browse the repository at this point in the history

Commits on Mar 17, 2022

  1. Contain endpoint logic within UserAPI class

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 17, 2022
    Copy the full SHA
    1b6394f View commit details
    Browse the repository at this point in the history
  2. Fix mock email and type annotations

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 17, 2022
    Copy the full SHA
    c16a3bf View commit details
    Browse the repository at this point in the history
  3. Initialize schemas within SensorAPI and UserAPI class

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 17, 2022
    Copy the full SHA
    d4e99db View commit details
    Browse the repository at this point in the history
  4. Typos

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 17, 2022
    Copy the full SHA
    cdb7704 View commit details
    Browse the repository at this point in the history
  5. Fix 404 error message

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 17, 2022
    Copy the full SHA
    4c982bb View commit details
    Browse the repository at this point in the history
  6. Remove unused variable declaration

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 17, 2022
    Copy the full SHA
    ea1e1b6 View commit details
    Browse the repository at this point in the history
  7. Clarify use of headers in test

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 17, 2022
    Copy the full SHA
    38d3bc1 View commit details
    Browse the repository at this point in the history
  8. Concerning patching user ids and user account ids, set dump_only for …

    …these fields instead of ignoring them
    
    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 17, 2022
    Copy the full SHA
    9d98f71 View commit details
    Browse the repository at this point in the history

Commits on Mar 18, 2022

  1. Add test cases for unexpected fields

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 18, 2022
    Copy the full SHA
    ca3154f View commit details
    Browse the repository at this point in the history
  2. Also move patch endpoint logic into UserAPI class; this one was a bit…

    … more tricky, because the 'id' fields was being passed to the function twice somehow; use_kwargs instead of use_args was needed to avoid this
    
    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 18, 2022
    Copy the full SHA
    71add34 View commit details
    Browse the repository at this point in the history
  3. Move test utils from dev to v3_0

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 18, 2022
    Copy the full SHA
    1f07045 View commit details
    Browse the repository at this point in the history
  4. Finish moving sensor data tests from dev to v3_0

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 18, 2022
    Copy the full SHA
    d8b2790 View commit details
    Browse the repository at this point in the history
  5. Fix asset tests in dev API by moving back some conftest logic

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 18, 2022
    Copy the full SHA
    0589009 View commit details
    Browse the repository at this point in the history

Commits on Mar 22, 2022

  1. Instantiate schemas outside of endpoint logic to minimize response time

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 22, 2022
    Copy the full SHA
    3743032 View commit details
    Browse the repository at this point in the history
  2. Add mentions of http status to docstrings

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 22, 2022
    Copy the full SHA
    bf10bf3 View commit details
    Browse the repository at this point in the history
  3. Undocument getService from the API introduction

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 22, 2022
    Copy the full SHA
    f159094 View commit details
    Browse the repository at this point in the history
  4. Undocument USEF roles in introduction

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 22, 2022
    Copy the full SHA
    8572b8f View commit details
    Browse the repository at this point in the history
  5. Use "sensor" instead of "connection" in introduction

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 22, 2022
    Copy the full SHA
    1c013e9 View commit details
    Browse the repository at this point in the history
  6. Undocument group notation in introduction

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 22, 2022
    Copy the full SHA
    dd7c59e View commit details
    Browse the repository at this point in the history
  7. Update API changelog for rewrite of introduction

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 22, 2022
    Copy the full SHA
    c808fe3 View commit details
    Browse the repository at this point in the history
  8. Update API changelog entry date

    Signed-off-by: F.N. Claessen <felix@seita.nl>
    Flix6x committed Mar 22, 2022
    Copy the full SHA
    0358dfa View commit details
    Browse the repository at this point in the history