diff --git a/en/docs/design/api-documentation/add-api-documentation.md b/en/docs/design/api-documentation/add-api-documentation.md index 91f0c19b3c..ddf3d7ea75 100644 --- a/en/docs/design/api-documentation/add-api-documentation.md +++ b/en/docs/design/api-documentation/add-api-documentation.md @@ -91,7 +91,7 @@ Follow the instructions below to add documentation to an API:
http://www.dummyforum.com
Field | Sample value | |
---|---|---|
Name | MistralAIAPI | |
Version | 0.0.2 | |
Context |
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. You can define the API's version as a parameter of its context by adding the | |
Endpoint | The endpoint of the AI service vendor is automatically added as the production and sandbox endpoints. |
Field | Sample value | |
---|---|---|
Name | MistralAIAPI | |
Version | 0.0.2 | |
Context |
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. You can define the API's version as a parameter of its context by adding the | |
Endpoint |
The endpoint of the AI service vendor is automatically added as the production and sandbox endpoints. |
If you want to configure the suspension of an endpoint, you can use the Endpoint Suspension State section to define the error codes, maximum suspension time, and suspension factors.
Error Codes: 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 transport error codes to define when the endpoint suspension should be triggered. You can select a single error code or multiple error codes.
+ suspended. Specify the transport error codes to define when the endpoint suspension should be triggered. You can select a single error code or multiple error codes.Initial duration: 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.
Note
You need to define the SDL Schema based on the [GraphQL schema design best practices](https://leapgraph.com/graphql-schema-design-best-practices).
You need to define the SDL Schema based on the [GraphQL schema design best practices](https://graphql.org/learn/best-practices).
gateway.sampledomain.org
, publisher.sampledomain.org
, 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.
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).