Skip to content

Add BlockingKey descriptions to openapi.json#188

Merged
ericbuckley merged 5 commits into
mainfrom
doc/blocking-key-description-schema
Feb 6, 2025
Merged

Add BlockingKey descriptions to openapi.json#188
ericbuckley merged 5 commits into
mainfrom
doc/blocking-key-description-schema

Conversation

@ericbuckley

@ericbuckley ericbuckley commented Feb 3, 2025

Copy link
Copy Markdown
Collaborator

Description

Small updates to the existing BlockingKey descriptions and changing the schema to include the description as well as the value when rendering the information in GET /openapi.json

Related Issues

closes #187

<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->

Checklist

Please review and complete the following checklist before submitting your pull request:

  • I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
  • I have reviewed my changes to ensure they are clear, concise, and well-documented.
  • I have updated the documentation, if applicable.
  • I have added or updated test cases to cover my changes, if applicable.
  • I have minimized the number of reviewers to include only those essential for the review.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

  • The code follows best practices and conventions.
  • The changes implement the desired functionality or fix the reported issue.
  • The tests cover the new changes and pass successfully.
  • Any potential edge cases or error scenarios have been considered.

@ericbuckley ericbuckley self-assigned this Feb 3, 2025
@ericbuckley ericbuckley marked this pull request as ready for review February 3, 2025 16:01
m-goggins
m-goggins previously approved these changes Feb 3, 2025

@m-goggins m-goggins left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The overall code looks good to me, just added a few questions to clarify my own understanding.

Comment thread docs/site/reference.md
Comment thread docs/site/reference.md
Comment thread src/recordlinker/models/mpi.py
Comment thread src/recordlinker/schemas/algorithm.py
@codecov

codecov Bot commented Feb 3, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.65%. Comparing base (d76f725) to head (3754b11).
Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #188      +/-   ##
==========================================
+ Coverage   97.51%   97.65%   +0.14%     
==========================================
  Files          31       32       +1     
  Lines        1486     1576      +90     
==========================================
+ Hits         1449     1539      +90     
  Misses         37       37              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

m-goggins
m-goggins previously approved these changes Feb 6, 2025

@m-goggins m-goggins left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks great!

Comment thread docs/site/reference.md Outdated
Co-authored-by: Marcelle <53578688+m-goggins@users.noreply.github.com>
@ericbuckley ericbuckley merged commit 4d0ccfa into main Feb 6, 2025
@ericbuckley ericbuckley deleted the doc/blocking-key-description-schema branch February 6, 2025 17:45
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.

Add BlockingKey descriptions to openapi.json

2 participants