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.

Sign up for GitHub

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

Jump to bottom

Tidy up JSON API #603

Merged
merged 9 commits into from
Jun 26, 2023
Merged

Tidy up JSON API #603

merged 9 commits into from
Jun 26, 2023

Conversation

joker234
Copy link
Member

@joker234 joker234 commented Jun 26, 2023 •
edited

Description

  • api: use lower camel case instead of hyphen-case for all non-dynamic JSON keys (e.g. not indicator keys)

Corresponding issue

Closes #602

New or changed dependencies

None

Checklist

  • I have updated my branch to main (e.g. through git rebase main)
  • My code follows the style guide and was checked with pre-commit before committing
  • I have commented my code
  • I have added sufficient unit and integration tests
  • I have updated the CHANGELOG.md

joker234 and others added 6 commits June 26, 2023 14:30
@joker234 @matthiasschaub
refactor(api): use - instead of _ for topic properties
97a051e 
Co-authored-by: Matthias Schaub <matthias.schaub@heigit.org>
@joker234 @matthiasschaub
refactor(topics): change topic keys to hyphen-separated keys
8ed0282 
Co-authored-by: Matthias Schaub <matthias.schaub@heigit.org>
@joker234 @matthiasschaub
fix(topics): allow referencing fields by their python name
02958e0 
Co-authored-by: Matthias Schaub <matthias.schaub@heigit.org>
@joker234 @matthiasschaub
refactor(tests/reports): change topic names in python code and tests
ee5e686 
Co-authored-by: Matthias Schaub <matthias.schaub@heigit.org>
@joker234 @matthiasschaub
feature(helpers): add snake_to_lower_camel helper
ac89045 
Co-authored-by: Matthias Schaub <matthias.schaub@heigit.org>
@joker234 @matthiasschaub
refactor(api)!: use lower camel instead of hyphen case in API response
800ddff 
Co-authored-by: Matthias Schaub <matthias.schaub@heigit.org>
@joker234 joker234 added breaking This will break previous versions. Documentation and Changelog update compulsory api labels Jun 26, 2023
@joker234 joker234 added this to the Release 0.15.0 milestone Jun 26, 2023
@joker234 joker234 self-assigned this Jun 26, 2023
joker234 and others added 2 commits June 26, 2023 14:45
@joker234 @matthiasschaub
refactor(api)!: use _ instead of - in yaml definitions
f4608f8 
Co-authored-by: Matthias Schaub <matthias.schaub@heigit.org>
@joker234 @matthiasschaub
refactor(api): change internal usage of JSON parameters to lower came…
c8deb14 
…l case

Co-authored-by: Matthias Schaub <matthias.schaub@heigit.org>
@joker234 @matthiasschaub
add CHANGELOG
0faa517 
Co-authored-by: Matthias Schaub <matthias.schaub@heigit.org>
@joker234 joker234 merged commit 9003baf into main Jun 26, 2023
2 checks passed
@joker234 joker234 deleted the tidy-up-json-api branch June 26, 2023 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@matthiasschaub matthiasschaub matthiasschaub approved these changes

Assignees

@joker234 joker234

Labels
api breaking This will break previous versions. Documentation and Changelog update compulsory
Projects
None yet
Milestone
Release 0.15.0
Development

Successfully merging this pull request may close these issues.

refactor/fix: align JSON output schema
2 participants
@joker234 @matthiasschaub