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

feat(attribute-completeness): improve attribute-completeness for single attribute #810

Merged
merged 31 commits into from
Aug 29, 2024
Merged

feat(attribute-completeness): improve attribute-completeness for single attribute #810

merged 31 commits into from
Aug 29, 2024

Conversation

Gigaszi
Copy link
Collaborator

@Gigaszi Gigaszi commented Jul 22, 2024 •
edited by mmerdes
Loading

Description

Corresponding issue

Closes #
#805

New or changed dependencies

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

TODO

  • Let's put attribute metadata information also into /metadata as with the other metadata.
  • Fix figure (needle and figure heading)
  • Make attribute request parameter optional for other indicators. This request parameter should be required for the Attribute Completeness
  • Take a look at swagger → Swagger should not have Attribute Completeness indicator as example. Example should not container a attribute key.
  • Add Attribute Enum and use it pydantic request models to generate a clean OpenAPI spec
  • Add validation of topic-attribute combination to attribute-completeness

The UI-related tasks were moved to an issue in the Ohsome Dashboard project:

GIScience/ohsome-dashboard#42

Some forward-looking backend-related tasks were moved to a new issue:

#819

@mmerdes mmerdes mentioned this pull request Aug 28, 2024
Closed
8 tasks
mmerdes added a commit that referenced this pull request Aug 28, 2024
@mmerdes
feat: add validation of attribute-topic combination
299afc1 
#810

Co-authored-by: Sascha Fendrich <[email protected]>
mmerdes added a commit that referenced this pull request Aug 28, 2024
@mmerdes @JanReifenrath
feat: include possible attributes for the given topic in error message
ef29504 
#810

Co-authored-by: JanReifenrath <[email protected]>
mmerdes added a commit that referenced this pull request Aug 28, 2024
@mmerdes @JanReifenrath
feat: include possible attributes for the given topic in error message
04a929a 
#810

Co-authored-by: JanReifenrath <[email protected]>
@sfendrich sfendrich changed the title feat(attribute-completeness): add functionality to use multiple attributes and combine them to one filter feat(attribute-completeness): improve attribute-completeness for single attribute Aug 29, 2024
mmerdes added a commit that referenced this pull request Aug 29, 2024
@mmerdes
doc: add docstring comment to new function
8b1f177 
#810

Co-authored-by: Sascha Fendrich <[email protected]>
mmerdes added a commit that referenced this pull request Aug 29, 2024
@mmerdes
test: add unit tests to new function
9cee56c 
#810

Co-authored-by: Sascha Fendrich <[email protected]>
mmerdes added a commit that referenced this pull request Aug 29, 2024
@mmerdes
doc: add more details to change log
9a539fd 
#810

Co-authored-by: Sascha Fendrich <[email protected]>
mmerdes added a commit that referenced this pull request Aug 29, 2024
@mmerdes
doc: fix typos
ee363ae 
#810

Co-authored-by: Sascha Fendrich <[email protected]>
Gigaszi and others added 21 commits August 29, 2024 13:19
@Gigaszi @mmerdes
feat(attribute-completeness): add functionality to use multiple attri…
d4199dd 
…butes and combine them to one filter
@Gigaszi @mmerdes
feat(api): add api endpoint to request attributes for topic
bcdd733
@Gigaszi @mmerdes
fix wrong import path
f30b711
@Gigaszi @mmerdes
feat(attribute-completeness: add test and response model
bafbed8
@Gigaszi @mmerdes
tests(attributes): add response fixture
127f318
@Gigaszi @mmerdes
fix wrong import paths
07a1bec
@Gigaszi @mmerdes
feat(api): add parameter field for attributes and forward to indicato…
b28c637 
…r creation
@mmerdes
doc: fix minor typos
ed064fc
@mmerdes
test: fix indicator integration tests by adding the new request param…
2139f6a 
… `attribute`

discuss with @matthiasschaub if the new parameter should rather be optional
@mmerdes
test: fix unit/smoke tests for IndicatorRequest by adding the new req…
122c1ab 
…uest param named attribute

discuss with @matthiasschaub if the new parameter should rather be optional
@mmerdes
test: fix timeout test by adding the new request param named attribute
f8a16c9 
discuss with @matthiasschaub if the new parameter should rather be optional
@mmerdes
config: ignore venvs with different names and pyenv config files
1b83cbf
@Gigaszi @mmerdes
feat(attributes): add new attributes
ece5570
@mmerdes
test(attribute completeness): add missing decorator and re-record vcr…
3de2807 
… cassette
@matthiasschaub @mmerdes
refactor: reorder optional kwargs in func sig
f14df07
@matthiasschaub @mmerdes
feat: AttributeCompleteness request model and validator
49074ba
@matthiasschaub @mmerdes
test: remove attribute from test
06226f5
@matthiasschaub @mmerdes
refactor: renameing and reordering
b2e6b05
@matthiasschaub @mmerdes
feat: add attributes to /metadata response
5013b6a
@mmerdes
repaired some plotting features
5aab6a8
@matthiasschaub @mmerdes
refactor(attribute-completeness): define custom endpoint
e48c935
Gigaszi and others added 8 commits August 29, 2024 13:29
@Gigaszi @mmerdes
feat: add AttributeEnum
1f5f0a7
@mmerdes
feat: add validation of attribute-topic combination
0848dd8 
#810

Co-authored-by: Sascha Fendrich <[email protected]>
@mmerdes @JanReifenrath
feat: include possible attributes for the given topic in error message
993e3e8 
#810

Co-authored-by: JanReifenrath <[email protected]>
@mmerdes @JanReifenrath
feat: include possible attributes for the given topic in error message
8be3bf3 
#810

Co-authored-by: JanReifenrath <[email protected]>
@mmerdes
doc: add docstring comment to new function
b0b69ce 
#810

Co-authored-by: Sascha Fendrich <[email protected]>
@mmerdes
test: add unit tests to new function
e0654a0 
#810

Co-authored-by: Sascha Fendrich <[email protected]>
@mmerdes
doc: add more details to change log
88c328b 
#810

Co-authored-by: Sascha Fendrich <[email protected]>
@mmerdes
doc: fix typos
f47ced3 
#810

Co-authored-by: Sascha Fendrich <[email protected]>
@mmerdes mmerdes force-pushed the attribute-completeness-enhancement branch from ee363ae to f47ced3 Compare August 29, 2024 11:48
@mmerdes mmerdes requested review from sfendrich and mmerdes August 29, 2024 11:52
mmerdes
mmerdes requested changes Aug 29, 2024
View reviewed changes
Copy link
Collaborator

@mmerdes mmerdes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

review jointly done by @Gigaszi, @sfendrich, and @mmerdes

ohsome_quality_api/utils/validators.py Outdated Show resolved Hide resolved
tests/integrationtests/api/test_indicators.py Outdated Show resolved Hide resolved
tests/integrationtests/api/test_indicators.py Outdated Show resolved Hide resolved
tests/integrationtests/api/test_ohsome_timeout.py Show resolved Hide resolved
mmerdes and others added 2 commits August 29, 2024 14:54
@mmerdes @Gigaszi
refactor: review feedback: improve naming
7a5dc76 
#810

Co-authored-by: Sascha Fendrich <[email protected]>
Co-authored-by: Gigaszi <[email protected]>
@mmerdes @Gigaszi
cleanup: review feedback: remove obsolete cassette annotations
f5ac1b1 
#810

Co-authored-by: Sascha Fendrich <[email protected]>
Co-authored-by: Gigaszi <[email protected]>
mmerdes
mmerdes approved these changes Aug 29, 2024
View reviewed changes
Copy link
Collaborator

@mmerdes mmerdes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

@mmerdes mmerdes merged commit 6f087b4 into main Aug 29, 2024
2 checks passed
@mmerdes mmerdes deleted the attribute-completeness-enhancement branch August 29, 2024 13:17
@tyrasd tyrasd mentioned this pull request Jan 24, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mmerdes mmerdes mmerdes approved these changes

@sfendrich sfendrich Awaiting requested review from sfendrich

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Gigaszi @mmerdes @matthiasschaub