package: rename schema api to author api (#248)

Schema API is unclear, Author API is more clear the API is intended for component authors.
holos-run · Sep 19, 2024 · 6ad24a6 · 6ad24a6
1 parent 57dedc6
commit 6ad24a6
Show file tree

Hide file tree

Showing 11 changed files with 17 additions and 16 deletions.
diff --git a/api/schema/v1alpha3/definitions.go → api/author/v1alpha3/definitions.go b/api/schema/v1alpha3/definitions.go → api/author/v1alpha3/definitions.go
diff --git a/doc/md/api/schema.md → doc/md/api/author.md b/doc/md/api/schema.md → doc/md/api/author.md
@@ -1,5 +1,5 @@
 import DocCardList from '@theme/DocCardList';
 
-# Schema API
+# Author API
 
 <DocCardList />
diff --git a/doc/md/api/schema/v1alpha3.md → doc/md/api/author/v1alpha3.md b/doc/md/api/schema/v1alpha3.md → doc/md/api/author/v1alpha3.md
@@ -3,7 +3,7 @@
 # v1alpha3
 
 ```go
-import "github.com/holos-run/holos/api/schema/v1alpha3"
+import "github.com/holos-run/holos/api/author/v1alpha3"
 ```
 
 Package v1alpha3 contains CUE definitions intended as convenience wrappers around the core data types defined in package core. The purpose of these wrappers is to make life easier for platform engineers by reducing boiler plate code and generating component build plans in a consistent manner.

diff --git a/doc/website/sidebars.ts b/doc/website/sidebars.ts
@@ -44,14 +44,14 @@ const sidebars: SidebarsConfig = {
       link: { type: 'doc', id: 'api' },
       items: [
         {
-          label: 'Schema API',
+          label: 'Author API',
           type: 'category',
-          link: { type: 'doc', id: 'api/schema' },
+          link: { type: 'doc', id: 'api/author' },
           collapsed: true,
           items: [
             {
               type: 'autogenerated',
-              dirName: 'api/schema',
+              dirName: 'api/author',
             },
           ]
         },

diff --git a/...pi/schema/v1alpha3/definitions_go_gen.cue → ...pi/author/v1alpha3/definitions_go_gen.cue b/...pi/schema/v1alpha3/definitions_go_gen.cue → ...pi/author/v1alpha3/definitions_go_gen.cue
@@ -1,6 +1,6 @@
 // Code generated by cue get go. DO NOT EDIT.
 
-//cue:generate cue get go github.com/holos-run/holos/api/schema/v1alpha3
+//cue:generate cue get go github.com/holos-run/holos/api/author/v1alpha3
 
 // Package v1alpha3 contains CUE definitions intended as convenience wrappers
 // around the core data types defined in package core.  The purpose of these

diff --git a/...holos/api/schema/v1alpha3/definitions.cue → ...holos/api/author/v1alpha3/definitions.cue b/...holos/api/schema/v1alpha3/definitions.cue → ...holos/api/author/v1alpha3/definitions.cue
diff --git a/internal/generate/platforms/generate.go b/internal/generate/platforms/generate.go
@@ -9,8 +9,8 @@ package platforms
 //go generate rm -rf cue.mod/gen/github.com/holos-run/holos/api/meta
 //go:generate cue get go github.com/holos-run/holos/api/meta/...
 
-//go generate rm -rf cue.mod/gen/github.com/holos-run/holos/api/schema
-//go:generate cue get go github.com/holos-run/holos/api/schema/...
+//go generate rm -rf cue.mod/gen/github.com/holos-run/holos/api/author
+//go:generate cue get go github.com/holos-run/holos/api/author/...
 
 //go generate rm -rf cue.mod/gen/github.com/holos-run/holos/service/gen/holos/object
 //go:generate cue import ../../../service/holos/object/v1alpha1/object.proto -o cue.mod/gen/github.com/holos-run/holos/service/gen/holos/object/v1alpha1/object.proto_gen.cue -I ../../../proto -f

diff --git a/internal/generate/platforms/guide/.gitignore b/internal/generate/platforms/guide/.gitignore
@@ -6,3 +6,4 @@
 ehthumbs.db
 Thumbs.db
 vendor/
+node_modules/
diff --git a/internal/generate/platforms/guide/readme.md → internal/generate/platforms/guide/README.md b/internal/generate/platforms/guide/readme.md → internal/generate/platforms/guide/README.md
diff --git a/internal/generate/platforms/guide/schema.gen.cue b/internal/generate/platforms/guide/schema.gen.cue
@@ -1,19 +1,19 @@
 package holos
 
-import schema "github.com/holos-run/holos/api/schema/v1alpha3"
+import api "github.com/holos-run/holos/api/author/v1alpha3"
 
-#Platform: schema.#Platform
-#Fleets:   schema.#StandardFleets
+#Platform: api.#Platform
+#Fleets:   api.#StandardFleets
 
 _ComponentConfig: {
 	Resources:  #Resources
 	ArgoConfig: #ArgoConfig
 }
 
-#Helm:       schema.#Helm & _ComponentConfig
-#Kustomize:  schema.#Kustomize & _ComponentConfig
-#Kubernetes: schema.#Kubernetes & _ComponentConfig
+#Helm:       api.#Helm & _ComponentConfig
+#Kustomize:  api.#Kustomize & _ComponentConfig
+#Kubernetes: api.#Kubernetes & _ComponentConfig
 
-#ArgoConfig: schema.#ArgoConfig & {
+#ArgoConfig: api.#ArgoConfig & {
 	ClusterName: _ClusterName
 }
diff --git a/version/embedded/patch b/version/embedded/patch
@@ -1 +1 @@
-1
+2