Merge pull request #50 from sslotnick-isp/hidden-resources

feat: allow hidden/undocumented resources

resource.go

@@ -20,9 +20,15 @@ type Resource struct {
 	operations   []*Operation
 
 	tags []string
+
+	hidden bool
 }
 
 func (r *Resource) toOpenAPI(components *oaComponents) *gabs.Container {
+	if r.hidden {
+		return nil
+	}
+
 	doc := gabs.New()
 
 	for _, sub := range r.subResources {
@@ -110,3 +116,9 @@ func (r *Resource) SubResource(path string) *Resource {
 func (r *Resource) Tags(names ...string) {
 	r.tags = append(r.tags, names...)
 }
+
+// Hidden removes this resource from the OpenAPI spec and documentation. It
+// is intended to be used for things like health check endpoints.
+func (r *Resource) Hidden() {
+	r.hidden = true
+}

resource_test.go

@@ -0,0 +1,24 @@
+package huma
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestResource(t *testing.T) {
+	r := Resource{
+		path: "/test",
+	}
+
+	assert.NotNil(t, r.toOpenAPI(&oaComponents{}))
+}
+
+func TestHiddenResource(t *testing.T) {
+	r := Resource{
+		path: "/test",
+	}
+	r.Hidden()
+
+	assert.Nil(t, r.toOpenAPI(&oaComponents{}))
+}