diff --git a/en/docs/administer/advanced-configurations.md b/en/docs/administer/advanced-configurations.md index bb749b66b4..977611d7e2 100644 --- a/en/docs/administer/advanced-configurations.md +++ b/en/docs/administer/advanced-configurations.md @@ -13,7 +13,7 @@ This section covers how to change and configure several features related to the 1. Change the relevant configuration accordingly and click **Save**. - + ??? tip "Setting custom Linter rules" You can add your custom rules in JSON with the key “LinterCustomRules”. diff --git a/en/docs/ai-gateway/ai-backend-security.md b/en/docs/ai-gateway/ai-backend-security.md index 4e93cd38b2..2e09882b7b 100644 --- a/en/docs/ai-gateway/ai-backend-security.md +++ b/en/docs/ai-gateway/ai-backend-security.md @@ -8,7 +8,7 @@ The first step is to obtain an **API Key** from the AI Service Provider you sele You can do so for OpenAI by following the steps mentioned below: -1. Login to OpenAI and go to OpenAI Dashboard. +1. Login to OpenAI and go to [OpenAI Dashboard](https://platform.openai.com/api-keys) 2. Navigate to **API keys** section from the left menu. Then, click on **Create new secret key**. Provide a name for the key and click on **Create secret key**. [![Get OpenAI API Key]({{base_path}}/assets/img/learn/ai-gateway/openai-api-key-generation.png){: style="width:90%"}]({{base_path}}/assets/img/learn/ai-gateway/openai-api-key-generation.png) @@ -20,7 +20,7 @@ You can do so for OpenAI by following the steps mentioned below: 2. Notice the **API Key Required** warning against the `Default Production Endpoint` and `Default Sandbox Endpoint`. Click on **Edit** icon and fill in the API Key value which you obtained from Step 1 above and click on **Update** to save the changes. !!! Note - API Manager supports below AI Service Providers by default. The authorization approach of each is mentioned below: + API Manager supports below AI Service Providers by default.The authorization approach for each provider is listed below.: - **Anthropic**: `x-api-key` header - **AWSBedrock**: Requires both an AWS Access Key and AWS Secret Key for authentication. - **AzureAIFoundry**: `api-key` header @@ -29,6 +29,6 @@ You can do so for OpenAI by following the steps mentioned below: - **MistralAI**: `Authorization` header - **OpenAI**: `Authorization` header - Note that we prepend "Bearer " to the header value that you provide when it comes to MistralAI and OpenAI since they are expecting an Authorization header. + Note that We prepend "Bearer " to the header value. that you provide when it comes to MistralAI and OpenAI since they are expecting an Authorization header. [![API Key Configuration]({{base_path}}/assets/img/learn/ai-gateway/ai-api-configure-backend-security.png){: style="width:90%"}]({{base_path}}/assets/img/learn/ai-gateway/ai-api-configure-backend-security.png) diff --git a/en/docs/includes/design/deploy-revision.md b/en/docs/includes/design/deploy-revision.md index 458f0bc314..6bd080d485 100644 --- a/en/docs/includes/design/deploy-revision.md +++ b/en/docs/includes/design/deploy-revision.md @@ -9,7 +9,7 @@ Follow the instructions below to deploy a new revision for an API: The Deployments page appears as follows when you do not have any existing revisions. - [![New revision](../../../../assets/img/design/revision/deploy-first-revision.png){: style="width:80%"}](../../../../assets/img/design/revision/deploy-first-revision.png) + [![New revision](../../../assets/img/design/revision/deploy-first-revision.png){: style="width:80%"}](../../../assets/img/design/revision/deploy-first-revision.png) The Deployments page appears as follows when you have at least one revision. @@ -25,7 +25,7 @@ Follow the instructions below to deploy a new revision for an API: !!! warning You cannot deploy more than 5 revisions. If you want to deploy a new revision after the maximum allowed number of revisions are reached, you need to delete one of the existing revisions. - [![Delete revision if max count is reached](../../../../assets/img/design/revision/delete-and-deploy-revision.png){: style="width:60%"}](../../../../assets/img/design/revision/delete-and-deploy-revision.png) + [![Delete revision if max count is reached](../../../assets/img/design/revision/delete-and-deploy-revision.png){: style="width:60%"}](../../../assets/img/design/revision/delete-and-deploy-revision.png) 4. Optionally, provide a description for the revision. 5. Select the API Gateways in which you want to deploy the API. @@ -33,4 +33,4 @@ Follow the instructions below to deploy a new revision for an API: !!! note If your API is deployed successfully to the Gateways, the deployment status will be updated in the status column. You can view more information by hovering over the deployment status icon. - [![Deployment status acknowledgement](../../../../assets/img/design/revision/revision-deployment-acknowledgement.png)](../../../../assets/img/design/revision/revision-deployment-acknowledgement.png) \ No newline at end of file + [![Deployment status acknowledgement](../../../assets/img/design/revision/revision-deployment-acknowledgement.png)](../../../assets/img/design/revision/revision-deployment-acknowledgement.png) \ No newline at end of file diff --git a/en/docs/includes/design/invoke-prerelease-api.md b/en/docs/includes/design/invoke-prerelease-api.md index 293964211c..cc9d09a418 100644 --- a/en/docs/includes/design/invoke-prerelease-api.md +++ b/en/docs/includes/design/invoke-prerelease-api.md @@ -17,7 +17,7 @@ Once deployed to the Gateway, you can [test the REST type APIs via the Publisher 2. Select the required Business Plans and click **Save**. - [![Select Prototype API Business Plans](../../../../assets/img/learn/prototype-api/create-prototype-api-subscription.png)](../../../../assets/img/learn/prototype-api/create-prototype-api-subscription.png) + [![Select Prototype API Business Plans](../../../assets/img/learn/prototype-api/create-prototype-api-subscription.png)](../../../assets/img/learn/prototype-api/create-prototype-api-subscription.png) Follow the instructions below to publish the API to the Developer Portal as a Prototype: @@ -25,6 +25,6 @@ Follow the instructions below to publish the API to the Developer Portal as a Pr For both options, **When creating an API with the Mock Implementation** and **When creating an API with an actual backend URL**, you will have the option to either promote your API to the **PRE-RELEASED** state or to the **PUBLISHED** state in the API lifecycle. - [![Publish as Pre-Released API when using backend URL](../../../../assets/img/learn/prototype-api/backend-url-lifecycle.png)](../../../../assets/img/learn/prototype-api/backend-url-lifecycle.png) + [![Publish as Pre-Released API when using backend URL](../../../assets/img/learn/prototype-api/backend-url-lifecycle.png)](../../../assets/img/learn/prototype-api/backend-url-lifecycle.png) 2. Click **Pre-Release** to publish the API as a Prototype API to the Developer Portal. \ No newline at end of file