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

Move payload validation to OpenAPI spec #63

Open
leonhard-s opened this issue Mar 5, 2023 · 0 comments
Open

Move payload validation to OpenAPI spec #63

leonhard-s opened this issue Mar 5, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request prio:normal No immediate action required

Comments

@leonhard-s
Copy link
Owner

The Auraxium object model is strongly tied to the Census payload format. This format changes, occasionally with limited notice, and it is unreasonable to require a new Auraxium version every time.

An OpenAPI spec for the game is maintained at ps2-api-docs, and the classes generated from it are extremely similar to the data model described by auraxium.models and auraxium.ps2. It would aid maintainability to simply use that API spec, with auraxium.ps2 only providing convenience wrappers and helper methods on top of it.

This should also include a hook for users to inject their own modified API specs on a per-client basis, either to locally patch Auraxium for recent API changes, or to use a third-party endpoint (such as Sanctuary.Census) whose payloads may not perfectly match the DBG Census.

@leonhard-s leonhard-s added enhancement New feature or request prio:normal No immediate action required labels Mar 5, 2023
@leonhard-s leonhard-s self-assigned this Mar 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request prio:normal No immediate action required
Projects
None yet
Development

No branches or pull requests

1 participant