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

docs(docs): Add API Versioning ADR #1009

Merged
merged 8 commits into from
Oct 20, 2024
Merged

docs(docs): Add API Versioning ADR #1009

merged 8 commits into from
Oct 20, 2024

Conversation

stevenj
Copy link
Collaborator

@stevenj stevenj commented Oct 16, 2024

Description

This adds an ADR to describe our API versioning strategy and rules.

Description of Changes

Documentation only to add the new ADR.

Rendered Version: https://input-output-hk.github.io/catalyst-voices/branch/adr_api_endpoints/architecture/09_architecture_decisions/0007-api-versions/

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

@stevenj stevenj enabled auto-merge (squash) October 16, 2024 07:46
Copy link
Contributor

github-actions bot commented Oct 16, 2024

Test Report | ${\color{lightgreen}Pass: 297/297}$ | ${\color{red}Fail: 0/297}$ |

@stevenj stevenj marked this pull request as draft October 16, 2024 08:03
auto-merge was automatically disabled October 16, 2024 08:03

Pull request was converted to draft

@stevenj stevenj added do not merge yet PR is not ready to be merged yet review me PR is ready for review labels Oct 16, 2024
@stevenj stevenj added this to the M4: Voting & Delegation milestone Oct 16, 2024
nathanbogale
nathanbogale previously approved these changes Oct 16, 2024
neil-iohk
neil-iohk previously approved these changes Oct 16, 2024
@stevenj stevenj marked this pull request as ready for review October 17, 2024 04:30
Copy link
Collaborator

@minikin minikin left a comment

Choose a reason for hiding this comment

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

That's a beneficial ADR, and it looks good to me overall.

@stevenj stevenj dismissed stale reviews from neil-iohk and nathanbogale via 09aeab3 October 18, 2024 05:49
@stevenj stevenj removed the do not merge yet PR is not ready to be merged yet label Oct 18, 2024
@minikin minikin enabled auto-merge (squash) October 20, 2024 09:21
@minikin minikin self-requested a review October 20, 2024 09:21
Copy link
Collaborator

@minikin minikin left a comment

Choose a reason for hiding this comment

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

LGTM

@minikin minikin merged commit e158fed into main Oct 20, 2024
37 checks passed
@minikin minikin deleted the adr/api_endpoints branch October 20, 2024 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review me PR is ready for review
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants