From 51576f9670ba63f52d38b849fa778248274ec613 Mon Sep 17 00:00:00 2001 From: Caio Camatta Date: Fri, 4 Mar 2022 09:05:11 -0500 Subject: [PATCH 1/7] Add missing tooltips to all onboarding options --- .../Wizard/configs/wizard_base_categories.jsx | 25 ++++++++++++++ .../configs/wizard_micronaut_categories.jsx | 17 ++++++++++ .../Wizard/configs/wizard_node_categories.jsx | 34 +++++++++++++++++++ .../configs/wizard_static_categories.jsx | 6 ++++ 4 files changed, 82 insertions(+) diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx index 49db69a9fb..724c150f79 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx @@ -19,10 +19,12 @@ export const baseCategories = [ question: 'A unique identifier for the API (service ID):', maxLength: 40, lowercase: true, + tooltip: 'e.g. sampleservice', }, title: { value: '', question: 'The name of the service (human readable):', + tooltip: 'e.g. Hello API ML', }, }, }, @@ -32,6 +34,7 @@ export const baseCategories = [ description: { value: '', question: 'A concise description of the service:', + tooltip: 'e.g. Sample API ML REST Service.', }, }, }, @@ -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}', }, }, }, @@ -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", }, }, }, @@ -83,6 +92,7 @@ export const baseCategories = [ question: 'The service IP address:', optional: true, regexRestriction: [wizRegex.ipAddress], + tooltip: 'e.g. https://localhost:3000/', }, }, }, @@ -94,18 +104,21 @@ export const baseCategories = [ question: 'The relative path to the home page of the service:', optional: true, regexRestriction: [wizRegex.validRelativeUrl], + tooltip: 'e.g. /application/home', }, statusPageRelativeUrl: { value: '', question: 'The relative path to the status page of the service:', optional: true, regexRestriction: [wizRegex.validRelativeUrl], + tooltip: 'e.g. /application/info', }, healthCheckRelativeUrl: { value: '', question: 'The relative path to the health check endpoint of the service:', optional: true, regexRestriction: [wizRegex.validRelativeUrl], + tooltip: 'e.g. /application/health', }, }, }, @@ -116,6 +129,7 @@ export const baseCategories = [ value: '', question: 'Discovery Service URL:', validUrl: true, + tooltip: 'e.g. https://${discoveryServiceHost1}: ${discoveryServicePort1}/eureka', }, }, multiple: false, @@ -133,6 +147,7 @@ export const baseCategories = [ serviceUrl: { value: '', question: 'Service API common context path:', + tooltip: 'e.g. /sampleservice/api/v1', }, }, help: 'For service: /allOfMyEndpointsAreHere/** exposed on Gateway under //api/v1/**\nFill in:\ngatewayUrl: /api/v1\nserviceUrl: /allOfMyEndpointsAreHere', @@ -151,6 +166,7 @@ export const baseCategories = [ value: '', question: 'A service APPLID (valid only for the httpBasicPassTicket authentication scheme ):', dependencies: { scheme: 'httpBasicPassTicket' }, + tooltip: 'e.g. ZOWEAPPL', }, headers: { value: 'X-Certificate-Public', @@ -171,6 +187,7 @@ export const baseCategories = [ apiId: { value: '', question: 'A unique identifier to the API in the API ML:', + tooltip: 'e.g. zowe.apiml.sampleservice', }, version: { value: '', @@ -188,11 +205,13 @@ export const baseCategories = [ value: '', question: 'The Http or Https address where the Swagger JSON document is available:', optional: true, + tooltip: 'e.g. http://${sampleServiceSwaggerHost}: ${sampleServiceSwaggerPort}/ sampleservice/api-doc', }, documentationUrl: { value: '', question: 'Link to the external documentation:', optional: true, + tooltip: 'http://', }, }, }, @@ -213,14 +232,17 @@ export const baseCategories = [ title: { value: '', question: 'The title of the product family of the API service:', + tooltip: 'e.g. Hello API ML', }, description: { value: '', question: 'A description of the API service product family:', + tooltip: 'e.g. 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: 'e.g. 1.0.0', }, }, interference: 'catalog', @@ -239,6 +261,7 @@ export const baseCategories = [ keyAlias: { value: '', question: 'The alias used to address the private key in the keystore', + tooltip: 'e.g. localhost', }, keyPassword: { value: '', @@ -248,6 +271,7 @@ export const baseCategories = [ keyStore: { value: '', question: 'The keystore file used to store the private key (keyring: set to SAF keyring location):', + tooltip: 'e.g. keystore/localhost.keystore.p12', }, keyStorePassword: { value: '', @@ -262,6 +286,7 @@ export const baseCategories = [ trustStore: { value: '', question: 'The truststore file used to keep other parties public keys and certificates:', + tooltip: 'e.g. keystore/localhost.truststore.p12', }, trustStorePassword: { value: '', diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx index 95b918ae6e..bc58b146bc 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx @@ -15,14 +15,17 @@ export const micronautSpecificCategories = [ apiId: { value: '', question: 'A unique identifier to the API in the API ML:', + tooltip: 'e.g. sampleservice', }, version: { value: '', question: 'API version:', + tooltip: 'e.g. 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', }, }, }, @@ -47,49 +50,58 @@ export const micronautSpecificCategories = [ value: '', question: 'The alias used to address the private key in the keystore:', dependencies: { enabled: true }, + tooltip: '${fill.your.keyAlias}', }, keyPassword: { value: '', question: 'The password associated with the private key:', dependencies: { enabled: true }, type: 'password', + tooltip: '${fill.your.keyPassword}', }, keyStore: { value: '', question: 'The keystore file used to store the private key (keyring: set to SAF keyring location):', dependencies: { enabled: true }, + tooltip: '${fill.your.keyStore}', }, keyStorePassword: { value: '', question: 'The password used to unlock the keystore:', dependencies: { enabled: true }, type: 'password', + tooltip: '${fill.your.keyStorePassword}', }, keyStoreType: { value: '', question: 'Type of the keystore:', dependencies: { enabled: true }, + tooltip: '${fill.your.keystoretype}, e.g. PKCS12', }, trustStore: { value: '', question: 'The truststore file used to keep other parties public keys and certificates:', dependencies: { enabled: true }, + tooltip: '${fill.your.trustStore}', }, trustStorePassword: { value: '', question: 'The password used to unlock the truststore:', dependencies: { enabled: true }, type: 'password', + tooltip: '${fill.your.trustStorePassword}', }, trustStoreType: { value: 'PKCS12', question: 'Truststore type:', dependencies: { enabled: true }, + tooltip: 'Fill your trustStoreType', }, ciphers: { value: '', question: 'SSL cipher suites:', dependencies: { enabled: true }, + tooltip: '${fill.your.ciphers}', }, }, }, @@ -99,6 +111,7 @@ export const micronautSpecificCategories = [ name: { value: '', question: 'Application name:', + tooltip: 'e.g. Hello API ML', }, }, }, @@ -108,6 +121,7 @@ export const micronautSpecificCategories = [ port: { value: '', question: 'The port to be used:', + tooltip: 'Port on which the service listens', }, 'context-path': { value: '', @@ -195,6 +209,7 @@ export const micronautSpecificCategories = [ defaultZone: { value: '', question: 'Eureka default zone:', + tooltip: 'placeholder', }, }, }, @@ -204,6 +219,7 @@ export const micronautSpecificCategories = [ 'base-path': { value: '', question: 'Endpoint base-path:', + tooltip: 'placeholder', }, }, }, @@ -213,6 +229,7 @@ export const micronautSpecificCategories = [ include: { value: '', question: 'Endpoint base-path:', + tooltip: 'placeholder', }, }, }, diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_node_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_node_categories.jsx index c65dc8eb98..cf15300bd0 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_node_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_node_categories.jsx @@ -15,19 +15,23 @@ export const nodeSpecificCategories = [ certificate: { value: '', question: 'Certificate:', + tooltip: 'e.g. ssl/localhost.keystore.cer', }, keyStore: { value: '', question: 'The keystore file used to store the private key (keyring: set to SAF keyring location):', + tooltip: 'e.g. ssl/localhost.keystore.key', }, caFile: { value: '', question: 'Certificate Authority file:', + tooltip: 'e.g. ssl/localhost.pem', }, keyPassword: { value: '', question: 'The password associated with the private key:', type: 'password', + tooltip: 'password', }, }, }, @@ -41,33 +45,40 @@ export const nodeSpecificCategories = [ host: { value: '', question: 'The host to be used:', + tooltip: 'e.g. localhost', }, ipAddress: { value: '', question: 'The IP address to be used:', + tooltip: 'e.g. 127.0.0.1', }, port: { value: '', question: 'The port to be used:', + tooltip: 'e.g. 10011', }, servicePath: { value: '', question: 'The service path:', + tooltip: 'e.g. /eureka/apps/', }, maxRetries: { value: '', question: 'The maximum number of retries:', hide: true, + tooltip: 'e.g. 30', }, requestRetryDelay: { value: '', question: 'The request retry delay:', hide: true, + tooltip: 'e.g. 1000', }, registryFetchInterval: { value: '', question: 'The interval for registry interval:', hide: true, + tooltip: 'e.g. 5', }, }, }, @@ -77,30 +88,37 @@ export const nodeSpecificCategories = [ app: { value: '', question: 'App ID:', + tooltip: 'e.g. hwexpress', }, vipAddress: { value: '', question: 'Virtual IP address:', + tooltip: 'e.g. hwexpress', }, instanceId: { value: '', question: 'Instance ID:', + tooltip: 'e.g. localhost:hwexpress:10020', }, homePageUrl: { value: '', question: 'The URL of the home page:', + tooltip: 'e.g. https://localhost:10020/', }, hostname: { value: '', question: 'Host name:', + tooltip: 'e.g. localhost', }, ipAddr: { value: '', question: 'IP address:', + tooltip: 'e.g. 127.0.0.1', }, secureVipAddress: { value: '', question: 'Secure virtual IP address:', + tooltip: 'e.g. hwexpress', }, }, }, @@ -110,6 +128,7 @@ export const nodeSpecificCategories = [ $: { value: '', question: 'Port:', + tooltip: 'e.g. 10020', }, '@enabled': { value: false, @@ -123,6 +142,7 @@ export const nodeSpecificCategories = [ $: { value: '', question: 'Security port:', + tooltip: 'e.g. 10020', }, '@enabled': { value: true, @@ -136,10 +156,12 @@ export const nodeSpecificCategories = [ '@class': { value: '', question: 'Class:', + tooltip: 'e.g. com.netflix.appinfo. InstanceInfo$DefaultDataCenterInfo', }, name: { value: '', question: 'Name:', + tooltip: 'e.g. MyOwn', }, }, }, @@ -149,46 +171,58 @@ export const nodeSpecificCategories = [ 'apiml.catalog.tile.id': { value: '', question: 'Tile ID for the API ML catalog:', + tooltip: 'e.g. samplenodeservice', }, 'apiml.catalog.tile.title': { value: '', question: 'Tile title for the API ML catalog:', + tooltip: 'e.g. Zowe Sample Node Service', }, 'apiml.catalog.tile.description': { value: '', question: 'Tile description for the API ML catalog:', + tooltip: 'e.g. NodeJS Sample service running', }, 'apiml.catalog.tile.version': { value: '', question: 'Tile version for the API ML catalog:', + tooltip: 'e.g. 1.0.0', }, 'apiml.routes.api_v1.gatewayUrl': { value: '', question: 'API gateway URL:', + tooltip: 'e.g. api/v1', }, 'apiml.routes.api_v1.serviceUrl': { value: '', question: 'API service URL:', + tooltip: 'e.g. /api/v1', }, 'apiml.apiInfo.0.apiId': { value: '', question: 'A unique identifier to the API in the API ML:', + tooltip: 'e.g. zowe.apiml.hwexpress', }, 'apiml.apiInfo.0.gatewayUrl': { value: '', question: 'The base path at the API Gateway where the API is available:', + tooltip: 'e.g. api/v1', }, 'apiml.apiInfo.0.swaggerUrl': { value: '', question: 'The base path at the API Gateway where the API is available:', + tooltip: 'e.g. https://localhost:10020/ swagger.json', }, 'apiml.service.title': { value: '', question: 'Service title:', + tooltip: 'e.g. Zowe Sample Node Service', }, 'apiml.service.description': { value: '', question: 'Service description:', + tooltip: + 'e.g. The Proxy Server is an HTTP HTTPS, and Websocket server built upon NodeJS and ExpressJS.', }, }, }, diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_static_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_static_categories.jsx index adab996705..20455b70f3 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_static_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_static_categories.jsx @@ -17,6 +17,7 @@ export const staticSpecificCategories = [ instanceBaseUrls: { value: '', question: 'The base URL of the instance (the consistent part of the web address):', + tooltip: 'e.g. http://localhost:8080', }, }, multiple: false, @@ -34,6 +35,7 @@ export const staticSpecificCategories = [ serviceRelativeUrl: { value: '', question: 'Service API common context path:', + tooltip: 'e.g. /sampleservice/api/v1', }, }, help: 'For service: /allOfMyEndpointsAreHere/** exposed on Gateway under //api/v1/**\nFill in:\ngatewayUrl: /api/v1\nserviceUrl: /allOfMyEndpointsAreHere', @@ -53,6 +55,7 @@ export const staticSpecificCategories = [ question: 'The id of the catalog tile:', regexRestriction: [wizRegex.noWhiteSpaces], dependencies: { type: 'Custom' }, + tooltip: 'e.g. static', }, }, interference: 'staticCatalog', @@ -63,10 +66,13 @@ export const staticSpecificCategories = [ title: { value: '', question: 'The title of the API services product family:', + tooltip: 'e.g. Static API services', }, description: { value: '', question: 'The detailed description of the API Catalog UI dashboard tile:', + tooltip: + 'e.g. Services which demonstrate how to make an API service discoverable in the APIML ecosystem using YAML definitions', }, }, indentationDependency: 'catalogUiTileId', From 97f8f7e54acdea2ce2a911a2b6efe30fc3fe2020 Mon Sep 17 00:00:00 2001 From: Caio Camatta Date: Thu, 17 Mar 2022 17:18:30 -0400 Subject: [PATCH 2/7] Address PR comments, change tooltip texts --- .../Wizard/configs/wizard_base_categories.jsx | 42 ++++++------ .../configs/wizard_micronaut_categories.jsx | 24 +++---- .../Wizard/configs/wizard_node_categories.jsx | 64 +++++++++---------- .../configs/wizard_static_categories.jsx | 10 +-- 4 files changed, 70 insertions(+), 70 deletions(-) diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx index 724c150f79..a94c719645 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx @@ -19,12 +19,12 @@ export const baseCategories = [ question: 'A unique identifier for the API (service ID):', maxLength: 40, lowercase: true, - tooltip: 'e.g. sampleservice', + tooltip: 'Example: sampleservice', }, title: { value: '', question: 'The name of the service (human readable):', - tooltip: 'e.g. Hello API ML', + tooltip: 'Example: Hello API ML', }, }, }, @@ -34,7 +34,7 @@ export const baseCategories = [ description: { value: '', question: 'A concise description of the service:', - tooltip: 'e.g. Sample API ML REST Service.', + tooltip: 'Example: Sample API ML REST Service.', }, }, }, @@ -45,7 +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}', + tooltip: 'https://${samplehost}:${sampleport}/${sampleservice}', }, }, }, @@ -92,7 +92,7 @@ export const baseCategories = [ question: 'The service IP address:', optional: true, regexRestriction: [wizRegex.ipAddress], - tooltip: 'e.g. https://localhost:3000/', + tooltip: 'Example: https://localhost:3000/', }, }, }, @@ -104,21 +104,21 @@ export const baseCategories = [ question: 'The relative path to the home page of the service:', optional: true, regexRestriction: [wizRegex.validRelativeUrl], - tooltip: 'e.g. /application/home', + 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: 'e.g. /application/info', + tooltip: 'Example: /application/info', }, healthCheckRelativeUrl: { value: '', question: 'The relative path to the health check endpoint of the service:', optional: true, regexRestriction: [wizRegex.validRelativeUrl], - tooltip: 'e.g. /application/health', + tooltip: 'Example: /application/health', }, }, }, @@ -129,7 +129,7 @@ export const baseCategories = [ value: '', question: 'Discovery Service URL:', validUrl: true, - tooltip: 'e.g. https://${discoveryServiceHost1}: ${discoveryServicePort1}/eureka', + tooltip: 'Example: https://localhost:10011/eureka/', }, }, multiple: false, @@ -147,7 +147,7 @@ export const baseCategories = [ serviceUrl: { value: '', question: 'Service API common context path:', - tooltip: 'e.g. /sampleservice/api/v1', + tooltip: 'Example: /sampleservice/api/v1', }, }, help: 'For service: /allOfMyEndpointsAreHere/** exposed on Gateway under //api/v1/**\nFill in:\ngatewayUrl: /api/v1\nserviceUrl: /allOfMyEndpointsAreHere', @@ -166,7 +166,7 @@ export const baseCategories = [ value: '', question: 'A service APPLID (valid only for the httpBasicPassTicket authentication scheme ):', dependencies: { scheme: 'httpBasicPassTicket' }, - tooltip: 'e.g. ZOWEAPPL', + tooltip: 'Example: ZOWEAPPL', }, headers: { value: 'X-Certificate-Public', @@ -187,7 +187,7 @@ export const baseCategories = [ apiId: { value: '', question: 'A unique identifier to the API in the API ML:', - tooltip: 'e.g. zowe.apiml.sampleservice', + tooltip: 'Example: zowe.apiml.sampleservice', }, version: { value: '', @@ -205,13 +205,13 @@ export const baseCategories = [ value: '', question: 'The Http or Https address where the Swagger JSON document is available:', optional: true, - tooltip: 'e.g. http://${sampleServiceSwaggerHost}: ${sampleServiceSwaggerPort}/ sampleservice/api-doc', + tooltip: 'Example: http://${sampleServiceSwaggerHost}:${sampleServiceSwaggerPort}/sampleservice/api-doc', }, documentationUrl: { value: '', question: 'Link to the external documentation:', optional: true, - tooltip: 'http://', + tooltip: 'Example: https://www.zowe.org', }, }, }, @@ -227,22 +227,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: 'e.g. Hello API ML', + tooltip: 'Example: Hello API ML', }, description: { value: '', question: 'A description of the API service product family:', - tooltip: 'e.g. Sample application to demonstrate exposing a REST API in the ZOWE API ML', + 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: 'e.g. 1.0.0', + tooltip: 'Example: 1.0.0', }, }, interference: 'catalog', @@ -261,7 +261,7 @@ export const baseCategories = [ keyAlias: { value: '', question: 'The alias used to address the private key in the keystore', - tooltip: 'e.g. localhost', + tooltip: 'Example: localhost', }, keyPassword: { value: '', @@ -271,7 +271,7 @@ export const baseCategories = [ keyStore: { value: '', question: 'The keystore file used to store the private key (keyring: set to SAF keyring location):', - tooltip: 'e.g. keystore/localhost.keystore.p12', + tooltip: 'Example: keystore/localhost.keystore.p12', }, keyStorePassword: { value: '', @@ -286,7 +286,7 @@ export const baseCategories = [ trustStore: { value: '', question: 'The truststore file used to keep other parties public keys and certificates:', - tooltip: 'e.g. keystore/localhost.truststore.p12', + tooltip: 'Example: keystore/localhost.truststore.p12', }, trustStorePassword: { value: '', diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx index bc58b146bc..8c858a7002 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx @@ -15,12 +15,12 @@ export const micronautSpecificCategories = [ apiId: { value: '', question: 'A unique identifier to the API in the API ML:', - tooltip: 'e.g. sampleservice', + tooltip: 'Example: sampleservice', }, version: { value: '', question: 'API version:', - tooltip: 'e.g. 1.0.0', + tooltip: 'Example: 1.0.0', }, gatewayUrl: { value: '', @@ -50,58 +50,58 @@ export const micronautSpecificCategories = [ value: '', question: 'The alias used to address the private key in the keystore:', dependencies: { enabled: true }, - tooltip: '${fill.your.keyAlias}', + tooltip: 'Your key alias', }, keyPassword: { value: '', question: 'The password associated with the private key:', dependencies: { enabled: true }, type: 'password', - tooltip: '${fill.your.keyPassword}', + 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: '${fill.your.keyStore}', + tooltip: 'Your keystore', }, keyStorePassword: { value: '', question: 'The password used to unlock the keystore:', dependencies: { enabled: true }, type: 'password', - tooltip: '${fill.your.keyStorePassword}', + tooltip: 'Your keystore password', }, keyStoreType: { value: '', question: 'Type of the keystore:', dependencies: { enabled: true }, - tooltip: '${fill.your.keystoretype}, e.g. PKCS12', + 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: '${fill.your.trustStore}', + tooltip: 'Your truststore.', }, trustStorePassword: { value: '', question: 'The password used to unlock the truststore:', dependencies: { enabled: true }, type: 'password', - tooltip: '${fill.your.trustStorePassword}', + tooltip: 'Your truststore password.', }, trustStoreType: { value: 'PKCS12', question: 'Truststore type:', dependencies: { enabled: true }, - tooltip: 'Fill your trustStoreType', + tooltip: 'Your truststore type. Example: PKCS12', }, ciphers: { value: '', question: 'SSL cipher suites:', dependencies: { enabled: true }, - tooltip: '${fill.your.ciphers}', + 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.', }, }, }, @@ -111,7 +111,7 @@ export const micronautSpecificCategories = [ name: { value: '', question: 'Application name:', - tooltip: 'e.g. Hello API ML', + tooltip: 'Example Hello API ML', }, }, }, diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_node_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_node_categories.jsx index cf15300bd0..54adc0bd55 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_node_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_node_categories.jsx @@ -15,17 +15,17 @@ export const nodeSpecificCategories = [ certificate: { value: '', question: 'Certificate:', - tooltip: 'e.g. ssl/localhost.keystore.cer', + tooltip: 'Example: ssl/localhost.keystore.cer', }, keyStore: { value: '', question: 'The keystore file used to store the private key (keyring: set to SAF keyring location):', - tooltip: 'e.g. ssl/localhost.keystore.key', + tooltip: 'Example: ssl/localhost.keystore.key', }, caFile: { value: '', question: 'Certificate Authority file:', - tooltip: 'e.g. ssl/localhost.pem', + tooltip: 'Example: ssl/localhost.pem', }, keyPassword: { value: '', @@ -45,40 +45,40 @@ export const nodeSpecificCategories = [ host: { value: '', question: 'The host to be used:', - tooltip: 'e.g. localhost', + tooltip: 'Example: localhost', }, ipAddress: { value: '', question: 'The IP address to be used:', - tooltip: 'e.g. 127.0.0.1', + tooltip: 'Example: 127.0.0.1', }, port: { value: '', question: 'The port to be used:', - tooltip: 'e.g. 10011', + tooltip: 'Example: 10011', }, servicePath: { value: '', question: 'The service path:', - tooltip: 'e.g. /eureka/apps/', + tooltip: 'Example: /eureka/apps/', }, maxRetries: { value: '', question: 'The maximum number of retries:', hide: true, - tooltip: 'e.g. 30', + tooltip: 'Number of retries before failing. Example: 30', }, requestRetryDelay: { value: '', question: 'The request retry delay:', hide: true, - tooltip: 'e.g. 1000', + tooltip: 'Milliseconds to wait between retries. Example: 1000', }, registryFetchInterval: { value: '', question: 'The interval for registry interval:', hide: true, - tooltip: 'e.g. 5', + tooltip: 'How often does Eureka client pull the service list from Eureka server. The default is 30 seconds. Example: 5', }, }, }, @@ -88,37 +88,37 @@ export const nodeSpecificCategories = [ app: { value: '', question: 'App ID:', - tooltip: 'e.g. hwexpress', + tooltip: 'Example: hwexpress', }, vipAddress: { value: '', question: 'Virtual IP address:', - tooltip: 'e.g. hwexpress', + tooltip: 'Example: hwexpress', }, instanceId: { value: '', question: 'Instance ID:', - tooltip: 'e.g. localhost:hwexpress:10020', + tooltip: 'Example: localhost:hwexpress:10020', }, homePageUrl: { value: '', question: 'The URL of the home page:', - tooltip: 'e.g. https://localhost:10020/', + tooltip: 'Example: https://localhost:10020/', }, hostname: { value: '', question: 'Host name:', - tooltip: 'e.g. localhost', + tooltip: 'Example: localhost', }, ipAddr: { value: '', question: 'IP address:', - tooltip: 'e.g. 127.0.0.1', + tooltip: 'Example: 127.0.0.1', }, secureVipAddress: { value: '', question: 'Secure virtual IP address:', - tooltip: 'e.g. hwexpress', + tooltip: 'Example: hwexpress', }, }, }, @@ -128,7 +128,7 @@ export const nodeSpecificCategories = [ $: { value: '', question: 'Port:', - tooltip: 'e.g. 10020', + tooltip: 'Example: 10020', }, '@enabled': { value: false, @@ -142,7 +142,7 @@ export const nodeSpecificCategories = [ $: { value: '', question: 'Security port:', - tooltip: 'e.g. 10020', + tooltip: 'Example: 10020', }, '@enabled': { value: true, @@ -156,12 +156,12 @@ export const nodeSpecificCategories = [ '@class': { value: '', question: 'Class:', - tooltip: 'e.g. com.netflix.appinfo. InstanceInfo$DefaultDataCenterInfo', + tooltip: 'Example: com.netflix.appinfo. InstanceInfo$DefaultDataCenterInfo', }, name: { value: '', question: 'Name:', - tooltip: 'e.g. MyOwn', + tooltip: 'Example: MyOwn', }, }, }, @@ -171,58 +171,58 @@ export const nodeSpecificCategories = [ 'apiml.catalog.tile.id': { value: '', question: 'Tile ID for the API ML catalog:', - tooltip: 'e.g. samplenodeservice', + tooltip: 'Example: samplenodeservice', }, 'apiml.catalog.tile.title': { value: '', question: 'Tile title for the API ML catalog:', - tooltip: 'e.g. Zowe Sample Node Service', + tooltip: 'Example: Zowe Sample Node Service', }, 'apiml.catalog.tile.description': { value: '', question: 'Tile description for the API ML catalog:', - tooltip: 'e.g. NodeJS Sample service running', + tooltip: 'Example: NodeJS Sample service running', }, 'apiml.catalog.tile.version': { value: '', question: 'Tile version for the API ML catalog:', - tooltip: 'e.g. 1.0.0', + tooltip: 'Example: 1.0.0', }, 'apiml.routes.api_v1.gatewayUrl': { value: '', question: 'API gateway URL:', - tooltip: 'e.g. api/v1', + tooltip: 'Example: api/v1', }, 'apiml.routes.api_v1.serviceUrl': { value: '', question: 'API service URL:', - tooltip: 'e.g. /api/v1', + tooltip: 'Example: /api/v1', }, 'apiml.apiInfo.0.apiId': { value: '', question: 'A unique identifier to the API in the API ML:', - tooltip: 'e.g. zowe.apiml.hwexpress', + tooltip: 'Example: zowe.apiml.hwexpress', }, 'apiml.apiInfo.0.gatewayUrl': { value: '', question: 'The base path at the API Gateway where the API is available:', - tooltip: 'e.g. api/v1', + tooltip: 'Example: api/v1', }, 'apiml.apiInfo.0.swaggerUrl': { value: '', question: 'The base path at the API Gateway where the API is available:', - tooltip: 'e.g. https://localhost:10020/ swagger.json', + tooltip: 'Example: https://localhost:10020/ swagger.json', }, 'apiml.service.title': { value: '', question: 'Service title:', - tooltip: 'e.g. Zowe Sample Node Service', + tooltip: 'Example: Zowe Sample Node Service', }, 'apiml.service.description': { value: '', question: 'Service description:', tooltip: - 'e.g. The Proxy Server is an HTTP HTTPS, and Websocket server built upon NodeJS and ExpressJS.', + 'Example: The Proxy Server is an HTTP HTTPS, and Websocket server built upon NodeJS and ExpressJS.', }, }, }, diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_static_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_static_categories.jsx index 20455b70f3..ed9a157784 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_static_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_static_categories.jsx @@ -17,7 +17,7 @@ export const staticSpecificCategories = [ instanceBaseUrls: { value: '', question: 'The base URL of the instance (the consistent part of the web address):', - tooltip: 'e.g. http://localhost:8080', + tooltip: 'Example: http://localhost:8080', }, }, multiple: false, @@ -35,7 +35,7 @@ export const staticSpecificCategories = [ serviceRelativeUrl: { value: '', question: 'Service API common context path:', - tooltip: 'e.g. /sampleservice/api/v1', + tooltip: 'Example: /sampleservice/api/v1', }, }, help: 'For service: /allOfMyEndpointsAreHere/** exposed on Gateway under //api/v1/**\nFill in:\ngatewayUrl: /api/v1\nserviceUrl: /allOfMyEndpointsAreHere', @@ -55,7 +55,7 @@ export const staticSpecificCategories = [ question: 'The id of the catalog tile:', regexRestriction: [wizRegex.noWhiteSpaces], dependencies: { type: 'Custom' }, - tooltip: 'e.g. static', + tooltip: 'Example: static', }, }, interference: 'staticCatalog', @@ -66,13 +66,13 @@ export const staticSpecificCategories = [ title: { value: '', question: 'The title of the API services product family:', - tooltip: 'e.g. Static API services', + tooltip: 'Example: Static API services', }, description: { value: '', question: 'The detailed description of the API Catalog UI dashboard tile:', tooltip: - 'e.g. Services which demonstrate how to make an API service discoverable in the APIML ecosystem using YAML definitions', + 'Example: Services which demonstrate how to make an API service discoverable in the API ML ecosystem using YAML definitions', }, }, indentationDependency: 'catalogUiTileId', From 3b9de7e3ddf257f228065ae7a3b07d13e4e34c62 Mon Sep 17 00:00:00 2001 From: Caio Camatta Date: Thu, 24 Mar 2022 18:10:53 -0400 Subject: [PATCH 3/7] Improve tooltips --- .../Wizard/configs/wizard_micronaut_categories.jsx | 6 +++--- .../components/Wizard/configs/wizard_spring_categories.jsx | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx index 8c858a7002..d15c2e648e 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx @@ -209,7 +209,7 @@ export const micronautSpecificCategories = [ defaultZone: { value: '', question: 'Eureka default zone:', - tooltip: 'placeholder', + tooltip: 'Example: https://localhost:10011/eureka/', }, }, }, @@ -219,7 +219,7 @@ export const micronautSpecificCategories = [ 'base-path': { value: '', question: 'Endpoint base-path:', - tooltip: 'placeholder', + tooltip: 'Example: /application', }, }, }, @@ -229,7 +229,7 @@ export const micronautSpecificCategories = [ include: { value: '', question: 'Endpoint base-path:', - tooltip: 'placeholder', + tooltip: 'Example: health,info', }, }, }, diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_spring_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_spring_categories.jsx index ba0bd66398..c699fd696a 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_spring_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_spring_categories.jsx @@ -18,7 +18,7 @@ export const springSpecificCategories = [ }, enableUrlEncodedCharacters: { value: false, - question: 'Service requests the API ML GW to receive encoded characters in the URL', + question: 'When the value is true, the Gateway allows encoded characters to be part of URL requests redirected through the Gateway. The default setting of false is the recommended setting. Change this setting to true only if you expect certain encoded characters in your application\'s requests', }, }, }, From 04e9db19a8c7ca1282929f40a409880c987136ca Mon Sep 17 00:00:00 2001 From: Caio Camatta Date: Sat, 26 Mar 2022 13:46:48 -0400 Subject: [PATCH 4/7] Fix formatting --- .../components/Wizard/configs/wizard_base_categories.jsx | 6 ++++-- .../Wizard/configs/wizard_micronaut_categories.jsx | 3 ++- .../components/Wizard/configs/wizard_node_categories.jsx | 3 ++- .../components/Wizard/configs/wizard_spring_categories.jsx | 3 ++- 4 files changed, 10 insertions(+), 5 deletions(-) diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx index a94c719645..2d4861238c 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx @@ -104,7 +104,8 @@ 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', + tooltip: + 'Normally used for informational purposes for other services to use it as a landing page. Example: /home', }, statusPageRelativeUrl: { value: '', @@ -205,7 +206,8 @@ 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', + tooltip: + 'Example: http://${sampleServiceSwaggerHost}:${sampleServiceSwaggerPort}/sampleservice/api-doc', }, documentationUrl: { value: '', diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx index d15c2e648e..d7f7047300 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx @@ -101,7 +101,8 @@ export const micronautSpecificCategories = [ 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.', + 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.', }, }, }, diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_node_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_node_categories.jsx index 54adc0bd55..69099679fa 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_node_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_node_categories.jsx @@ -78,7 +78,8 @@ export const nodeSpecificCategories = [ value: '', question: 'The interval for registry interval:', hide: true, - tooltip: 'How often does Eureka client pull the service list from Eureka server. The default is 30 seconds. Example: 5', + tooltip: + 'How often does Eureka client pull the service list from Eureka server. The default is 30 seconds. Example: 5', }, }, }, diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_spring_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_spring_categories.jsx index c699fd696a..e5f629afec 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_spring_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_spring_categories.jsx @@ -18,7 +18,8 @@ export const springSpecificCategories = [ }, enableUrlEncodedCharacters: { value: false, - question: 'When the value is true, the Gateway allows encoded characters to be part of URL requests redirected through the Gateway. The default setting of false is the recommended setting. Change this setting to true only if you expect certain encoded characters in your application\'s requests', + question: + 'When the value is true, the Gateway allows encoded characters to be part of URL requests redirected through the Gateway. The default setting of false is the recommended setting. Change this setting to true only if you expect certain encoded characters in your application\'s requests', }, }, }, From 61ce7e11ff467d2f6299fc8d474980f5c3265c97 Mon Sep 17 00:00:00 2001 From: Andrea Tabone Date: Tue, 29 Mar 2022 13:30:57 +0200 Subject: [PATCH 5/7] Fix eslint complain Signed-off-by: at670475 --- .../src/components/Wizard/configs/wizard_spring_categories.jsx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_spring_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_spring_categories.jsx index e5f629afec..38ca46904d 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_spring_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_spring_categories.jsx @@ -18,8 +18,7 @@ export const springSpecificCategories = [ }, enableUrlEncodedCharacters: { value: false, - question: - 'When the value is true, the Gateway allows encoded characters to be part of URL requests redirected through the Gateway. The default setting of false is the recommended setting. Change this setting to true only if you expect certain encoded characters in your application\'s requests', + question: `When the value is true, the Gateway allows encoded characters to be part of URL requests redirected through the Gateway. The default setting of false is the recommended setting. Change this setting to true only if you expect certain encoded characters in your application's requests`, }, }, }, From ed1bbdadee01311db015e033dd8a80ec3cd79149 Mon Sep 17 00:00:00 2001 From: Andrea Tabone Date: Tue, 29 Mar 2022 14:22:34 +0200 Subject: [PATCH 6/7] Small fix in the values Signed-off-by: at670475 --- .../Wizard/configs/wizard_base_categories.jsx | 3 ++- .../Wizard/configs/wizard_micronaut_categories.jsx | 12 +++++++++--- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx index 2d4861238c..9e34470b70 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx @@ -193,7 +193,7 @@ export const baseCategories = [ version: { value: '', question: 'API version:', - tooltip: 'API version', + tooltip: 'Example: 1.0.0', regexRestriction: [wizRegex.version], }, gatewayUrl: { @@ -269,6 +269,7 @@ export const baseCategories = [ value: '', question: 'The password associated with the private key:', type: 'password', + tooltip: 'password', }, keyStore: { value: '', diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx index d7f7047300..9be5ba29b4 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx @@ -15,7 +15,7 @@ export const micronautSpecificCategories = [ apiId: { value: '', question: 'A unique identifier to the API in the API ML:', - tooltip: 'Example: sampleservice', + tooltip: 'Example: zowe.apiml.sampleservice', }, version: { value: '', @@ -82,7 +82,7 @@ export const micronautSpecificCategories = [ value: '', question: 'The truststore file used to keep other parties public keys and certificates:', dependencies: { enabled: true }, - tooltip: 'Your truststore.', + tooltip: 'Example: keystore/localhost.truststore.p12', }, trustStorePassword: { value: '', @@ -145,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', }, }, }, @@ -162,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', }, }, }, @@ -180,6 +185,7 @@ export const micronautSpecificCategories = [ path: { value: '', question: 'The truststore file used to keep other parties public keys and certificates:', + tooltip: 'Example: keystore/localhost.truststore.p12', }, type: { value: '', From 501e5da9f66e3e7ed84804dbcdf4f4755d03c95d Mon Sep 17 00:00:00 2001 From: Andrea Tabone Date: Tue, 29 Mar 2022 14:32:52 +0200 Subject: [PATCH 7/7] Small fix in the values Signed-off-by: at670475 --- .../src/components/Wizard/configs/wizard_base_categories.jsx | 2 ++ .../components/Wizard/configs/wizard_micronaut_categories.jsx | 1 + 2 files changed, 3 insertions(+) diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx index 9e34470b70..2c42e61a8b 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_base_categories.jsx @@ -280,6 +280,7 @@ export const baseCategories = [ value: '', question: 'The password used to unlock the keystore:', type: 'password', + tooltip: 'Your keystore password', }, keyStoreType: { value: 'PKCS12', @@ -295,6 +296,7 @@ export const baseCategories = [ value: '', question: 'The password used to unlock the truststore:', type: 'password', + tooltip: 'Your truststore password.', }, trustStoreType: { value: 'PKCS12', diff --git a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx index 9be5ba29b4..da9f37b5cf 100644 --- a/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx +++ b/api-catalog-ui/frontend/src/components/Wizard/configs/wizard_micronaut_categories.jsx @@ -181,6 +181,7 @@ export const micronautSpecificCategories = [ value: '', question: 'The password used to unlock the truststore:', type: 'password', + tooltip: 'Your truststore password.', }, path: { value: '',