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

Implement Waybiller client #1

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Implement Waybiller client #1

wants to merge 6 commits into from

Conversation

iharthi
Copy link
Contributor

@iharthi iharthi commented Nov 7, 2023

Inspired by pyEVR package with similar purpose, extracted from some of the projects where we already used this.

Live waybiller does not validate
some of the data that waybiller
responds with.
@iharthi iharthi force-pushed the initial-client branch 3 times, most recently from 506bacc to 210803d Compare November 7, 2023 12:08
pywaybiller/docs/ExternalAPIWaybillComment.md Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
@AlekefromKz
Copy link

AlekefromKz commented Nov 8, 2023

Currently, it uses the staging server to generate schema

Potentially it might cause issues if staging has a different schema from live, is it a problem?


Probably not a problem that we reveal the staging server to public

@AlekefromKz
Copy link

Could you please explain the pipeline, don't have much experience with packages

Let's say WB adds a new endpoint to add comments to waybills

Then we would need to regenerate the client, and release it with a newer version, right?

And then use that version in the projects where this package is used

@iharthi
Copy link
Contributor Author

iharthi commented Nov 8, 2023

Could you please explain the pipeline, don't have much experience with packages

Pretty much what you wrote. Once Waybiller schema changes, things may break, usually in couple of ways:

  • something is added or changed in API that we don't have - then the code using the client can not use it until we update the client and then whatever projects using the package should bump the version
  • something is removed or changed in a breaking way, so that old schema no longer validates new data (for example, some field that was required is no longer required in server response) - then things will break for code using the client when waybiller goes live with this change, and same update procedure should be performed

.github/ISSUE_TEMPLATE.md Show resolved Hide resolved
Add manual test command to test against
waybiller data dump.

Run manual test for waybills (list and detail)
and fix any issues that cause real data from
waybiller to not validate with the schema.
Waybiller schema has origin_id mistakenly
using optional int, while in reality it
is a mapped id which is optional string
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.

2 participants