portal.proto

Package : devportal.solo.io

Top

portal.proto

Table of Contents

CustomStyling

Custom Styling options for a portal

Field Type Label Description
primaryColor string
secondaryColor string
backgroundColor string
navigationLinksColorOverride string
buttonColorOverride string
defaultTextColor string

KeyScope

A KeyScope defines the scope (set of accessible ApiDocs) of an Api Key provisioned for the Portal.

Field Type Label Description
name string Name of the scope. This field is required and must be a unique, DNS-compliant string. The name of the key scope will determine how the API key secrets will be labeled. Each API key secret generated for this key scope will include a label with key portals.devportal.solo.io/<PORTAL_NS>.<PORTAL_NAME>.<KEY_SCOPE_NAME> and value equal to “true”.
namespace string The namespace in which the ApiKeys will be created for this key scope will be created. If empty, defaults to the namespace of the Portal
displayName string Optional display name for the key scope. If empty, portals will display the key scope name.
description string Description of the key scope.
apiDocs Selector Create ApiKeys to access ApiDocs matching these labels. Can only include ApiDocs published to the Portal.
If the Group ApiDocs and Portal ApiDocs do not intersect, the user will see no ApiDocs.

KeyScopeStatus

Gives the Status of a KeyScope that lives on the portal.

Field Type Label Description
name string Name of the scope
accessibleApiDocs []ObjectRef repeated The API docs that can be accessed with this key scope.
provisionedKeys []ObjectRef repeated The ApiKey Secrets that have been provisioned for this key scope.

PortalSpec

A PortalSpec tells the Dev Portal Operator to fetch and serve static assets which are used by the Dev Portal UI. Each portal can publish one or more ApiDocs.

Field Type Label Description
displayName string Display name of the portal.
description string Description for the portal.
domains []string repeated The domains on which this Portal will be served. The Host header received by the Portal Web App will be matched to one of these domains in order to determine which Portal will be served.
To prevent undefined behavior, creating a Portal whose domain conflicts with an existing Portal will result in the Portal resource being placed into an ‘Invalid’ state.
primaryLogo DataSource Logo to display on the portal.
favicon DataSource Browser favicon for the portal.
banner DataSource The banner image for the portal.
customStyling CustomStyling Custom Styling overrides.
staticPages []StaticPage repeated Static markdown content pages for the portal.
publishApiDocs Selector Select ApiDocs matching these labels for publishing on the Portal. ApiDocs are always selected from the Portal’s own namespace.
The set of ApiDocs a specific user sees upon login will be filtered by the permissions associated either with that user’s AccessLevel, or with the AccessLevels of the groups that the user is a member of.
If the User’s accessible ApiDocs and Portal ApiDocs do not intersect, the user will see no ApiDocs.
keyScopes []KeyScope repeated KeyScopes define available scopes for provisioning Api Keys to work with the ApiDocs published on this portal

PortalStatus

The current status of the Portal. The Portal will be processed as soon as it is created in the cluster.

Field Type Label Description
observedGeneration int64 The observed generation of the Portal. When this matches the Portal’s metadata.generation, it indicates the status is up-to-date.
state State The current state of the portal.
reason string A human-readable string explaining the error, if any.
publishUrl string The published URL at which the portal can be accessed
apiDocs []ObjectRef repeated The ApiDocs that are currently considered to be part of this Portal.
keyScopes []KeyScopeStatus repeated Status info for each KeyScope

StaticPage

Field Type Label Description
name string The name of the page.
description string Description of the page.
path string The path for this page relative to the portal base URL.
navigationLinkName string The name of the link displayed on the portal navigation bar.
displayOnHomepage bool Set to true if you want to display a tile that links to the static page on the portal home page. Only one of the static pages for a portal can set this flag to true.
content DataSource Markdown content for the page.