Skip to content

Commit

Permalink
add bold (#1543)
Browse files Browse the repository at this point in the history
  • Loading branch information
@FrankEssenberger
FrankEssenberger authored Aug 26, 2021
1 parent 17320c0 commit d9a959b
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion packages/generator-common/src/sdk-metadata/__snapshots__/sdk-metadata.spec.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Object {

exports[`sdk-metadata generates the header content 1`] = `
Object {
"introText": "The SAP Cloud SDK is a versatile set of libraries and tools for developers to build applications in a cloud-native way and host them on the SAP Business Technology Platform or other runtimes.",
"introText": "The SAP Cloud SDK is a versatile set of libraries and tools for developers to build cloud-native applications on the SAP Business Technology Platform. To simplify the consumption of multiple services published on the SAP API Business Hub, the SDK offers code generators for OData and OpenAPI together with pregenerated typed client libraries. These libraries are seamlessly integrated with connectivity, authentication, multi-tenancy, and other abstractions to speed up application development.",
"name": "API_TEST_SRV",
"type": "odata",
"version": "1.0.0",
Expand Down
16 changes: 8 additions & 8 deletions packages/generator-common/src/sdk-metadata/generation-and-usage.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ export function getGenerationSteps(

return {
header: 'Installation & Generation Steps',
instructions: `<ul>
instructions: `<ol type="1">
<li>Install <a href="https://docs.npmjs.com/downloading-and-installing-node-js-and-npm">Node and npm</a>. We recommend the use of the LTS version.</li>
<li>Download the API specification from the Overview -&gt; API Specification section. ${
apiType === 'OData' ? 'Choose EDMX format.' : 'Choose JSON format.'
}</li>
<li>Generate a typed client by running <code>${installCommand}</code> to install the generator.</li>
<li>Execute the generator <code>${generateCommand}</code></li>
<li>You should now find generated classes in the output directory specified in step 4.</li>
<li>By default we generate TypeScript only. If you need to transpile it to JavaScript, check the <a href="${generationDocLink}${anchor}"> CLI options in the documentation</a>.</li>
<li>If you encounter issues during generation, carefully check your configuration and refer to the <a href="${generationDocLink}">extended documentation</a> on generating ${apiType} clients</a>.</li>
<li>Congratulations! Check the usage example below to import and use your generated ${apiType} client library.</li>
</ul>`.replace(/\n/g, ''),
<li>Install the generator by running: <code><b>${installCommand}</b></code></li>
<li>Generate a typed client by running the generator: <code><b>${generateCommand}</b></code></li>
</ol>
<p>You should now find generated classes in the output directory specified in step 4. By default, we generate TypeScript only. If you need to transpile it to JavaScript, check the <a href="${generationDocLink}${anchor}"> CLI options in the documentation</a>.</p>
<p>If you encounter issues during generation, carefully check your configuration and refer to the <a href="${generationDocLink}">extended documentation</a> on generating ${apiType} clients</a>.</p>
<p>Congratulations! Check the usage example below to import and use your generated ${apiType} client library.</p>
`.replace(/\n/g, ''),
text: `You can generate a typed OData client for this service on your own. Follow the instructions below to install the SAP Cloud SDK ${apiType} generator and complete the generation steps:`
};
}
Expand Down
2 changes: 1 addition & 1 deletion packages/generator-common/src/sdk-metadata/sdk-metadata.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export function getSdkMetadataClient(
}

export const sdkMetadataHeaderIntroText =
'The SAP Cloud SDK is a versatile set of libraries and tools for developers to build applications in a cloud-native way and host them on the SAP Business Technology Platform or other runtimes.';
'The SAP Cloud SDK is a versatile set of libraries and tools for developers to build cloud-native applications on the SAP Business Technology Platform. To simplify the consumption of multiple services published on the SAP API Business Hub, the SDK offers code generators for OData and OpenAPI together with pregenerated typed client libraries. These libraries are seamlessly integrated with connectivity, authentication, multi-tenancy, and other abstractions to speed up application development.';

export const ServiceStatusValues: Record<
ServiceStatus['status'],
Expand Down
4 changes: 2 additions & 2 deletions packages/generator/src/sdk-metadata/__snapshots__/sdk-metadata.spec.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const resultPromise = TestEntity.requestBuilder().getAll().top(5).execute({ dest
},
"generationSteps": Object {
"header": "Installation & Generation Steps",
"instructions": "<ul><li>Install <a href=\\"https://docs.npmjs.com/downloading-and-installing-node-js-and-npm\\">Node and npm</a>. We recommend the use of the LTS version.</li><li>Download the API specification from the Overview -&gt; API Specification section. Choose EDMX format.</li><li>Generate a typed client by running <code>npm install -g @sap-cloud-sdk/generator</code> to install the generator.</li><li>Execute the generator <code>generate-odata-client --inputDir path/to/specification/ --outputDir path/to/client/</code></li><li>You should now find generated classes in the output directory specified in step 4.</li><li>By default we generate TypeScript only. If you need to transpile it to JavaScript, check the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/odata/generate-odata-client#options\\"> CLI options in the documentation</a>.</li><li>If you encounter issues during generation, carefully check your configuration and refer to the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/odata/generate-odata-client\\">extended documentation</a> on generating OData clients</a>.</li><li>Congratulations! Check the usage example below to import and use your generated OData client library.</li></ul>",
"instructions": "<ol type=\\"1\\"><li>Install <a href=\\"https://docs.npmjs.com/downloading-and-installing-node-js-and-npm\\">Node and npm</a>. We recommend the use of the LTS version.</li><li>Download the API specification from the Overview -&gt; API Specification section. Choose EDMX format.</li><li>Install the generator by running: <code><b>npm install -g @sap-cloud-sdk/generator</b></code></li><li>Generate a typed client by running the generator: <code><b>generate-odata-client --inputDir path/to/specification/ --outputDir path/to/client/</b></code></li></ol><p>You should now find generated classes in the output directory specified in step 4. By default, we generate TypeScript only. If you need to transpile it to JavaScript, check the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/odata/generate-odata-client#options\\"> CLI options in the documentation</a>.</p><p>If you encounter issues during generation, carefully check your configuration and refer to the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/odata/generate-odata-client\\">extended documentation</a> on generating OData clients</a>.</p><p>Congratulations! Check the usage example below to import and use your generated OData client library.</p>",
"text": "You can generate a typed OData client for this service on your own. Follow the instructions below to install the SAP Cloud SDK OData generator and complete the generation steps:",
},
"generatorRepositoryLink": "https://www.npmjs.com/package/@sap-cloud-sdk/generator",
Expand Down Expand Up @@ -88,7 +88,7 @@ const resultPromise = TestEntity.requestBuilder().getAll().top(5).execute({ dest
},
"generationSteps": Object {
"header": "Installation & Generation Steps",
"instructions": "<ul><li>Install <a href=\\"https://docs.npmjs.com/downloading-and-installing-node-js-and-npm\\">Node and npm</a>. We recommend the use of the LTS version.</li><li>Download the API specification from the Overview -&gt; API Specification section. Choose EDMX format.</li><li>Generate a typed client by running <code>npm install -g @sap-cloud-sdk/generator</code> to install the generator.</li><li>Execute the generator <code>generate-odata-client --inputDir path/to/specification/ --outputDir path/to/client/</code></li><li>You should now find generated classes in the output directory specified in step 4.</li><li>By default we generate TypeScript only. If you need to transpile it to JavaScript, check the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/odata/generate-odata-client#options\\"> CLI options in the documentation</a>.</li><li>If you encounter issues during generation, carefully check your configuration and refer to the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/odata/generate-odata-client\\">extended documentation</a> on generating OData clients</a>.</li><li>Congratulations! Check the usage example below to import and use your generated OData client library.</li></ul>",
"instructions": "<ol type=\\"1\\"><li>Install <a href=\\"https://docs.npmjs.com/downloading-and-installing-node-js-and-npm\\">Node and npm</a>. We recommend the use of the LTS version.</li><li>Download the API specification from the Overview -&gt; API Specification section. Choose EDMX format.</li><li>Install the generator by running: <code><b>npm install -g @sap-cloud-sdk/generator</b></code></li><li>Generate a typed client by running the generator: <code><b>generate-odata-client --inputDir path/to/specification/ --outputDir path/to/client/</b></code></li></ol><p>You should now find generated classes in the output directory specified in step 4. By default, we generate TypeScript only. If you need to transpile it to JavaScript, check the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/odata/generate-odata-client#options\\"> CLI options in the documentation</a>.</p><p>If you encounter issues during generation, carefully check your configuration and refer to the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/odata/generate-odata-client\\">extended documentation</a> on generating OData clients</a>.</p><p>Congratulations! Check the usage example below to import and use your generated OData client library.</p>",
"text": "You can generate a typed OData client for this service on your own. Follow the instructions below to install the SAP Cloud SDK OData generator and complete the generation steps:",
},
"generatorRepositoryLink": "https://www.npmjs.com/package/@sap-cloud-sdk/generator",
Expand Down
2 changes: 1 addition & 1 deletion packages/openapi-generator/src/sdk-metadata/__snapshots__/generation-and-usage.spec.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const responseData = await DummyApi.DummyFunction().execute({ destinationName:'m
},
"generationSteps": Object {
"header": "Installation & Generation Steps",
"instructions": "<ul><li>Install <a href=\\"https://docs.npmjs.com/downloading-and-installing-node-js-and-npm\\">Node and npm</a>. We recommend the use of the LTS version.</li><li>Download the API specification from the Overview -&gt; API Specification section. Choose JSON format.</li><li>Generate a typed client by running <code>npm install -g @sap-cloud-sdk/openapi-generator</code> to install the generator.</li><li>Execute the generator <code>openapi-generator --inputDir path/to/specification/ --outputDir path/to/client/</code></li><li>You should now find generated classes in the output directory specified in step 4.</li><li>By default we generate TypeScript only. If you need to transpile it to JavaScript, check the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/openapi/generate-openapi-client#options-of-the-openapi-cli\\"> CLI options in the documentation</a>.</li><li>If you encounter issues during generation, carefully check your configuration and refer to the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/openapi/generate-openapi-client\\">extended documentation</a> on generating OpenAPI clients</a>.</li><li>Congratulations! Check the usage example below to import and use your generated OpenAPI client library.</li></ul>",
"instructions": "<ol type=\\"1\\"><li>Install <a href=\\"https://docs.npmjs.com/downloading-and-installing-node-js-and-npm\\">Node and npm</a>. We recommend the use of the LTS version.</li><li>Download the API specification from the Overview -&gt; API Specification section. Choose JSON format.</li><li>Install the generator by running: <code><b>npm install -g @sap-cloud-sdk/openapi-generator</b></code></li><li>Generate a typed client by running the generator: <code><b>openapi-generator --inputDir path/to/specification/ --outputDir path/to/client/</b></code></li></ol><p>You should now find generated classes in the output directory specified in step 4. By default, we generate TypeScript only. If you need to transpile it to JavaScript, check the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/openapi/generate-openapi-client#options-of-the-openapi-cli\\"> CLI options in the documentation</a>.</p><p>If you encounter issues during generation, carefully check your configuration and refer to the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/openapi/generate-openapi-client\\">extended documentation</a> on generating OpenAPI clients</a>.</p><p>Congratulations! Check the usage example below to import and use your generated OpenAPI client library.</p>",
"text": "You can generate a typed OData client for this service on your own. Follow the instructions below to install the SAP Cloud SDK OpenAPI generator and complete the generation steps:",
},
"generatorRepositoryLink": "https://www.npmjs.com/package/@sap-cloud-sdk/openapi-generator",
Expand Down
4 changes: 2 additions & 2 deletions packages/openapi-generator/src/sdk-metadata/__snapshots__/sdk-metadata.spec.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const responseData = await DummyApi.DummyFunction().execute({ destinationName:'m
},
"generationSteps": Object {
"header": "Installation & Generation Steps",
"instructions": "<ul><li>Install <a href=\\"https://docs.npmjs.com/downloading-and-installing-node-js-and-npm\\">Node and npm</a>. We recommend the use of the LTS version.</li><li>Download the API specification from the Overview -&gt; API Specification section. Choose JSON format.</li><li>Generate a typed client by running <code>npm install -g @sap-cloud-sdk/openapi-generator</code> to install the generator.</li><li>Execute the generator <code>openapi-generator --inputDir path/to/specification/ --outputDir path/to/client/</code></li><li>You should now find generated classes in the output directory specified in step 4.</li><li>By default we generate TypeScript only. If you need to transpile it to JavaScript, check the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/openapi/generate-openapi-client#options-of-the-openapi-cli\\"> CLI options in the documentation</a>.</li><li>If you encounter issues during generation, carefully check your configuration and refer to the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/openapi/generate-openapi-client\\">extended documentation</a> on generating OpenAPI clients</a>.</li><li>Congratulations! Check the usage example below to import and use your generated OpenAPI client library.</li></ul>",
"instructions": "<ol type=\\"1\\"><li>Install <a href=\\"https://docs.npmjs.com/downloading-and-installing-node-js-and-npm\\">Node and npm</a>. We recommend the use of the LTS version.</li><li>Download the API specification from the Overview -&gt; API Specification section. Choose JSON format.</li><li>Install the generator by running: <code><b>npm install -g @sap-cloud-sdk/openapi-generator</b></code></li><li>Generate a typed client by running the generator: <code><b>openapi-generator --inputDir path/to/specification/ --outputDir path/to/client/</b></code></li></ol><p>You should now find generated classes in the output directory specified in step 4. By default, we generate TypeScript only. If you need to transpile it to JavaScript, check the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/openapi/generate-openapi-client#options-of-the-openapi-cli\\"> CLI options in the documentation</a>.</p><p>If you encounter issues during generation, carefully check your configuration and refer to the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/openapi/generate-openapi-client\\">extended documentation</a> on generating OpenAPI clients</a>.</p><p>Congratulations! Check the usage example below to import and use your generated OpenAPI client library.</p>",
"text": "You can generate a typed OData client for this service on your own. Follow the instructions below to install the SAP Cloud SDK OpenAPI generator and complete the generation steps:",
},
"generatorRepositoryLink": "https://www.npmjs.com/package/@sap-cloud-sdk/openapi-generator",
Expand Down Expand Up @@ -83,7 +83,7 @@ const responseData = await DummyApi.DummyFunction().execute({ destinationName:'m
},
"generationSteps": Object {
"header": "Installation & Generation Steps",
"instructions": "<ul><li>Install <a href=\\"https://docs.npmjs.com/downloading-and-installing-node-js-and-npm\\">Node and npm</a>. We recommend the use of the LTS version.</li><li>Download the API specification from the Overview -&gt; API Specification section. Choose JSON format.</li><li>Generate a typed client by running <code>npm install -g @sap-cloud-sdk/openapi-generator</code> to install the generator.</li><li>Execute the generator <code>openapi-generator --inputDir path/to/specification/ --outputDir path/to/client/</code></li><li>You should now find generated classes in the output directory specified in step 4.</li><li>By default we generate TypeScript only. If you need to transpile it to JavaScript, check the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/openapi/generate-openapi-client#options-of-the-openapi-cli\\"> CLI options in the documentation</a>.</li><li>If you encounter issues during generation, carefully check your configuration and refer to the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/openapi/generate-openapi-client\\">extended documentation</a> on generating OpenAPI clients</a>.</li><li>Congratulations! Check the usage example below to import and use your generated OpenAPI client library.</li></ul>",
"instructions": "<ol type=\\"1\\"><li>Install <a href=\\"https://docs.npmjs.com/downloading-and-installing-node-js-and-npm\\">Node and npm</a>. We recommend the use of the LTS version.</li><li>Download the API specification from the Overview -&gt; API Specification section. Choose JSON format.</li><li>Install the generator by running: <code><b>npm install -g @sap-cloud-sdk/openapi-generator</b></code></li><li>Generate a typed client by running the generator: <code><b>openapi-generator --inputDir path/to/specification/ --outputDir path/to/client/</b></code></li></ol><p>You should now find generated classes in the output directory specified in step 4. By default, we generate TypeScript only. If you need to transpile it to JavaScript, check the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/openapi/generate-openapi-client#options-of-the-openapi-cli\\"> CLI options in the documentation</a>.</p><p>If you encounter issues during generation, carefully check your configuration and refer to the <a href=\\"https://sap.github.io/cloud-sdk/docs/js/features/openapi/generate-openapi-client\\">extended documentation</a> on generating OpenAPI clients</a>.</p><p>Congratulations! Check the usage example below to import and use your generated OpenAPI client library.</p>",
"text": "You can generate a typed OData client for this service on your own. Follow the instructions below to install the SAP Cloud SDK OpenAPI generator and complete the generation steps:",
},
"generatorRepositoryLink": "https://www.npmjs.com/package/@sap-cloud-sdk/openapi-generator",
Expand Down

0 comments on commit d9a959b

Please sign in to comment.