Skip to content

Commit

Permalink
Merge pull request #8818 from RusJaI/master
Browse files Browse the repository at this point in the history
Fix broken links in APIM docs
  • Loading branch information
RusJaI authored Nov 13, 2024
2 parents 075964f + 3a50ccf commit a345142
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion en/docs/design/api-documentation/add-api-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Follow the instructions below to add documentation to an API:
<tr class="even">
<td>Source</td>
<td>URL<br />
<a href="http://www.dummyforum.com" class="uri">http://www.dummyforum.com</a></td>
<code>http://www.dummyforum.com</code></td>
</tr>
</tbody>
</table>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The following diagram illustrates the message flow when sending an invalid reque

**Example:**

The following is an invalid request based on the [Petstore API](https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v2.0/json/petstore.json).
The following is an invalid request based on the [Petstore API](https://github.com/OAI/learn.openapis.org/blob/main/examples/v2.0/json/petstore.json).

```
curl -X POST "https://localhost:8243/rfrf/1.0.0/pet" -H "accept: */*" -H "Content-Type: application/json" -H "Authorization: Bearer c06e0cb0-af4a-3e5e-b8c3-99449ff7e3e5" -d "{\"id\":0,\"category\":{\"id\":0,\"name\":\"string\"},\"name\":\"doggie\",\"photoUrls\":[\"string\"],\"tags\":[{\"id\":0,\"name\":\"string\"}],\"status\":\"available\"}"
Expand Down Expand Up @@ -56,7 +56,7 @@ The following diagram illustrates the message flow when sending an invalid respo

**Example**

The following is a sample request from the client based on the [Petstore API](https://github.com/OAI/OpenAPI-Specification/blob/main/tests/v3.0/pass/petstore.yaml).
The following is a sample request from the client based on the [Petstore API](https://github.com/OAI/learn.openapis.org/blob/main/examples/v2.0/json/petstore.json).

```
curl -X GET "https://localhost:8243/PetstoreAPI/1.0.0/pets/1" -H "accept: application/xml" -H "Authorization: Bearer c06e0cb0-af4a-3e5e-b8c3-99449ff7e3e5"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Follow the instructions below to create a Read only user:

2. Create a user (Chris) and assign the **observer** default role.

[![Read-only user creation]({{base_path}}/assets/img/learn/api-security/assign-role-to-user.png){: style="width:70%"}](({{base_path}}/assets/img/learn/api-security/assign-role-to-user.png))
[![Read-only user creation]({{base_path}}/assets/img/learn/api-security/assign-role-to-user.png){: style="width:70%"}]({{base_path}}/assets/img/learn/api-security/assign-role-to-user.png)

3. Click **Finish**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Follow the instructions below to create an AI API using the basic flow:

4. Configure AI API details.

<table><colgroup> <col/> <col/> <col/> </colgroup><tbody><tr><th colspan="2" >Field</th><th >Sample value</th></tr><tr><td colspan="2" class="confluenceTd">Name</td><td class="confluenceTd">MistralAIAPI</td></tr><tr><td colspan="2" class="confluenceTd">Version</td><td colspan="1" class="confluenceTd">0.0.2</td></tr><tr><td colspan="2" class="confluenceTd">Context</td><td class="confluenceTd"><div class="content-wrapper"><p><code>mistralaiapi</code></p><div><div class="confluence-information-macro-body"><p>The API context is used by the Gateway to identify the API. Therefore, the API context must be unique. This context is the API's root context when invoking the API through the Gateway.</p></div><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>You can define the API's version as a parameter of its context by adding the <code>{version}</code> into the context. For example, <code>{version}/mistralaiapi</code>. The API Manager assigns the actual version of the API to the <code>{version}</code> parameter internally. For example, <code>https://localhost:8243/0.0.2/mistralaiapi</code>. Note that the version appears before the context, allowing you to group your APIs based on the versions.</p></div></div></div></div></td></tr><tr><td colspan="2" class="confluenceTd">Endpoint</td><td colspan="1" class="confluenceTd"><p><a class="external-link" href="https://api.mistral.ai" rel="nofollow">https://api.mistral.ai</a></p><p>The endpoint of the AI service vendor is automatically added as the production and sandbox endpoints.</p></td></tr></tbody></table>
<table><colgroup> <col/> <col/> <col/> </colgroup><tbody><tr><th colspan="2" >Field</th><th >Sample value</th></tr><tr><td colspan="2" class="confluenceTd">Name</td><td class="confluenceTd">MistralAIAPI</td></tr><tr><td colspan="2" class="confluenceTd">Version</td><td colspan="1" class="confluenceTd">0.0.2</td></tr><tr><td colspan="2" class="confluenceTd">Context</td><td class="confluenceTd"><div class="content-wrapper"><p><code>mistralaiapi</code></p><div><div class="confluence-information-macro-body"><p>The API context is used by the Gateway to identify the API. Therefore, the API context must be unique. This context is the API's root context when invoking the API through the Gateway.</p></div><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>You can define the API's version as a parameter of its context by adding the <code>{version}</code> into the context. For example, <code>{version}/mistralaiapi</code>. The API Manager assigns the actual version of the API to the <code>{version}</code> parameter internally. For example, <code>https://localhost:8243/0.0.2/mistralaiapi</code>. Note that the version appears before the context, allowing you to group your APIs based on the versions.</p></div></div></div></div></td></tr><tr><td colspan="2" class="confluenceTd">Endpoint</td><td colspan="1" class="confluenceTd"><p><code>https://api.mistral.ai</code></p><p>The endpoint of the AI service vendor is automatically added as the production and sandbox endpoints.</p></td></tr></tbody></table>

5. Click **Create** to create the API.

Expand Down
2 changes: 1 addition & 1 deletion en/docs/design/endpoints/resiliency/endpoint-timeouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The following are Advanced Endpoint Configurations that you can configure for bo
<p>If you want to configure the suspension of an endpoint, you can use the <b>Endpoint Suspension State</b> section to define the error codes, maximum suspension time, and suspension factors.</p>
<ul><li>
<p><strong>Error Codes:</strong> The error codes that are associated with suspended endpoints. If the backend endpoint receives the selected error codes, the endpoint will be marked as
suspended. Specify the <a href="({{base_path}}/troubleshooting/error-handling/#transport-error-codes">transport error codes</a> to define when the endpoint suspension should be triggered. You can select a single error code or multiple error codes.</p>
suspended. Specify the <a href="{{base_path}}/troubleshooting/error-handling/#transport-error-codes">transport error codes</a> to define when the endpoint suspension should be triggered. You can select a single error code or multiple error codes.</p>
</li><li>
<p><strong>Initial duration:</strong> The time duration for which the endpoint will be suspended when one or more suspend error codes are received from the endpoint for the first time.</p>
<div class="admonition note">
Expand Down
2 changes: 1 addition & 1 deletion en/docs/includes/design/create-graphql-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Let's use the Star Wars sample backend server as the backend for the GraphQL API
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul><li>
<p>You need to define the SDL Schema based on the [GraphQL schema design best practices](https://leapgraph.com/graphql-schema-design-best-practices).</p></li>
<p>You need to define the SDL Schema based on the [GraphQL schema design best practices](https://graphql.org/learn/best-practices).</p></li>
<li>The file extension can be either `.graphql`, `.txt`, or `.json`. </li><li> The file name can be any name, which is based on your preference.</li></ul>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ First, you need to generate a certificate signing request (CSR) for your keysto
2. You must provide this CSR file to the CA. For testing purposes, try the [90 days trial SSL certificate from Comodo](https://www.comodo.com/e-commerce/ssl-certificates/free-ssl-certificate.php) .
!!! Note
It is preferable to have a wildcard certificate or multiple domain certificates if you wish to have multiple subdomains like *[gateway.sampledomain.org](http://gateway.sampledomain.org/)* , *[publisher.sampledomain.org](http://publisher.sampledomain.org/)* , *[identity.sampledomain.org](http://identity.sampledomain.org/)* , etc., for the deployment. For such requirements, you must modify the CSR request by adding subject alternative names. Most of the SSL providers give instructions to generate the CSR in such cases.
It is preferable to have a wildcard certificate or multiple domain certificates if you wish to have multiple subdomains like <code>gateway.sampledomain.org</code> , <code>publisher.sampledomain.org</code> , <code>identity.sampledomain.org</code> , etc., for the deployment. For such requirements, you must modify the CSR request by adding subject alternative names. Most of the SSL providers give instructions to generate the CSR in such cases.
3. After accepting the request, a signed certificate is provided along with a root certificate and several intermediate certificates (depending on the CA) as a bundle (.zip file).
Expand Down

0 comments on commit a345142

Please sign in to comment.