Skip to content

chore: retains apiversion in app description and app deployments#189

Draft
vireshnavalli wants to merge 2 commits into
pre-draftfrom
chore/134-apiversion-changes
Draft

chore: retains apiversion in app description and app deployments#189
vireshnavalli wants to merge 2 commits into
pre-draftfrom
chore/134-apiversion-changes

Conversation

@vireshnavalli

Copy link
Copy Markdown
Contributor

Description

As the API routes include version within URL there is not need to explicitly have 'apiVersion' attribute for margo specified REST apis . Keeping the apiVersion in ApplicationDescription and ApplicationDeployment, although the version string needs to be the same as the OpenAPI version and follow semantic versioning.

Issues Addressed

Address #134

Change Type

Please select the relevant options:

  • Fix (change that resolves an issue)
  • New enhancement (change that adds specification content)
  • Content edits (change that edits existing content)

Checklist

  • I have read the CONTRIBUTING document.
  • My changes adhere to the established patterns, and best practices.

Signed-off-by: vireshnavalli <viresh-r.navalli@capgemini.com>
@vireshnavalli vireshnavalli requested a review from a team as a code owner June 18, 2026 04:40
@vireshnavalli vireshnavalli marked this pull request as draft June 18, 2026 04:40
Signed-off-by: vireshnavalli <viresh-r.navalli@capgemini.com>

@nilanjan-samajdar nilanjan-samajdar left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The apiVersion should be v1.0.0-rc.2
Corresponding to the recently release spec version v1.0.0-rc.2

# Demonstrates validation of kind field
# Invalid kind of Kubernetes custom resource.
apiVersion: margo.org/v1-alpha1
apiVersion: 1.0.0

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should be v1.0.0-rc.2
Corresponding to v1.0.0-rc.2

# Demonstrates validation of id field
# Invalid id format being defined in this test
apiVersion: margo.org/v1-alpha1
apiVersion: 1.0.0

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should be v1.0.0-rc.2
Corresponding to v1.0.0-rc.2

@@ -1,4 +1,4 @@
apiVersion: margo.org/v1-alpha1
apiVersion: 1.0.0

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should be v1.0.0-rc.2
Corresponding to v1.0.0-rc.2

@@ -1,4 +1,4 @@
apiVersion: margo.org/v1-alpha1
apiVersion: 1.0.0

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should be v1.0.0-rc.2
Corresponding to v1.0.0-rc.2

# Demonstrates validation of kind field
# Invalid kind of Kubernetes custom resource.
apiVersion: application.margo.org/v1alpha1
apiVersion: 1.0.0

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should be v1.0.0-rc.2
Corresponding to v1.0.0-rc.2

@@ -1,4 +1,4 @@
apiVersion: application.margo.org/v1alpha1
apiVersion: 1.0.0

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should be v1.0.0-rc.2
Corresponding to v1.0.0-rc.2

@@ -1,4 +1,4 @@
apiVersion: application.margo.org/v1alpha1
apiVersion: 1.0.0

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should be v1.0.0-rc.2
Corresponding to v1.0.0-rc.2

@@ -1,4 +1,4 @@
apiVersion: application.margo.org/v1alpha1
apiVersion: 1.0.0

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should be v1.0.0-rc.2
Corresponding to v1.0.0-rc.2

@@ -1,4 +1,4 @@
apiVersion: application.margo.org/v1alpha1
apiVersion: 1.0.0

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should be v1.0.0-rc.2
Corresponding to v1.0.0-rc.2


```yaml
apiVersion: application.margo.org/v1alpha1
apiVersion: 1.0.0

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should be v1.0.0-rc.2
Corresponding to v1.0.0-rc.2

@phil-abb

Copy link
Copy Markdown
Contributor

Issue #134 is in the Gen. Improvements SUP Required column. There was no SUP for this creation.

@jachstet-sea

jachstet-sea commented Jun 18, 2026

Copy link
Copy Markdown
Member

Since apiVersion: margo.org/v1-alpha1 is what is contained in the tags https://github.com/margo/specification/releases/tag/v1.0.0-rc.2 and https://github.com/margo/specification/releases/tag/plugfest-2026-07 I assume that the change proposed here (which makes sense) will be done AFTER the July Plugfest and we will keep apiVersion: margo.org/v1-alpha1 for the plugfest?

@ajcraig

ajcraig commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Issue #134 is in the Gen. Improvements SUP Required column. There was no SUP for this creation.

Yes, @vireshnavalli please close this PR and recreate as a SUP within the specification enhancements repository.

Since apiVersion: margo.org/v1-alpha1 is what is contained in the tags https://github.com/margo/specification/releases/tag/v1.0.0-rc.2 and https://github.com/margo/specification/releases/tag/plugfest-2026-07 I assume that the change proposed here (which makes sense) will be done AFTER the July Plugfest and we will keep apiVersion: margo.org/v1-alpha1 for the plugfest?

@jachstet-sea: This PR will be closed so changs will not be implemented prior to plugfest. As for the API definition that will be the baseline for Plugfest testing, the current version is 1.0.0 although incorrect that's what we will run with during plugfest.

I'll let the newly created SUP work out the API versioning strategy.

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.

5 participants