Skip to content
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

Jump to bottom

feat: Add missing tooltips to all onboarding options #2194

Merged
merged 10 commits into from
Mar 29, 2022
Merged

feat: Add missing tooltips to all onboarding options #2194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
51576f9
Add missing tooltips to all onboarding options
CaioCamatta Mar 4, 2022
97f8f7e
Address PR comments, change tooltip texts
CaioCamatta Mar 17, 2022
3b9de7e
Improve tooltips
CaioCamatta Mar 24, 2022
e9a4d43
Merge branch 'v2.x.x' into apiml/GH1879_wizard_enhancement_improve_su…
taban03 Mar 25, 2022
04e9db1
Fix formatting
CaioCamatta Mar 26, 2022
c0fcf8a
Merge branch 'apiml/GH1879_wizard_enhancement_improve_suggestions_2.x…
CaioCamatta Mar 26, 2022
61ce7e1
Fix eslint complain
taban03 Mar 29, 2022
4843a65
Merge branch 'v2.x.x' into apiml/GH1879_wizard_enhancement_improve_su…
taban03 Mar 29, 2022
ed1bbda
Small fix in the values
taban03 Mar 29, 2022
501e5da
Small fix in the values
taban03 Mar 29, 2022
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
34 changes: 32 additions & 2 deletions api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ export const baseCategories = [
question: 'A unique identifier for the API (service ID):',
maxLength: 40,
lowercase: true,
tooltip: 'Example: sampleservice',
},
title: {
value: '',
question: 'The name of the service (human readable):',
tooltip: 'Example: Hello API ML',
},
},
},
Expand All @@ -32,6 +34,7 @@ export const baseCategories = [
description: {
value: '',
question: 'A concise description of the service:',
tooltip: 'Example: Sample API ML REST Service.',
},
},
},
Expand All @@ -42,6 +45,7 @@ export const baseCategories = [
value: '',
question: 'The base URL of the service (the consistent part of the web address):',
validUrl: true,
tooltip: 'https://${samplehost}:${sampleport}/${sampleservice}',
},
},
},
Expand All @@ -60,18 +64,23 @@ export const baseCategories = [
scheme: {
value: 'https',
question: 'Service scheme:',
tooltip: 'https',
},
hostname: {
value: '',
question: 'Service hostname:',
tooltip: 'hostname can be externalized by specifying -Dapiml.service.hostname command line parameter',
},
port: {
value: '',
question: 'Service port:',
tooltip: 'port can be externalized by specifying -Dapiml.service.port command line parameter',
},
contextPath: {
value: '',
question: 'Context path:',
tooltip:
"By default the contextPath is set to be the same as apiml.service.serviceId, but doesn't have to be the same",
},
},
},
Expand All @@ -83,6 +92,7 @@ export const baseCategories = [
question: 'The service IP address:',
optional: true,
regexRestriction: [wizRegex.ipAddress],
tooltip: 'Example: https://localhost:3000/',
},
},
},
Expand All @@ -94,18 +104,22 @@ export const baseCategories = [
question: 'The relative path to the home page of the service:',
optional: true,
regexRestriction: [wizRegex.validRelativeUrl],
tooltip:
'Normally used for informational purposes for other services to use it as a landing page. Example: /home',
},
statusPageRelativeUrl: {
value: '',
question: 'The relative path to the status page of the service:',
optional: true,
regexRestriction: [wizRegex.validRelativeUrl],
tooltip: 'Example: /application/info',
},
healthCheckRelativeUrl: {
value: '',
question: 'The relative path to the health check endpoint of the service:',
optional: true,
regexRestriction: [wizRegex.validRelativeUrl],
tooltip: 'Example: /application/health',
},
},
},
Expand All @@ -116,6 +130,7 @@ export const baseCategories = [
value: '',
question: 'Discovery Service URL:',
validUrl: true,
tooltip: 'Example: https://localhost:10011/eureka/',
},
},
multiple: false,
Expand All @@ -133,6 +148,7 @@ export const baseCategories = [
serviceUrl: {
value: '',
question: 'Service API common context path:',
tooltip: 'Example: /sampleservice/api/v1',
},
},
help: 'For service: <service>/allOfMyEndpointsAreHere/** exposed on Gateway under <gateway>/<serviceid>/api/v1/**\nFill in:\ngatewayUrl: /api/v1\nserviceUrl: /allOfMyEndpointsAreHere',
Expand All @@ -151,6 +167,7 @@ export const baseCategories = [
value: '',
question: 'A service APPLID (valid only for the httpBasicPassTicket authentication scheme ):',
dependencies: { scheme: 'httpBasicPassTicket' },
tooltip: 'Example: ZOWEAPPL',
},
headers: {
value: 'X-Certificate-Public',
Expand All @@ -171,11 +188,12 @@ export const baseCategories = [
apiId: {
value: '',
question: 'A unique identifier to the API in the API ML:',
tooltip: 'Example: zowe.apiml.sampleservice',
},
version: {
value: '',
question: 'API version:',
tooltip: 'API version',
tooltip: 'Example: 1.0.0',
regexRestriction: [wizRegex.version],
},
gatewayUrl: {
Expand All @@ -188,11 +206,14 @@ export const baseCategories = [
value: '',
question: 'The Http or Https address where the Swagger JSON document is available:',
optional: true,
tooltip:
'Example: http://${sampleServiceSwaggerHost}:${sampleServiceSwaggerPort}/sampleservice/api-doc',
},
documentationUrl: {
value: '',
question: 'Link to the external documentation:',
optional: true,
tooltip: 'Example: https://www.zowe.org',
},
},
},
Expand All @@ -208,19 +229,22 @@ export const baseCategories = [
id: {
value: '',
question: 'The unique identifier for the product family of API services:',
tooltip: 'reverse domain name notation, e.g. org.zowe.apiml',
tooltip: 'reverse domain name notation. Example: org.zowe.apiml',
},
title: {
value: '',
question: 'The title of the product family of the API service:',
tooltip: 'Example: Hello API ML',
},
description: {
value: '',
question: 'A description of the API service product family:',
tooltip: 'Example: Sample application to demonstrate exposing a REST API in the ZOWE API ML',
},
version: {
value: '',
question: 'The semantic version of this API Catalog tile (increase when adding changes):',
tooltip: 'Example: 1.0.0',
},
},
interference: 'catalog',
Expand All @@ -239,20 +263,24 @@ export const baseCategories = [
keyAlias: {
value: '',
question: 'The alias used to address the private key in the keystore',
tooltip: 'Example: localhost',
},
keyPassword: {
value: '',
question: 'The password associated with the private key:',
type: 'password',
tooltip: 'password',
},
keyStore: {
value: '',
question: 'The keystore file used to store the private key (keyring: set to SAF keyring location):',
tooltip: 'Example: keystore/localhost.keystore.p12',
},
keyStorePassword: {
value: '',
question: 'The password used to unlock the keystore:',
type: 'password',
tooltip: 'Your keystore password',
},
keyStoreType: {
value: 'PKCS12',
Expand All @@ -262,11 +290,13 @@ export const baseCategories = [
trustStore: {
value: '',
question: 'The truststore file used to keep other parties public keys and certificates:',
tooltip: 'Example: keystore/localhost.truststore.p12',
},
trustStorePassword: {
value: '',
question: 'The password used to unlock the truststore:',
type: 'password',
tooltip: 'Your truststore password.',
},
trustStoreType: {
value: 'PKCS12',
Expand Down
27 changes: 26 additions & 1 deletion api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,17 @@ export const micronautSpecificCategories = [
apiId: {
value: '',
question: 'A unique identifier to the API in the API ML:',
tooltip: 'Example: zowe.apiml.sampleservice',
},
version: {
value: '',
question: 'API version:',
tooltip: 'Example: 1.0.0',
},
gatewayUrl: {
value: '',
question: 'The base path at the API Gateway where the API is available:',
tooltip: 'Format: /api/vX, Example: /api/v1',
},
},
},
Expand All @@ -47,49 +50,59 @@ export const micronautSpecificCategories = [
value: '',
question: 'The alias used to address the private key in the keystore:',
dependencies: { enabled: true },
tooltip: 'Your key alias',
},
keyPassword: {
value: '',
question: 'The password associated with the private key:',
dependencies: { enabled: true },
type: 'password',
tooltip: 'Your key password',
},
keyStore: {
value: '',
question: 'The keystore file used to store the private key (keyring: set to SAF keyring location):',
dependencies: { enabled: true },
tooltip: 'Your keystore',
},
keyStorePassword: {
value: '',
question: 'The password used to unlock the keystore:',
dependencies: { enabled: true },
type: 'password',
tooltip: 'Your keystore password',
},
keyStoreType: {
value: '',
question: 'Type of the keystore:',
dependencies: { enabled: true },
tooltip: 'Your keystore type: example: PKCS12',
},
trustStore: {
value: '',
question: 'The truststore file used to keep other parties public keys and certificates:',
dependencies: { enabled: true },
tooltip: 'Example: keystore/localhost.truststore.p12',
},
trustStorePassword: {
value: '',
question: 'The password used to unlock the truststore:',
dependencies: { enabled: true },
type: 'password',
tooltip: 'Your truststore password.',
},
trustStoreType: {
value: 'PKCS12',
question: 'Truststore type:',
dependencies: { enabled: true },
tooltip: 'Your truststore type. Example: PKCS12',
},
ciphers: {
value: '',
question: 'SSL cipher suites:',
dependencies: { enabled: true },
tooltip:
'Ciphers that are used by the HTTPS servers in API ML services and can be externalized by specifying -Dapiml.security.ciphers command line parameter.',
},
},
},
Expand All @@ -99,6 +112,7 @@ export const micronautSpecificCategories = [
name: {
value: '',
question: 'Application name:',
tooltip: 'Example Hello API ML',
},
},
},
Expand All @@ -108,6 +122,7 @@ export const micronautSpecificCategories = [
port: {
value: '',
question: 'The port to be used:',
tooltip: 'Port on which the service listens',
},
'context-path': {
value: '',
Expand All @@ -130,14 +145,17 @@ export const micronautSpecificCategories = [
password: {
value: '',
question: 'The password associated with the private key:',
tooltip: 'password',
},
type: {
value: '',
question: 'The type of key store:',
question: 'Type of the keystore:',
tooltip: 'Your keystore type: example: PKCS12',
},
path: {
value: '',
question: 'The keystore file used to store the private key:',
tooltip: 'Example: ssl/localhost.keystore.key',
},
},
},
Expand All @@ -147,10 +165,12 @@ export const micronautSpecificCategories = [
alias: {
value: '',
question: 'The alias used to address the private key in the keystore:',
tooltip: 'Your key alias',
},
password: {
value: '',
question: 'The password associated with the private key:',
tooltip: 'password',
},
},
},
Expand All @@ -161,10 +181,12 @@ export const micronautSpecificCategories = [
value: '',
question: 'The password used to unlock the truststore:',
type: 'password',
tooltip: 'Your truststore password.',
},
path: {
value: '',
question: 'The truststore file used to keep other parties public keys and certificates:',
tooltip: 'Example: keystore/localhost.truststore.p12',
},
type: {
value: '',
Expand Down Expand Up @@ -195,6 +217,7 @@ export const micronautSpecificCategories = [
defaultZone: {
value: '',
question: 'Eureka default zone:',
tooltip: 'Example: https://localhost:10011/eureka/',
},
},
},
Expand All @@ -204,6 +227,7 @@ export const micronautSpecificCategories = [
'base-path': {
value: '',
question: 'Endpoint base-path:',
tooltip: 'Example: /application',
},
},
},
Expand All @@ -213,6 +237,7 @@ export const micronautSpecificCategories = [
include: {
value: '',
question: 'Endpoint base-path:',
tooltip: 'Example: health,info',
},
},
},
Expand Down
Loading