ShortURL: Graduate api v1alpha1 to v1beta1 (#113597)

apps/shorturl/kinds/manifest.cue

@@ -1,68 +1,11 @@
 package kinds
 
 manifest: {
-	// appName is the unique name of your app. It is used to reference the app from other config objects,
-	// and to generate the group used by your app in the app platform API.
 	appName: "shorturl"
 	groupOverride: "shorturl.grafana.app"
-	// groupOverride can be used to specify a non-appName-based API group.
-	// By default, an app's API group is LOWER(REPLACE(appName, '-', '')).ext.grafana.com,
-	// but there are cases where this needs to be changed.
-	// Keep in mind that changing this after an app is deployed can cause problems with clients and/or kind data.
-	// groupOverride: foo.ext.grafana.app
-
-	// versions is a map of versions supported by your app. Version names should follow the format "v<integer>" or
-	// "v<integer>(alpha|beta)<integer>". Each version contains the kinds your app manages for that version.
-	// If your app needs access to kinds managed by another app, use permissions.accessKinds to allow your app access.
 	versions: {
-	    "v1alpha1": v1alpha1
-	}
-	// extraPermissions contains any additional permissions your app may require to function.
-	// Your app will always have all permissions for each kind it manages (the items defined in 'kinds').
-	extraPermissions: {
-		// If your app needs access to additional kinds supplied by other apps, you can list them here
-		accessKinds: [
-			// Here is an example for your app accessing the playlist kind for reads and watch
-			// {
-			//	group: "playlist.grafana.app"
-			//	resource: "playlists"
-			//	actions: ["get","list","watch"]
-			// }
-		]
+	    "v1beta1": {
+	        kinds: [shorturl]
+	    }
 	}
 }
-
-// v1alpha1 is the v1alpha1 version of the app's API.
-// It includes kinds which the v1alpha1 API serves, and (future) custom routes served globally from the v1alpha1 version.
-v1alpha1: {
-    // kinds is the list of kinds served by this version
-    kinds: [shorturl]
-    // [OPTIONAL]
-    // served indicates whether this particular version is served by the API server.
-    // served should be set to false before a version is removed from the manifest entirely.
-    // served defaults to true if not present.
-    served: true
-    // [OPTIONAL]
-    // Codegen is a trait that tells the grafana-app-sdk, or other code generation tooling, how to process this kind.
-    // If not present, default values within the codegen trait are used.
-    // If you wish to specify codegen per-version, put this section in the version's object
-    // (for example, <no value>v1alpha1) instead.
-    codegen: {
-        // [OPTIONAL]
-        // ts contains TypeScript code generation properties for the kind
-        ts: {
-            // [OPTIONAL]
-            // enabled indicates whether the CLI should generate front-end TypeScript code for the kind.
-            // Defaults to true if not present.
-            enabled: true
-        }
-        // [OPTIONAL]
-        // go contains go code generation properties for the kind
-        go: {
-            // [OPTIONAL]
-            // enabled indicates whether the CLI should generate back-end go code for the kind.
-            // Defaults to true if not present.
-            enabled: true
-        }
-    }
-}

apps/shorturl/pkg/apis/shorturl/v1beta1/constants.go

@@ -1,4 +1,4 @@
-package v1alpha1
+package v1beta1
 
 import "k8s.io/apimachinery/pkg/runtime/schema"
 
@@ -6,7 +6,7 @@ const (
 	// APIGroup is the API group used by all kinds in this package
 	APIGroup = "shorturl.grafana.app"
 	// APIVersion is the API version used by all kinds in this package
-	APIVersion = "v1alpha1"
+	APIVersion = "v1beta1"
 )
 
 var (

apps/shorturl/pkg/apis/shorturl/v1beta1/shorturl_client_gen.go

@@ -1,4 +1,4 @@
-package v1alpha1
+package v1beta1
 
 import (
 	"context"

apps/shorturl/pkg/apis/shorturl/v1beta1/shorturl_codec_gen.go

@@ -2,7 +2,7 @@
 // Code generated by grafana-app-sdk. DO NOT EDIT.
 //
 
-package v1alpha1
+package v1beta1
 
 import (
 	"encoding/json"

apps/shorturl/pkg/apis/shorturl/v1beta1/shorturl_getgoto_response_types_gen.go

@@ -1,6 +1,6 @@
 // Code generated - EDITING IS FUTILE. DO NOT EDIT.
 
-package v1alpha1
+package v1beta1
 
 // +k8s:openapi-gen=true
 type GetGoto struct {

apps/shorturl/pkg/apis/shorturl/v1beta1/shorturl_metadata_gen.go

@@ -1,6 +1,6 @@
 // Code generated - EDITING IS FUTILE. DO NOT EDIT.
 
-package v1alpha1
+package v1beta1
 
 import (
 	time "time"

apps/shorturl/pkg/apis/shorturl/v1beta1/shorturl_object_gen.go

@@ -2,7 +2,7 @@
 // Code generated by grafana-app-sdk. DO NOT EDIT.
 //
 
-package v1alpha1
+package v1beta1
 
 import (
 	"fmt"

apps/shorturl/pkg/apis/shorturl/v1beta1/shorturl_schema_gen.go

@@ -2,7 +2,7 @@
 // Code generated by grafana-app-sdk. DO NOT EDIT.
 //
 
-package v1alpha1
+package v1beta1
 
 import (
 	"github.com/grafana/grafana-app-sdk/resource"
@@ -10,7 +10,7 @@ import (
 
 // schema is unexported to prevent accidental overwrites
 var (
-	schemaShortURL = resource.NewSimpleSchema("shorturl.grafana.app", "v1alpha1", &ShortURL{}, &ShortURLList{}, resource.WithKind("ShortURL"),
+	schemaShortURL = resource.NewSimpleSchema("shorturl.grafana.app", "v1beta1", &ShortURL{}, &ShortURLList{}, resource.WithKind("ShortURL"),
 		resource.WithPlural("shorturls"), resource.WithScope(resource.NamespacedScope))
 	kindShortURL = resource.Kind{
 		Schema: schemaShortURL,

apps/shorturl/pkg/apis/shorturl/v1beta1/shorturl_spec_gen.go

@@ -1,6 +1,6 @@
 // Code generated - EDITING IS FUTILE. DO NOT EDIT.
 
-package v1alpha1
+package v1beta1
 
 // +k8s:openapi-gen=true
 type ShortURLSpec struct {

apps/shorturl/pkg/apis/shorturl/v1beta1/shorturl_status_gen.go

@@ -1,6 +1,6 @@
 // Code generated - EDITING IS FUTILE. DO NOT EDIT.
 
-package v1alpha1
+package v1beta1
 
 // +k8s:openapi-gen=true
 type ShortURLstatusOperatorState struct {

apps/shorturl/pkg/apis/shorturl_manifest.go

@@ -16,22 +16,22 @@ import (
 	"k8s.io/kube-openapi/pkg/spec3"
 	"k8s.io/kube-openapi/pkg/validation/spec"
 
-	v1alpha1 "github.com/grafana/grafana/apps/shorturl/pkg/apis/shorturl/v1alpha1"
+	v1beta1 "github.com/grafana/grafana/apps/shorturl/pkg/apis/shorturl/v1beta1"
 )
 
 var (
-	rawSchemaShortURLv1alpha1     = []byte(`{"OperatorState":{"additionalProperties":false,"properties":{"descriptiveState":{"description":"descriptiveState is an optional more descriptive state field which has no requirements on format","type":"string"},"details":{"additionalProperties":{"additionalProperties":{},"type":"object"},"description":"details contains any extra information that is operator-specific","type":"object"},"lastEvaluation":{"description":"lastEvaluation is the ResourceVersion last evaluated","type":"string"},"state":{"description":"state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.","enum":["success","in_progress","failed"],"type":"string"}},"required":["lastEvaluation","state"],"type":"object"},"ShortURL":{"properties":{"spec":{"$ref":"#/components/schemas/spec"},"status":{"$ref":"#/components/schemas/status"}},"required":["spec"]},"spec":{"additionalProperties":false,"properties":{"path":{"description":"The original path to where the short url is linking too e.g. https://localhost:3000/eer8i1kictngga/new-dashboard-with-lib-panel","type":"string"}},"required":["path"],"type":"object"},"status":{"additionalProperties":false,"properties":{"additionalFields":{"additionalProperties":{"additionalProperties":{},"type":"object"},"description":"additionalFields is reserved for future use","type":"object"},"lastSeenAt":{"description":"The last time the short URL was used, 0 is the initial value","type":"integer"},"operatorStates":{"additionalProperties":{"$ref":"#/components/schemas/OperatorState"},"description":"operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.","type":"object"}},"required":["lastSeenAt"],"type":"object"}}`)
-	versionSchemaShortURLv1alpha1 app.VersionSchema
-	_                             = json.Unmarshal(rawSchemaShortURLv1alpha1, &versionSchemaShortURLv1alpha1)
+	rawSchemaShortURLv1beta1     = []byte(`{"OperatorState":{"additionalProperties":false,"properties":{"descriptiveState":{"description":"descriptiveState is an optional more descriptive state field which has no requirements on format","type":"string"},"details":{"additionalProperties":{"additionalProperties":{},"type":"object"},"description":"details contains any extra information that is operator-specific","type":"object"},"lastEvaluation":{"description":"lastEvaluation is the ResourceVersion last evaluated","type":"string"},"state":{"description":"state describes the state of the lastEvaluation.\nIt is limited to three possible states for machine evaluation.","enum":["success","in_progress","failed"],"type":"string"}},"required":["lastEvaluation","state"],"type":"object"},"ShortURL":{"properties":{"spec":{"$ref":"#/components/schemas/spec"},"status":{"$ref":"#/components/schemas/status"}},"required":["spec"]},"spec":{"additionalProperties":false,"properties":{"path":{"description":"The original path to where the short url is linking too e.g. https://localhost:3000/eer8i1kictngga/new-dashboard-with-lib-panel","type":"string"}},"required":["path"],"type":"object"},"status":{"additionalProperties":false,"properties":{"additionalFields":{"additionalProperties":{"additionalProperties":{},"type":"object"},"description":"additionalFields is reserved for future use","type":"object"},"lastSeenAt":{"description":"The last time the short URL was used, 0 is the initial value","type":"integer"},"operatorStates":{"additionalProperties":{"$ref":"#/components/schemas/OperatorState"},"description":"operatorStates is a map of operator ID to operator state evaluations.\nAny operator which consumes this kind SHOULD add its state evaluation information to this field.","type":"object"}},"required":["lastSeenAt"],"type":"object"}}`)
+	versionSchemaShortURLv1beta1 app.VersionSchema
+	_                            = json.Unmarshal(rawSchemaShortURLv1beta1, &versionSchemaShortURLv1beta1)
 )
 
 var appManifestData = app.ManifestData{
 	AppName:          "shorturl",
 	Group:            "shorturl.grafana.app",
-	PreferredVersion: "v1alpha1",
+	PreferredVersion: "v1beta1",
 	Versions: []app.ManifestVersion{
 		{
-			Name:   "v1alpha1",
+			Name:   "v1beta1",
 			Served: true,
 			Kinds: []app.ManifestVersionKind{
 				{
@@ -47,7 +47,7 @@ var appManifestData = app.ManifestData{
 							},
 						},
 					},
-					Schema: &versionSchemaShortURLv1alpha1,
+					Schema: &versionSchemaShortURLv1beta1,
 					Routes: map[string]spec3.PathProps{
 						"/goto": {
 							Get: &spec3.Operation{
@@ -106,7 +106,7 @@ func RemoteManifest() app.Manifest {
 }
 
 var kindVersionToGoType = map[string]resource.Kind{
-	"ShortURL/v1alpha1": v1alpha1.ShortURLKind(),
+	"ShortURL/v1beta1": v1beta1.ShortURLKind(),
 }
 
 // ManifestGoTypeAssociator returns the associated resource.Kind instance for a given Kind and Version, if one exists.
@@ -117,7 +117,7 @@ func ManifestGoTypeAssociator(kind, version string) (goType resource.Kind, exist
 }
 
 var customRouteToGoResponseType = map[string]any{
-	"v1alpha1|ShortURL|goto|GET": v1alpha1.GetGoto{},
+	"v1beta1|ShortURL|goto|GET": v1beta1.GetGoto{},
 }
 
 // ManifestCustomRouteResponsesAssociator returns the associated response go type for a given kind, version, custom route path, and method, if one exists.

apps/shorturl/pkg/app/app.go

@@ -18,7 +18,7 @@ import (
 	"github.com/grafana/grafana-app-sdk/operator"
 	"github.com/grafana/grafana-app-sdk/resource"
 	"github.com/grafana/grafana-app-sdk/simple"
-	shorturlv1alpha1 "github.com/grafana/grafana/apps/shorturl/pkg/apis/shorturl/v1alpha1"
+	shorturlv1beta1 "github.com/grafana/grafana/apps/shorturl/pkg/apis/shorturl/v1beta1"
 	"github.com/grafana/grafana/pkg/apimachinery/identity"
 )
 
@@ -31,11 +31,11 @@ var (
 func New(cfg app.Config) (app.App, error) {
 	cfg.KubeConfig.APIPath = "apis"
 	tmp, err := k8s.NewClientRegistry(cfg.KubeConfig, k8s.DefaultClientConfig()).
-		ClientFor(shorturlv1alpha1.ShortURLKind())
+		ClientFor(shorturlv1beta1.ShortURLKind())
 	if err != nil {
 		return nil, fmt.Errorf("unable to create client")
 	}
-	client := shorturlv1alpha1.NewShortURLClient(tmp)
+	client := shorturlv1beta1.NewShortURLClient(tmp)
 
 	simpleConfig := simple.AppConfig{
 		Name:       "shorturl",
@@ -49,11 +49,11 @@ func New(cfg app.Config) (app.App, error) {
 		},
 		ManagedKinds: []simple.AppManagedKind{
 			{
-				Kind: shorturlv1alpha1.ShortURLKind(),
+				Kind: shorturlv1beta1.ShortURLKind(),
 				Validator: &simple.Validator{
 					ValidateFunc: func(ctx context.Context, req *app.AdmissionRequest) error {
 						// Cast the incoming object to ShortURL for validation
-						shortURL, ok := req.Object.(*shorturlv1alpha1.ShortURL)
+						shortURL, ok := req.Object.(*shorturlv1beta1.ShortURL)
 						if !ok {
 							return fmt.Errorf("expected ShortURL object, got %T", req.Object)
 						}
@@ -105,7 +105,7 @@ func New(cfg app.Config) (app.App, error) {
 
 						url = url + "/" + info.Spec.Path
 						if req.URL.Query().Get("redirect") == "false" { // helpful for testing
-							return json.NewEncoder(w).Encode(shorturlv1alpha1.GetGoto{
+							return json.NewEncoder(w).Encode(shorturlv1beta1.GetGoto{
 								Url: url,
 							})
 						}
@@ -133,10 +133,10 @@ func New(cfg app.Config) (app.App, error) {
 
 func GetKinds() map[schema.GroupVersion][]resource.Kind {
 	gv := schema.GroupVersion{
-		Group:   shorturlv1alpha1.ShortURLKind().Group(),
-		Version: shorturlv1alpha1.ShortURLKind().Version(),
+		Group:   shorturlv1beta1.ShortURLKind().Group(),
+		Version: shorturlv1beta1.ShortURLKind().Version(),
 	}
 	return map[schema.GroupVersion][]resource.Kind{
-		gv: {shorturlv1alpha1.ShortURLKind()},
+		gv: {shorturlv1beta1.ShortURLKind()},
 	}
 }