@apistudio/apim-cli
Version:
CLI for API Management Products
1,076 lines (1,075 loc) • 2.53 MB
TypeScript
import { AuthProviderType, ApigeeDevOnboardingIntegrationAuthType } from './constants';
export declare const oidcIssuerMetadataSchema: {
readonly type: "object";
readonly properties: {
readonly end_session_endpoint: {
readonly type: "string";
};
readonly token_endpoint: {
readonly type: "string";
};
readonly authorization_endpoint: {
readonly type: "string";
};
readonly jwks_uri: {
readonly type: "string";
};
};
readonly required: readonly ["token_endpoint", "authorization_endpoint"];
readonly additionalProperties: true;
};
export declare const oidcProviderConfigSchema: {
readonly type: "object";
readonly properties: {
readonly type: {
readonly type: "string";
readonly const: AuthProviderType.OIDC;
};
readonly title: {
readonly type: "string";
};
readonly pkce: {
readonly type: "boolean";
readonly default: false;
};
readonly configurationUrl: {
readonly type: "string";
readonly minLength: 1;
};
readonly configuration: {
readonly type: "object";
readonly properties: {
readonly end_session_endpoint: {
readonly type: "string";
};
readonly token_endpoint: {
readonly type: "string";
};
readonly authorization_endpoint: {
readonly type: "string";
};
readonly jwks_uri: {
readonly type: "string";
};
};
readonly required: readonly ["token_endpoint", "authorization_endpoint"];
readonly additionalProperties: true;
};
readonly clientId: {
readonly type: "string";
readonly minLength: 1;
};
readonly clientSecret: {
readonly type: "string";
readonly minLength: 0;
};
readonly teamsClaimName: {
readonly type: "string";
};
readonly teamsClaimMap: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
readonly defaultTeams: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly scopes: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly tokenExpirationTime: {
readonly type: "number";
};
readonly authorizationRequestCustomParams: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
readonly tokenRequestCustomParams: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
readonly audience: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
};
readonly required: readonly ["type", "clientId"];
readonly oneOf: readonly [{
readonly required: readonly ["configurationUrl"];
}, {
readonly required: readonly ["configuration"];
}];
readonly additionalProperties: false;
};
export declare const saml2ProviderConfigSchema: {
readonly type: "object";
readonly properties: {
readonly type: {
readonly type: "string";
readonly const: AuthProviderType.SAML2;
};
readonly title: {
readonly type: "string";
};
readonly issuerId: {
readonly type: "string";
};
readonly entityId: {
readonly type: "string";
};
readonly ssoUrl: {
readonly type: "string";
};
readonly x509PublicCert: {
readonly type: "string";
};
readonly teamsAttributeName: {
readonly type: "string";
readonly default: "https://redocly.com/sso/teams";
};
readonly teamsAttributeMap: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
readonly defaultTeams: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
};
readonly additionalProperties: false;
readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
};
export declare const authProviderConfigSchema: {
readonly oneOf: readonly [{
readonly type: "object";
readonly properties: {
readonly type: {
readonly type: "string";
readonly const: AuthProviderType.OIDC;
};
readonly title: {
readonly type: "string";
};
readonly pkce: {
readonly type: "boolean";
readonly default: false;
};
readonly configurationUrl: {
readonly type: "string";
readonly minLength: 1;
};
readonly configuration: {
readonly type: "object";
readonly properties: {
readonly end_session_endpoint: {
readonly type: "string";
};
readonly token_endpoint: {
readonly type: "string";
};
readonly authorization_endpoint: {
readonly type: "string";
};
readonly jwks_uri: {
readonly type: "string";
};
};
readonly required: readonly ["token_endpoint", "authorization_endpoint"];
readonly additionalProperties: true;
};
readonly clientId: {
readonly type: "string";
readonly minLength: 1;
};
readonly clientSecret: {
readonly type: "string";
readonly minLength: 0;
};
readonly teamsClaimName: {
readonly type: "string";
};
readonly teamsClaimMap: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
readonly defaultTeams: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly scopes: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly tokenExpirationTime: {
readonly type: "number";
};
readonly authorizationRequestCustomParams: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
readonly tokenRequestCustomParams: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
readonly audience: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
};
readonly required: readonly ["type", "clientId"];
readonly oneOf: readonly [{
readonly required: readonly ["configurationUrl"];
}, {
readonly required: readonly ["configuration"];
}];
readonly additionalProperties: false;
}, {
readonly type: "object";
readonly properties: {
readonly type: {
readonly type: "string";
readonly const: AuthProviderType.SAML2;
};
readonly title: {
readonly type: "string";
};
readonly issuerId: {
readonly type: "string";
};
readonly entityId: {
readonly type: "string";
};
readonly ssoUrl: {
readonly type: "string";
};
readonly x509PublicCert: {
readonly type: "string";
};
readonly teamsAttributeName: {
readonly type: "string";
readonly default: "https://redocly.com/sso/teams";
};
readonly teamsAttributeMap: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
readonly defaultTeams: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
};
readonly additionalProperties: false;
readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
}];
readonly discriminator: {
readonly propertyName: "type";
};
};
export declare const ssoDirectConfigSchema: {
readonly type: "object";
readonly additionalProperties: {
readonly oneOf: readonly [{
readonly type: "object";
readonly properties: {
readonly type: {
readonly type: "string";
readonly const: AuthProviderType.OIDC;
};
readonly title: {
readonly type: "string";
};
readonly pkce: {
readonly type: "boolean";
readonly default: false;
};
readonly configurationUrl: {
readonly type: "string";
readonly minLength: 1;
};
readonly configuration: {
readonly type: "object";
readonly properties: {
readonly end_session_endpoint: {
readonly type: "string";
};
readonly token_endpoint: {
readonly type: "string";
};
readonly authorization_endpoint: {
readonly type: "string";
};
readonly jwks_uri: {
readonly type: "string";
};
};
readonly required: readonly ["token_endpoint", "authorization_endpoint"];
readonly additionalProperties: true;
};
readonly clientId: {
readonly type: "string";
readonly minLength: 1;
};
readonly clientSecret: {
readonly type: "string";
readonly minLength: 0;
};
readonly teamsClaimName: {
readonly type: "string";
};
readonly teamsClaimMap: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
readonly defaultTeams: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly scopes: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
readonly tokenExpirationTime: {
readonly type: "number";
};
readonly authorizationRequestCustomParams: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
readonly tokenRequestCustomParams: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
readonly audience: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
};
readonly required: readonly ["type", "clientId"];
readonly oneOf: readonly [{
readonly required: readonly ["configurationUrl"];
}, {
readonly required: readonly ["configuration"];
}];
readonly additionalProperties: false;
}, {
readonly type: "object";
readonly properties: {
readonly type: {
readonly type: "string";
readonly const: AuthProviderType.SAML2;
};
readonly title: {
readonly type: "string";
};
readonly issuerId: {
readonly type: "string";
};
readonly entityId: {
readonly type: "string";
};
readonly ssoUrl: {
readonly type: "string";
};
readonly x509PublicCert: {
readonly type: "string";
};
readonly teamsAttributeName: {
readonly type: "string";
readonly default: "https://redocly.com/sso/teams";
};
readonly teamsAttributeMap: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "string";
};
};
readonly defaultTeams: {
readonly type: "array";
readonly items: {
readonly type: "string";
};
};
};
readonly additionalProperties: false;
readonly required: readonly ["type", "issuerId", "ssoUrl", "x509PublicCert"];
}];
readonly discriminator: {
readonly propertyName: "type";
};
};
};
export declare const ssoConfigSchema: {
readonly oneOf: readonly [{
readonly type: "array";
readonly items: {
readonly type: "string";
readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
};
readonly uniqueItems: true;
}, {
readonly type: "string";
readonly enum: readonly ["REDOCLY", "CORPORATE", "GUEST"];
}];
};
export declare const redirectConfigSchema: {
readonly type: "object";
readonly properties: {
readonly to: {
readonly type: "string";
};
readonly type: {
readonly type: "number";
readonly default: 301;
};
};
readonly additionalProperties: false;
};
export declare const redirectsConfigSchema: {
readonly type: "object";
readonly additionalProperties: {
readonly type: "object";
readonly properties: {
readonly to: {
readonly type: "string";
};
readonly type: {
readonly type: "number";
readonly default: 301;
};
};
readonly additionalProperties: false;
};
readonly default: {};
};
export declare const apiConfigSchema: {
readonly type: "object";
readonly properties: {
readonly root: {
readonly type: "string";
};
readonly output: {
readonly type: "string";
readonly pattern: "(.ya?ml|.json)$";
};
readonly rbac: {
readonly type: "object";
readonly additionalProperties: true;
};
readonly openapi: {
readonly properties: {
readonly theme: {
readonly type: "object";
readonly properties: {
readonly breakpoints: {
readonly type: "object";
readonly properties: {
readonly small: {
readonly type: "string";
};
readonly medium: {
readonly type: "string";
};
readonly large: {
readonly type: "string";
};
};
};
readonly codeBlock: {
readonly type: "object";
readonly properties: {
readonly backgroundColor: {
readonly type: "string";
};
readonly borderRadius: {
readonly type: "string";
};
readonly tokens: {
readonly type: "object";
readonly properties: {
readonly fontFamily: {
readonly type: "string";
};
readonly fontSize: {
readonly type: "string";
};
readonly fontWeight: {
readonly type: "string";
};
readonly lineHeight: {
readonly type: "string";
};
readonly color: {
readonly type: "string";
};
};
};
};
};
readonly colors: {
readonly type: "object";
readonly properties: {
readonly accent: {
readonly type: "object";
readonly properties: {
readonly main: {
readonly type: "string";
};
readonly light: {
readonly type: "string";
};
readonly dark: {
readonly type: "string";
};
readonly contrastText: {
readonly type: "string";
};
};
};
readonly border: {
readonly type: "object";
readonly properties: {
readonly main: {
readonly type: "string";
};
readonly light: {
readonly type: "string";
};
readonly dark: {
readonly type: "string";
};
readonly contrastText: {
readonly type: "string";
};
};
};
readonly error: {
readonly type: "object";
readonly properties: {
readonly main: {
readonly type: "string";
};
readonly light: {
readonly type: "string";
};
readonly dark: {
readonly type: "string";
};
readonly contrastText: {
readonly type: "string";
};
};
};
readonly http: {
readonly type: "object";
readonly properties: {
readonly basic: {
readonly type: "string";
};
readonly delete: {
readonly type: "string";
};
readonly get: {
readonly type: "string";
};
readonly head: {
readonly type: "string";
};
readonly link: {
readonly type: "string";
};
readonly options: {
readonly type: "string";
};
readonly patch: {
readonly type: "string";
};
readonly post: {
readonly type: "string";
};
readonly put: {
readonly type: "string";
};
};
};
readonly primary: {
readonly type: "object";
readonly properties: {
readonly main: {
readonly type: "string";
};
readonly light: {
readonly type: "string";
};
readonly dark: {
readonly type: "string";
};
readonly contrastText: {
readonly type: "string";
};
};
};
readonly responses: {
readonly type: "object";
readonly properties: {
readonly error: {
readonly type: "object";
readonly properties: {
readonly backgroundColor: {
readonly type: "string";
};
readonly borderColor: {
readonly type: "string";
};
readonly color: {
readonly type: "string";
};
readonly tabTextColor: {
readonly type: "string";
};
};
};
readonly info: {
readonly type: "object";
readonly properties: {
readonly backgroundColor: {
readonly type: "string";
};
readonly borderColor: {
readonly type: "string";
};
readonly color: {
readonly type: "string";
};
readonly tabTextColor: {
readonly type: "string";
};
};
};
readonly redirect: {
readonly type: "object";
readonly properties: {
readonly backgroundColor: {
readonly type: "string";
};
readonly borderColor: {
readonly type: "string";
};
readonly color: {
readonly type: "string";
};
readonly tabTextColor: {
readonly type: "string";
};
};
};
readonly success: {
readonly type: "object";
readonly properties: {
readonly backgroundColor: {
readonly type: "string";
};
readonly borderColor: {
readonly type: "string";
};
readonly color: {
readonly type: "string";
};
readonly tabTextColor: {
readonly type: "string";
};
};
};
};
};
readonly secondary: {
readonly type: "object";
readonly properties: {
readonly main: {
readonly type: "string";
};
readonly light: {
readonly type: "string";
};
readonly dark: {
readonly type: "string";
};
readonly contrastText: {
readonly type: "string";
};
};
};
readonly success: {
readonly type: "object";
readonly properties: {
readonly main: {
readonly type: "string";
};
readonly light: {
readonly type: "string";
};
readonly dark: {
readonly type: "string";
};
readonly contrastText: {
readonly type: "string";
};
};
};
readonly text: {
readonly type: "object";
readonly properties: {
readonly primary: {
readonly type: "string";
};
readonly secondary: {
readonly type: "string";
};
readonly light: {
readonly type: "string";
};
};
};
readonly tonalOffset: {
readonly type: "number";
};
readonly warning: {
readonly type: "object";
readonly properties: {
readonly main: {
readonly type: "string";
};
readonly light: {
readonly type: "string";
};
readonly dark: {
readonly type: "string";
};
readonly contrastText: {
readonly type: "string";
};
};
};
};
};
readonly components: {
readonly type: "object";
readonly properties: {
readonly buttons: {
readonly type: "object";
readonly properties: {
readonly borderRadius: {
readonly type: "string";
};
readonly hoverStyle: {
readonly type: "string";
};
readonly boxShadow: {
readonly type: "string";
};
readonly hoverBoxShadow: {
readonly type: "string";
};
readonly sizes: {
readonly type: "object";
readonly properties: {
readonly small: {
readonly type: "object";
readonly properties: {
readonly fontSize: {
readonly type: "string";
};
readonly padding: {
readonly type: "string";
};
readonly minWidth: {
readonly type: "string";
};
};
};
readonly medium: {
readonly type: "object";
readonly properties: {
readonly fontSize: {
readonly type: "string";
};
readonly padding: {
readonly type: "string";
};
readonly minWidth: {
readonly type: "string";
};
};
};
readonly large: {
readonly type: "object";
readonly properties: {
readonly fontSize: {
readonly type: "string";
};
readonly padding: {
readonly type: "string";
};
readonly minWidth: {
readonly type: "string";
};
};
};
readonly xlarge: {
readonly type: "object";
readonly properties: {
readonly fontSize: {
readonly type: "string";
};
readonly padding: {
readonly type: "string";
};
readonly minWidth: {
readonly type: "string";
};
};
};
};
};
readonly fontFamily: {
readonly type: "string";
};
readonly fontSize: {
readonly type: "string";
};
readonly fontWeight: {
readonly type: "string";
};
readonly lineHeight: {
readonly type: "string";
};
};
};
readonly httpBadges: {
readonly type: "object";
readonly properties: {
readonly borderRadius: {
readonly type: "string";
};
readonly color: {
readonly type: "string";
};
readonly sizes: {
readonly type: "object";
readonly properties: {
readonly medium: {
readonly type: "object";
readonly properties: {
readonly fontFamily: {
readonly type: "string";
};
readonly fontSize: {
readonly type: "string";
};
readonly fontWeight: {
readonly type: "string";
};
readonly lineHeight: {
readonly type: "string";
};
};
};
readonly small: {
readonly type: "object";
readonly properties: {
readonly fontFamily: {
readonly type: "string";
};
readonly fontSize: {
readonly type: "string";
};
readonly fontWeight: {
readonly type: "string";
};
readonly lineHeight: {
readonly type: "string";
};
};
};
};
};
readonly fontFamily: {
readonly type: "string";
};
readonly fontSize: {
readonly type: "string";
};
readonly fontWeight: {
readonly type: "string";
};
readonly lineHeight: {
readonly type: "string";
};
};
};
readonly layoutControls: {
readonly type: "object";
readonly properties: {
readonly top: {
readonly type: "string";
};
readonly width: {
readonly type: "string";
};
readonly height: {
readonly type: "string";
};
};
};
readonly panels: {
readonly type: "object";
readonly properties: {
readonly borderRadius: {
readonly type: "string";
};
readonly backgroundColor: {
readonly type: "string";
};
};
};
readonly tryItButton: {
readonly type: "object";
readonly properties: {
readonly fullWidth: {
readonly type: "boolean";
};
};
};
readonly tryItSendButton: {
readonly type: "object";
readonly properties: {
readonly fullWidth: {
readonly type: "boolean";
};
};
};
};
};
readonly layout: {
readonly type: "object";
readonly properties: {
readonly showDarkRightPanel: {
readonly type: "boolean";
};
readonly stacked: {
readonly type: "object";
readonly properties: {
readonly maxWidth: {
readonly type: "object";
readonly properties: {
readonly small: {
readonly type: "string";
};
readonly medium: {
readonly type: "string";
};
readonly large: {
readonly type: "string";
};
};
};
};
};
readonly 'three-panel': {
readonly type: "object";
readonly properties: {
readonly maxWidth: {
readonly type: "object";
readonly properties: {
readonly small: {
readonly type: "string";
};
readonly medium: {
readonly type: "string";
};
readonly large: {
readonly type: "string";
};
};
};
readonly middlePanelMaxWidth: {
readonly type: "object";
readonly properties: {
readonly small: {
readonly type: "string";
};
readonly medium: {
readonly type: "string";
};
readonly large: {
readonly type: "string";
};
};
};
};
};
};
};
readonly logo: {
readonly type: "object";
readonly properties: {
readonly gutter: {
readonly type: "string";
};
readonly maxHeight: {
readonly type: "string";
};
readonly maxWidth: {
readonly type: "string";
};
};
};
readonly fab: {
readonly type: "object";
readonly properties: {
readonly backgroundColor: {
readonly type: "string";