Skip to content

chore(docs): small improvements about registration #2150

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.

Sign up for GitHub

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

Merged
strantalis merged 4 commits into from
May 5, 2025
Merged

chore(docs): small improvements about registration #2150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
974c788
Fix comments in 'options.go'
b-long May 5, 2025
77ca197
Fix comments in 'README.md'
b-long May 5, 2025
62ee901
Fix repeated word
b-long May 5, 2025
6c6e633
Merge branch 'main' into chore/small-improvements-about-registration
b-long May 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions service/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ contain any special characters. It should be the same as the directory name for

### Registration

Services are registered with the platform using the `service.RegisterService` function. This function expects to be
be given a `serviceregistry.Registration` object.
Services are registered with the platform using the `serviceregistry.RegisterService` function. This function expects to be
given a `serviceregistry.IService` object.

<!-- markdownlint-disable MD034 github embedded sourcecode -->
https://github.com/opentdf/platform/blob/459e82aa3c1d278f5ac5f4835f94d9f3fe90727e/service/pkg/serviceregistry/serviceregistry.go#L48-L55
4 changes: 2 additions & 2 deletions service/pkg/server/options.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ func WithBuiltinAuthZPolicy(policy string) StartOptions {
}

// WithCoreServices option adds additional core services to the platform
// It takes a variadic parameter of type serviceregistry.Registration, which represents the core services to be added.
// It takes a variadic parameter of type serviceregistry.IService, which represents the core services to be added.
func WithCoreServices(services ...serviceregistry.IService) StartOptions {
return func(c StartConfig) StartConfig {
c.extraCoreServices = append(c.extraCoreServices, services...)
Expand All @@ -98,7 +98,7 @@ func WithCoreServices(services ...serviceregistry.IService) StartOptions {

// WithServices option adds additional services to the platform.
// This will set the mode for these services to the namespace name.
// It takes a variadic parameter of type serviceregistry.Registration, which represents the services to be added.
// It takes a variadic parameter of type serviceregistry.IService, which represents the services to be added.
func WithServices(services ...serviceregistry.IService) StartOptions {
return func(c StartConfig) StartConfig {
c.extraServices = append(c.extraServices, services...)
Expand Down
Loading