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

Add v1beta2 version of validation protos with metadata for results #28

Merged
merged 1 commit into from
Feb 16, 2023

Conversation

rpatel-figure
Copy link
Collaborator

@rpatel-figure rpatel-figure commented Feb 7, 2023

Context

Despite our best efforts to keep models generic and extensible, it's difficult to define schema for loan validation usecases which suit everyone's needs. This PR redefines the existing loan validation protobufs under a new package, v1beta2, which instead use a simple metadata schema for validation results, so that results can simply be a pointer to an entry in an encrypted object store. It still redefines the ValidationResults protobuf verbatim, to act as a recommended schema for what ValidationResultsMetadata should point to.

Changes

  • Add new package tech.figure.validation.v1beta2 which replaces usage of ValidationResults from v1beta1 in wrapper protos into a simple metadata pointer object ValidationResultsMetadata
  • Add entry for validation model documentation to root documentation README
  • Move validation model documentation into own folder to separate its versions
  • Explicitly specify file extension in Markdown links to docs/util.md in attempt to address wonky behavior when clicking said links
    • Doesn't seem to have fixed it entirely at least on my computer, still am redirected to seemingly arbitrary parts of util.md

@rpatel-figure rpatel-figure force-pushed the ravipatel/make-validation-protos-more-meta branch from 2f154ab to 589ad02 Compare February 7, 2023 17:50
@github-actions
Copy link

github-actions bot commented Feb 7, 2023

Test Results

1 tests  ±0   1 ✔️ ±0   0s ⏱️ ±0s
1 suites ±0   0 💤 ±0 
1 files   ±0   0 ±0 

Results for commit 3a69934. ± Comparison against base commit 59bd714.

♻️ This comment has been updated with latest results.

@rpatel-figure rpatel-figure added docs Improvements or additions to documentation feature A new feature minor Backwards-compatible functionality changes (should follow semantic versioning if project is stable) labels Feb 7, 2023
@rpatel-figure rpatel-figure marked this pull request as ready for review February 7, 2023 18:16
@rpatel-figure rpatel-figure marked this pull request as draft February 7, 2023 18:25
@rpatel-figure rpatel-figure force-pushed the ravipatel/make-validation-protos-more-meta branch 3 times, most recently from 6e9d235 to 1544946 Compare February 7, 2023 19:12
@rpatel-figure rpatel-figure marked this pull request as ready for review February 7, 2023 19:14
@rpatel-figure rpatel-figure force-pushed the ravipatel/make-validation-protos-more-meta branch 2 times, most recently from d5b5399 to a36ecb9 Compare February 8, 2023 23:29
@rpatel-figure rpatel-figure force-pushed the ravipatel/make-validation-protos-more-meta branch from a36ecb9 to 3a69934 Compare February 16, 2023 18:22
@rpatel-figure rpatel-figure changed the title Add v1beta2 version of validation protos which use metadata for results Add v1beta2 version of validation protos with metadata for results Feb 16, 2023
@rpatel-figure rpatel-figure merged commit 363be0f into main Feb 16, 2023
@rpatel-figure rpatel-figure deleted the ravipatel/make-validation-protos-more-meta branch February 16, 2023 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation feature A new feature minor Backwards-compatible functionality changes (should follow semantic versioning if project is stable)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants