devportal.solo.ioportal.proto

Package : devportal.solo.io

Top

portal.proto

Table of Contents

CustomStyling

Custom Styling options for a portal

Field Type Description
primaryColor devportal.solo.io. .
secondaryColor devportal.solo.io. .
backgroundColor devportal.solo.io. .
navigationLinksColorOverride devportal.solo.io. .
buttonColorOverride devportal.solo.io. .
defaultTextColor devportal.solo.io. .

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 API Products.

Field Type Description
displayName devportal.solo.io. Display name of the portal..
description devportal.solo.io. Description for the portal..
domains []devportal.solo.io. 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 devportal.solo.io.common.devportal.solo.io.DataSource Logo to display on the portal..
favicon devportal.solo.io.common.devportal.solo.io.DataSource Browser favicon for the portal..
banner devportal.solo.io.common.devportal.solo.io.DataSource The banner image for the portal..
customStyling devportal.solo.io.CustomStyling Custom Styling overrides..
staticPages []devportal.solo.io.StaticPage Static markdown content pages for the portal..
publishApiProducts devportal.solo.io.common.devportal.solo.io.Selector Select APIProducts matching these labels for publishing on the Portal. APIProducts are always selected from the Portal’s own namespace.
The set of APIProducts 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 APIProducts and Portal APIProducts do not intersect, the user will see no APIProducts..

PortalStatus

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

Field Type Description
observedGeneration devportal.solo.io. The observed generation of the Portal. When this matches the Portal’s metadata.generation, it indicates the status is up-to-date..
state devportal.solo.io.common.devportal.solo.io.State The current state of the portal..
reason devportal.solo.io. A human-readable string explaining the error, if any..
publishUrl devportal.solo.io. The published URL at which the portal can be accessed.
apiProducts []devportal.solo.io.common.devportal.solo.io.ObjectRef The APIProducts that are currently considered to be part of this Portal..

StaticPage

Field Type Description
name devportal.solo.io. The name of the page..
description devportal.solo.io. Description of the page..
path devportal.solo.io. The path for this page relative to the portal base URL..
navigationLinkName devportal.solo.io. The name of the link displayed on the portal navigation bar..
displayOnHomepage devportal.solo.io. 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 devportal.solo.io.common.devportal.solo.io.DataSource Markdown content for the page..