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

Specification for Preservation of ARM API Versioning #1538

Merged
merged 8 commits into from
Jun 22, 2021

Conversation

theunrepentantgeek
Copy link
Member

@theunrepentantgeek theunrepentantgeek commented Jun 1, 2021

What this PR does / why we need it:

Initial specification for how we will preserve the correct API version and ensure we use it when interacting with ARM.

Resolves #1468

Direct link for viewing with embedded diagrams:
https://github.com/Azure/azure-service-operator/blob/spec/api-versioning/docs/design/api-versions.md

How does this PR make you feel:
gif

If applicable:

  • this PR contains documentation

@theunrepentantgeek theunrepentantgeek self-assigned this Jun 2, 2021

### API Preservation

When generating the storage variants of each resource, we'll inject a new `ApiVersion` property of type **string**.
Copy link
Member

Choose a reason for hiding this comment

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

Does this need updating? In the whiteboard discussion we had you were talking about a GVK property instead?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, I've now updated the spec.

@theunrepentantgeek theunrepentantgeek changed the title Specification for API Versioning Specification for Preservation of ARM API Versioning Jun 15, 2021
@codecov-commenter
Copy link

codecov-commenter commented Jun 15, 2021

Codecov Report

Merging #1538 (5c32272) into master (ac7b7b1) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1538   +/-   ##
=======================================
  Coverage   63.43%   63.43%           
=======================================
  Files         181      181           
  Lines       11796    11796           
=======================================
  Hits         7483     7483           
  Misses       3644     3644           
  Partials      669      669           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ac7b7b1...5c32272. Read the comment docs.

Copy link
Member

@babbageclunk babbageclunk left a comment

Choose a reason for hiding this comment

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

Nice - like the diagrams.

@theunrepentantgeek theunrepentantgeek merged commit b6fed6a into master Jun 22, 2021
@theunrepentantgeek theunrepentantgeek deleted the spec/api-versioning branch June 22, 2021 19:01
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.

Handle apiVersion property specially
3 participants