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
High level api #14
Draft
gernot-h
wants to merge
7
commits into
sw360:master
Choose a base branch
from
gernot-h:high-level-api
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
High level api #14
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
@heliocastro, as you already contributed some valuable refactoring code, perhaps you're interested in reviewing my proposal for an OO API extension here? I would love to hear your opinion... |
gernot-h
force-pushed
the
high-level-api
branch
3 times, most recently
from
April 7, 2022 18:00
312e2e9
to
cdf57f0
Compare
gernot-h
force-pushed
the
high-level-api
branch
from
March 29, 2023 14:56
cdf57f0
to
d6b0e77
Compare
Start a high level API with classes for Release and Component.
Refactor the from_json() methods to one common version.
This allows to directly get data from SW360 using the high-level API - and especially to retrieve complete data from embedded objects like releases in a component or downloading an attachment.
We can only set component_id if releases are embedded in components, but not for releases in projects. As this was a somehow tricky bug, let's add first testcases for it.
This allows for easy copy'n'pasting of an object in interactive sessions plus nicer print output.
gernot-h
force-pushed
the
high-level-api
branch
from
September 20, 2023 09:42
3fd439a
to
9be7e16
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@tngraf, we discussed about this proposal already Siemens-internal a while ago. I still use and love it in a number of places, especially for interactive API usage, so here's the public PR. :)
Several times, I found myself writing project-specific JSON parsing code (especially to parse
['_embedded']['sw360:releases']
and friends). So I started with first basic classes and made some important attributes and especially relations available in an OO fashion.My code tries to be a thin and maintenable extension to the mostly direct API access we have now, only adding OO abstractions where they provide real benefit. To avoid the need to closely follow each SW360 api change, I only make important attributes available, the rest is available as the usual JSON data in the
details
attribute.Example session:
Main open points: