Skip to content

Add wrapper for http response with version#346

Merged
sajayantony merged 3 commits intonotaryproject:mainfrom
etrexel:etrexel/version-external-response
Oct 21, 2022
Merged

Add wrapper for http response with version#346
sajayantony merged 3 commits intonotaryproject:mainfrom
etrexel:etrexel/version-external-response

Conversation

@etrexel
Copy link
Contributor

@etrexel etrexel commented Oct 11, 2022

Description

Adds a new type that represents the response for an http request. This type insulates the internal implementation from external consumers and adds a version field so that we can track changes that could break external consumers. For now the format of the response is still not that formally typed, but this gives a starting point.

Fixes #261

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • Ran a Ratify request and validated that new version field was part of the response

Checklist:

  • Does the affected code have corresponding tests?
  • Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have appropriate license header?

akashsinghal
akashsinghal previously approved these changes Oct 12, 2022
@susanshi
Copy link
Collaborator

Hi @etrexel , i see this change requires a doc update, could you point us to the doc?

akashsinghal
akashsinghal previously approved these changes Oct 21, 2022
@sajayantony sajayantony merged commit caed268 into notaryproject:main Oct 21, 2022
fseldow pushed a commit to fseldow/ratify that referenced this pull request Dec 7, 2022
bspaans pushed a commit to bspaans/ratify that referenced this pull request Oct 17, 2023
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 version property to Ratify external data response

4 participants