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

update documentation per latest version #34

Merged
merged 3 commits into from
Jan 11, 2023

Conversation

singhpranjali
Copy link
Contributor

@singhpranjali singhpranjali commented Aug 23, 2022

Issues addressed: #33

Copy link
Contributor Author

@singhpranjali singhpranjali left a comment

Choose a reason for hiding this comment

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

In the previous sdk_version, we provide user the ability to pass additional arguments as parameters, like in start_transformation. But in the new version, this is currently not possible (here). Should we be supporting additional arguments in the new version?

@csadorf @pablo-de-andres Please let me know your thoughts

examples/mp_api.py Outdated Show resolved Hide resolved
@singhpranjali singhpranjali requested review from csadorf, unkcpz and pablo-de-andres and removed request for unkcpz August 23, 2022 11:07
@csadorf
Copy link
Collaborator

csadorf commented Aug 23, 2022

In the previous sdk_version, we provide user the ability to pass additional arguments as parameters, like in start_transformation. But in the new version, this is currently not possible (here). Should we be supporting additional arguments in the new version?

@csadorf @pablo-de-andres Please let me know your thoughts

No, the API is well-defined in the standard-app-api and the updateTransformation operation does not accept any arguments in addition to the state update. This is restrictive on purpose to maintain compatibility between different apps that implement this API. A user can provide additional arguments in the form of parameters when they create the transformation: https://github.com/materials-marketplace/standard-app-api/blob/7ad7e680b27df0bfd306fb450e1baf5b8a46a49a/marketplace_standard_app_api/models/transformation.py#L28-L29

marketplace/app/__init__.py Outdated Show resolved Hide resolved
examples/mp_api.py Outdated Show resolved Hide resolved
@singhpranjali singhpranjali force-pushed the feat/documentation-update branch from 4fa1019 to e0ee9be Compare August 24, 2022 08:00
@csadorf
Copy link
Collaborator

csadorf commented Aug 24, 2022

Is this ready for another review?

@singhpranjali singhpranjali force-pushed the feat/documentation-update branch from e0ee9be to 2a96b8d Compare August 29, 2022 07:45
@pablo-de-andres pablo-de-andres merged commit 44d9bc9 into main Jan 11, 2023
@pablo-de-andres pablo-de-andres deleted the feat/documentation-update branch January 11, 2023 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants