diff --git a/en/docs/api-analytics/analytics-overview.md b/en/docs/api-analytics/analytics-overview.md new file mode 100644 index 0000000000..4e4d28b640 --- /dev/null +++ b/en/docs/api-analytics/analytics-overview.md @@ -0,0 +1,33 @@ +# API Manager Analytics + +API Manager analytics provides insights into the API usage, performance, and other key metrics to help API publishers and consumers make informed decisions. The analytics dashboard provides a comprehensive view of the API traffic, user engagement, and other relevant data. This section provides an overview of the analytics features available in WSO2 API Manager and guidance on how to use them effectively. + +## Architecture + + +

+ + +Analytics architecture consists with the following components + +- **Inbound Analytics** +- **Outbound Analytics** + - **AI Analytics** + +### Inbound Analytics + +As above diagram shows, Inbound Analytics consists with analytics data that are collected between the user and API Proxy. This includes apiContext, proxyResponseCode, proxyResponseCode, apiType etc. + +### Outbound Analytics + +Outbound Analytics consists with analytics data that are collected between the API Proxy and the backend service. This includes targetResponseCode, backendLatency, destination etc. + +### AI Analytics + +AI Analytics shows the Outbound analytics data that are specific to AI APIs. This includes aiTokenUsage, vendorName, vendorVersion, model, promptTokens, completionTokens and totalTokens. + +WSO2 API Manager supports multiple platforms to monitor and analyze API traffic. This includes: + +- [**Choreo Analytics**](choreo-analytics/api-analytics-architecture.md) - A SaaS based API analytics platform that provides real-time insights into API traffic, performance, and user engagement. +- [**ELK Base Analytics Solution**](on-prem/elk-installation-guide.md) - Native support for Elasticsearch, Logstash, and Kibana (ELK) stack to monitor and analyze API traffic. +- [**DataDog Based Analytics Solution**](on-prem/datadog-installation-guide.md) - Integration with DataDog to monitor and analyze API traffic. \ No newline at end of file diff --git a/en/docs/assets/img/analytics/analytics-architecture.png b/en/docs/assets/img/analytics/analytics-architecture.png new file mode 100644 index 0000000000..40b031af44 Binary files /dev/null and b/en/docs/assets/img/analytics/analytics-architecture.png differ diff --git a/en/docs/design/api-policies/regular-gateway-policies/adding-dynamic-endpoints.md b/en/docs/design/api-policies/regular-gateway-policies/adding-dynamic-endpoints.md index 3b8a19b4fa..50ca09f0af 100644 --- a/en/docs/design/api-policies/regular-gateway-policies/adding-dynamic-endpoints.md +++ b/en/docs/design/api-policies/regular-gateway-policies/adding-dynamic-endpoints.md @@ -1,6 +1,6 @@ # Adding Dynamic Endpoints -You cannot dynamically construct the back-end endpoint of an API using the address endpoints in the WSO2 API Manager. To achieve the requirement of a dynamic endpoint, you can use the default endpoint instead. +In WSO2 API Manager, while address endpoints are static, you can achieve dynamic backend endpoint functionality effortlessly by using the default endpoint. [![Dynamic Endpoints]({{base_path}}/assets/img/learn/api-gateway/message-mediation/dynamic-endpoints.png)]({{base_path}}/assets/img/learn/api-gateway/message-mediation/dynamic-endpoints.png) diff --git a/en/mkdocs.yml b/en/mkdocs.yml index cd9e568a50..441d3e9ef9 100644 --- a/en/mkdocs.yml +++ b/en/mkdocs.yml @@ -77,196 +77,197 @@ nav: - Architecture: get-started/apim-architecture.md - Quick Start Guide: get-started/api-manager-quick-start-guide.md - About this Release: get-started/about-this-release.md - - Design APIs: - - Design APIs Overview: design/design-api-overview.md - - Create APIs: - - REST APIs: - - Create a REST API: design/create-api/create-rest-api/create-a-rest-api.md - - Create a REST API from an OpenAPI Definition: design/create-api/create-rest-api/create-a-rest-api-from-an-openapi-definition.md - - Expose a SOAP Service as a REST API: design/create-api/create-rest-api/expose-a-soap-service-as-a-rest-api.md - - Generate REST API from SOAP Backend: design/create-api/create-rest-api/generate-rest-api-from-soap-backend.md - - Test a REST API: design/create-api/create-rest-api/test-a-rest-api.md - - GraphQL APIs: - - Create a GraphQL API: design/create-api/create-graphql-api/create-a-graphql-api.md - - Create a GraphQL API using Introspection: design/create-api/create-graphql-api/create-a-graphql-api-using-introspection.md - - Streaming APIs: - - Streaming API Overview: design/create-api/create-streaming-api/streaming-api-overview.md - - Create a WebSocket API: design/create-api/create-streaming-api/create-a-websocket-streaming-api.md - - Create a WebSub/WebHook API: design/create-api/create-streaming-api/create-a-websub-streaming-api.md - - Create a SSE API: design/create-api/create-streaming-api/create-a-sse-streaming-api.md - - Create a Streaming API from an AsyncAPI Definition: design/create-api/create-streaming-api/create-a-streaming-api-from-an-asyncapi-definition.md - - Test a WebSub/WebHook API: design/create-api/create-streaming-api.md - - Create an API Using a Service: design/create-api/create-an-api-using-a-service.md - #- Build APIs in Integration Studio: design/create-api/api-integration-studio.md - - AI APIs: design/create-api/create-ai-api/create-an-ai-api.md - - Create APIs with AI: design/create-api/create-api-with-ai.md - - Create API Revisions: design/create-api/create-api-revisions.md - - Add Custom Properties to APIs: design/create-api/adding-custom-properties-to-apis.md - - Change the Thumbnail of an API: design/create-api/change-api-thumbnail.md - - Create Prototype APIs: - - Overview: design/prototype-api/overview.md - - Mock Implementation: - - With API Gateway: design/prototype-api/create-mocked-js-api.md - - Existing Backend Implementation as a Prototype API: design/prototype-api/backend-url-prototype-api.md - - Create API Products: - - API Product Overview: design/create-api-product/api-product-overview.md - - Create an API Product: design/create-api-product/create-api-product.md - - Endpoints: - - Endpoint Types: design/endpoints/endpoint-types.md - - Security: - - Secure Endpoint with Basic Auth: design/endpoints/endpoint-security/basic-auth.md - - Secure Endpoint with Digest Auth: design/endpoints/endpoint-security/digest-auth.md - - Secure Endpoint with OAuth 2.0: design/endpoints/endpoint-security/oauth-2.0.md - - High Availability for Endpoints: design/endpoints/high-availability-for-endpoints.md - - Resiliency: - - Endpoint Timeouts: design/endpoints/resiliency/endpoint-timeouts.md - - Endpoint Suspension: design/endpoints/resiliency/endpoint-suspension.md - - Prevent API Suspension: design/endpoints/resiliency/prevent-api-suspension.md - - Manage Certificates: design/endpoints/certificates.md - - Lifecycle Managament: - - API Lifecycle: design/lifecycle-management/api-lifecycle.md - - Customize API Life Cycle: design/lifecycle-management/customize-api-life-cycle.md - - API Versioning: - - Create a New API Version: design/api-versioning/create-a-new-api-version.md - - Deprecate the Old Version: design/api-versioning/deprecate-the-old-version.md - - Backward Compatibility: design/api-versioning/backward-compatibility.md - - Enable Notifications: design/api-versioning/enabling-notifications.md - - API Documentation: - - Add API Documentation: design/api-documentation/add-api-documentation.md - - View Generated Documentation : design/api-documentation/view-generated-documentation.md - - API Collaboration: - - Comment on an API via the Publisher: design/api-collaborations/comment-on-an-api-via-the-publisher.md - - Enable Social Media Interaction: design/api-collaborations/enable-social-media-interaction.md - - API Policies: - - Overview: design/api-policies/overview.md - - Attach Policies: design/api-policies/attach-policy.md - - Create a Policy: design/api-policies/create-policy.md - - Regular Gateway Policies: - - Add Dynamic Endpoints: design/api-policies/regular-gateway-policies/adding-dynamic-endpoints.md - - Remove Specific Request Headers From Response: design/api-policies/regular-gateway-policies/removing-specific-request-headers-from-response.md - - Pass a Custom Authorization Token to the Backend: design/api-policies/regular-gateway-policies/passing-a-custom-authorization-token-to-the-backend.md - - URL Mapping: design/api-policies/regular-gateway-policies/mapping-the-parameters-of-your-backend-urls-with-the-api-publisher-urls.md - - Disable Message Chunking: design/api-policies/regular-gateway-policies/disabling-message-chunking.md - - Transform API Message Payload: design/api-policies/regular-gateway-policies/transforming-api-message-payload.md - - Add a Non-Blocking Send Operation: design/api-policies/regular-gateway-policies/adding-a-non-blocking-send-operation.md - - Add a Class Mediator: design/api-policies/regular-gateway-policies/adding-a-class-mediator.md - - Configure Message Builders and Formatters: design/api-policies/regular-gateway-policies/configuring-message-builders-formatters.md - - JWT claim based access validator: design/api-policies/regular-gateway-policies/jwt-claim-based-access-validator.md - - Revoke One Time Tokens Policy: design/api-policies/regular-gateway-policies/revoke-one-time-tokens-policy.md - - AI Policies: design/api-policies/regular-gateway-policies/ai-policies.md - - API Security: - - Authentication: - - Overview: design/api-security/api-authentication/api-authentication-overview.md - - Secure APIs using OAuth2 Access Tokens: design/api-security/api-authentication/secure-apis-using-oauth2-tokens.md - - Secure APIs using API Keys: design/api-security/api-authentication/secure-apis-using-api-keys.md - - Secure APIs using Mutual SSL: design/api-security/api-authentication/secure-apis-using-mutual-ssl.md - - Secure APIs using Basic Authentication: design/api-security/api-authentication/secure-apis-using-basic-authentication.md - - Secure APIs using Certificate Bound Access Token: design/api-security/api-authentication/securing-apis-using-certificate-bound-access-tokens.md - - Federating OAuth Applications: design/api-security/api-authentication/advanced-topics/federating-oauth-applications.md - - Disable Security: design/api-security/api-authentication/disable-security.md - - Authorization: - - Overview: design/api-security/authorization/api-authorization.md - - Role-Based Access Control using Scopes: design/api-security/oauth2/oauth2-scopes/fine-grained-access-control-with-oauth-scopes.md - - Role-Based Access Control using XACML: design/api-security/authorization/role-based-access-control-using-xacml.md - - Publisher Portal in Read Only Mode: design/api-security/authorization/publisher-portal-in-read-only-mode.md - - Secure APIs by Auditing API Definitions: design/api-security/configuring-api-security-audit.md - - Request-Response Schema Validation: - - JSON Schema Validator: design/api-security/api-request-response-schema-validation/json-schema-validator.md - - OAuth2: - - Token types: - - JWT Access Tokens: design/api-security/oauth2/access-token-types/jwt-tokens.md - - OAuth2 Scopes: - - Role-Based Access Control with OAuth Scopes: design/api-security/oauth2/oauth2-scopes/fine-grained-access-control-with-oauth-scopes.md - - Scope Whitelisting: design/api-security/oauth2/oauth2-scopes/scope-whitelisting.md - - Grant Types: - - Overview: design/api-security/oauth2/grant-types/overview.md - - Password Grant: design/api-security/oauth2/grant-types/password-grant.md - - Client Credentials Grant: design/api-security/oauth2/grant-types/client-credentials-grant.md - - Authorization Code Grant: design/api-security/oauth2/grant-types/authorization-code-grant.md - - Refresh Token Grant: design/api-security/oauth2/grant-types/refresh-token-grant.md - - JWT Grant: design/api-security/oauth2/grant-types/jwt-grant.md - - SAML Extension Grant: design/api-security/oauth2/grant-types/saml-extension-grant.md - - Kerberos OAuth2 Grant: design/api-security/oauth2/grant-types/kerberos-oauth2-grant.md - - NTLM Grant: design/api-security/oauth2/grant-types/ntlm-grant.md - - Token Revocation: design/api-security/oauth2/token-revocation.md - - Token Expiration: design/api-security/oauth2/token-expiration.md - - Token Persistence: design/api-security/oauth2/token-persistence.md - - Encrypting OAuth2 Tokens: design/api-security/oauth2/encrypting-oauth2-tokens.md - - Hashing OAuth Keys: design/api-security/oauth2/hashing-oauth-keys.md - - Multiple Active Access Tokens: design/api-security/oauth2/multiple-active-access-tokens.md - - Provisioning Out-of-Band OAuth Clients: design/api-security/oauth2/provisioning-out-of-band-oauth-clients.md - - Securing OAuth Token with HMAC Validation: design/api-security/oauth2/securing-oauth-token-with-hmac-validation.md - - Threat Protection: - - Bot Detection: design/api-security/threat-protection/bot-detection.md - - Gateway Threat Protectors: design/api-security/threat-protection/gateway-threat-protectors/gateway-threat-protectors-for-api-manager.md - - Regular Expression Threat Protection: deploy-and-publish/deploy-on-gateway/api-gateway/threat-protectors/regular-expression-threat-protection-for-api-gateway.md - - JSON Threat Protection: deploy-and-publish/deploy-on-gateway/api-gateway/threat-protectors/json-threat-protection-for-api-gateway.md - - XML Threat Protection: deploy-and-publish/deploy-on-gateway/api-gateway/threat-protectors/xml-threat-protection-for-api-gateway.md - - OpenID Connect: - - Obtain User Profile Information with OpenID Connect: design/api-security/openid-connect/obtaining-user-profile-information-with-openid-connect.md - - Open Policy Agent (OPA) Validation: - - Overview: design/api-security/opa-validation/overview.md - - Custom OPA Policy for Regualr Gateway: design/api-security/opa-validation/custom-opa-policy-for-regular-gateway.md - - Rate Limiting: - - Throttling Use-Cases: design/rate-limiting/introducing-throttling-use-cases.md - - Add New Throttling Policies: design/rate-limiting/adding-new-throttling-policies.md - - Set Throttling Limits: design/rate-limiting/setting-throttling-limits.md - - Reset Application Throttling Policies: design/rate-limiting/resetting-application-throttling-policies.md - - Access Control: design/rate-limiting/access-control.md - - Enforce Throttling and Resource Access Policies: design/rate-limiting/enforce-throttling-and-resource-access-policies.md - - Set Maximum Backend Throughput Limits: design/rate-limiting/setting-maximum-backend-throughput-limits.md - - Rate Limiting for Streaming APIs: design/rate-limiting/rate-limiting-for-streaming-apis.md - - Rate Limiting for AI APIs: design/rate-limiting/rate-limiting-for-ai-apis.md - - Query Limits for GraphQL: - - Overview: design/rate-limiting/graphql-api/overview-query-limits-for-graphql.md - - Query Depth Limit: design/rate-limiting/graphql-api/query-depth-limitation.md - - Query Complexity Limit: design/rate-limiting/graphql-api/query-complexity-limitation.md - - Advanced Topics: - - Custom Rate Limiting: design/rate-limiting/advanced-topics/custom-throttling.md - - Distributed Burst Control, Backend Rate Limiting for API Gateway Cluster: design/rate-limiting/advanced-topics/configuring-rate-limiting-api-gateway-cluster.md - - API Monetization: - - Monetize an API: design/api-monetization/monetizing-an-api.md - - B2B API Management: - - B2B API Consumption: design/b2b-api-management/api-consumption.md - - Setup WSO2 Identity Server as a Federated Authenticator: design/b2b-api-management/setup-identity-server.md - - Advanced Topics: - - Enable Publisher Access Control: design/advanced-topics/enable-publisher-access-control-in-api-publisher-portal.md - - Control API Visibility and Subscription Availability in the Developer Portal: design/advanced-topics/control-api-visibility-and-subscription-availability-in-developer-portal.md - - Enable CORS for APIs: design/advanced-topics/enabling-cors-for-apis.md - - Add an API State Change Workflow: design/advanced-topics/adding-an-api-state-change-workflow.md - - Block Subscription to an API: design/advanced-topics/block-subscription-to-an-api.md - - Disable Subscription Requirement for an API: design/advanced-topics/disable-subscriptions-for-an-api.md - - Validate API Definitions with Linters: design/advanced-topics/validate-api-definitions-with-linters.md - - API Governance CLI Tool: design/advanced-topics/api-governance-cli-tool.md - - Deploy and Publish APIs: - - Deploy on Gateway: - - Deploy API: - - Deploy an API: deploy-and-publish/deploy-on-gateway/deploy-api/deploy-an-api.md - - Expose APIs via Custom Hostnames: deploy-and-publish/deploy-on-gateway/deploy-api/exposing-apis-via-custom-hostnames.md - - Deploy Through Multiple API Gateways: deploy-and-publish/deploy-on-gateway/deploy-api/deploy-through-multiple-api-gateways.md - - Revision Deployment Workflow: deploy-and-publish/deploy-on-gateway/deploy-api/revision-deployment-workflow.md - - API Gateway: - - Overview of the WSO2 API Gateway: deploy-and-publish/deploy-on-gateway/api-gateway/overview-of-the-api-gateway.md - - Gateway Policies: deploy-and-publish/deploy-on-gateway/api-gateway/gateway-policies.md - - Response Caching: deploy-and-publish/deploy-on-gateway/api-gateway/response-caching.md - - Threat Protectors: + - Manage APIs: + - Design APIs: + - Design APIs Overview: design/design-api-overview.md + - Create APIs: + - REST APIs: + - Create a REST API: design/create-api/create-rest-api/create-a-rest-api.md + - Create a REST API from an OpenAPI Definition: design/create-api/create-rest-api/create-a-rest-api-from-an-openapi-definition.md + - Expose a SOAP Service as a REST API: design/create-api/create-rest-api/expose-a-soap-service-as-a-rest-api.md + - Generate REST API from SOAP Backend: design/create-api/create-rest-api/generate-rest-api-from-soap-backend.md + - Test a REST API: design/create-api/create-rest-api/test-a-rest-api.md + - GraphQL APIs: + - Create a GraphQL API: design/create-api/create-graphql-api/create-a-graphql-api.md + - Create a GraphQL API using Introspection: design/create-api/create-graphql-api/create-a-graphql-api-using-introspection.md + - Streaming APIs: + - Streaming API Overview: design/create-api/create-streaming-api/streaming-api-overview.md + - Create a WebSocket API: design/create-api/create-streaming-api/create-a-websocket-streaming-api.md + - Create a WebSub/WebHook API: design/create-api/create-streaming-api/create-a-websub-streaming-api.md + - Create a SSE API: design/create-api/create-streaming-api/create-a-sse-streaming-api.md + - Create a Streaming API from an AsyncAPI Definition: design/create-api/create-streaming-api/create-a-streaming-api-from-an-asyncapi-definition.md + - Test a WebSub/WebHook API: design/create-api/create-streaming-api.md + - Create an API Using a Service: design/create-api/create-an-api-using-a-service.md + #- Build APIs in Integration Studio: design/create-api/api-integration-studio.md + - AI APIs: design/create-api/create-ai-api/create-an-ai-api.md + - Create APIs with AI: design/create-api/create-api-with-ai.md + - Create API Revisions: design/create-api/create-api-revisions.md + - Add Custom Properties to APIs: design/create-api/adding-custom-properties-to-apis.md + - Change the Thumbnail of an API: design/create-api/change-api-thumbnail.md + - Create Prototype APIs: + - Overview: design/prototype-api/overview.md + - Mock Implementation: + - With API Gateway: design/prototype-api/create-mocked-js-api.md + - Existing Backend Implementation as a Prototype API: design/prototype-api/backend-url-prototype-api.md + - Create API Products: + - API Product Overview: design/create-api-product/api-product-overview.md + - Create an API Product: design/create-api-product/create-api-product.md + - Endpoints: + - Endpoint Types: design/endpoints/endpoint-types.md + - Security: + - Secure Endpoint with Basic Auth: design/endpoints/endpoint-security/basic-auth.md + - Secure Endpoint with Digest Auth: design/endpoints/endpoint-security/digest-auth.md + - Secure Endpoint with OAuth 2.0: design/endpoints/endpoint-security/oauth-2.0.md + - High Availability for Endpoints: design/endpoints/high-availability-for-endpoints.md + - Resiliency: + - Endpoint Timeouts: design/endpoints/resiliency/endpoint-timeouts.md + - Endpoint Suspension: design/endpoints/resiliency/endpoint-suspension.md + - Prevent API Suspension: design/endpoints/resiliency/prevent-api-suspension.md + - Manage Certificates: design/endpoints/certificates.md + - Lifecycle Managament: + - API Lifecycle: design/lifecycle-management/api-lifecycle.md + - Customize API Life Cycle: design/lifecycle-management/customize-api-life-cycle.md + - API Versioning: + - Create a New API Version: design/api-versioning/create-a-new-api-version.md + - Deprecate the Old Version: design/api-versioning/deprecate-the-old-version.md + - Backward Compatibility: design/api-versioning/backward-compatibility.md + - Enable Notifications: design/api-versioning/enabling-notifications.md + - API Documentation: + - Add API Documentation: design/api-documentation/add-api-documentation.md + - View Generated Documentation : design/api-documentation/view-generated-documentation.md + - API Collaboration: + - Comment on an API via the Publisher: design/api-collaborations/comment-on-an-api-via-the-publisher.md + - Enable Social Media Interaction: design/api-collaborations/enable-social-media-interaction.md + - API Policies: + - Overview: design/api-policies/overview.md + - Attach Policies: design/api-policies/attach-policy.md + - Create a Policy: design/api-policies/create-policy.md + - Regular Gateway Policies: + - Add Dynamic Endpoints: design/api-policies/regular-gateway-policies/adding-dynamic-endpoints.md + - Remove Specific Request Headers From Response: design/api-policies/regular-gateway-policies/removing-specific-request-headers-from-response.md + - Pass a Custom Authorization Token to the Backend: design/api-policies/regular-gateway-policies/passing-a-custom-authorization-token-to-the-backend.md + - URL Mapping: design/api-policies/regular-gateway-policies/mapping-the-parameters-of-your-backend-urls-with-the-api-publisher-urls.md + - Disable Message Chunking: design/api-policies/regular-gateway-policies/disabling-message-chunking.md + - Transform API Message Payload: design/api-policies/regular-gateway-policies/transforming-api-message-payload.md + - Add a Non-Blocking Send Operation: design/api-policies/regular-gateway-policies/adding-a-non-blocking-send-operation.md + - Add a Class Mediator: design/api-policies/regular-gateway-policies/adding-a-class-mediator.md + - Configure Message Builders and Formatters: design/api-policies/regular-gateway-policies/configuring-message-builders-formatters.md + - JWT claim based access validator: design/api-policies/regular-gateway-policies/jwt-claim-based-access-validator.md + - Revoke One Time Tokens Policy: design/api-policies/regular-gateway-policies/revoke-one-time-tokens-policy.md + - AI Policies: design/api-policies/regular-gateway-policies/ai-policies.md + - API Security: + - Authentication: + - Overview: design/api-security/api-authentication/api-authentication-overview.md + - Secure APIs using OAuth2 Access Tokens: design/api-security/api-authentication/secure-apis-using-oauth2-tokens.md + - Secure APIs using API Keys: design/api-security/api-authentication/secure-apis-using-api-keys.md + - Secure APIs using Mutual SSL: design/api-security/api-authentication/secure-apis-using-mutual-ssl.md + - Secure APIs using Basic Authentication: design/api-security/api-authentication/secure-apis-using-basic-authentication.md + - Secure APIs using Certificate Bound Access Token: design/api-security/api-authentication/securing-apis-using-certificate-bound-access-tokens.md + - Federating OAuth Applications: design/api-security/api-authentication/advanced-topics/federating-oauth-applications.md + - Disable Security: design/api-security/api-authentication/disable-security.md + - Authorization: + - Overview: design/api-security/authorization/api-authorization.md + - Role-Based Access Control using Scopes: design/api-security/oauth2/oauth2-scopes/fine-grained-access-control-with-oauth-scopes.md + - Role-Based Access Control using XACML: design/api-security/authorization/role-based-access-control-using-xacml.md + - Publisher Portal in Read Only Mode: design/api-security/authorization/publisher-portal-in-read-only-mode.md + - Secure APIs by Auditing API Definitions: design/api-security/configuring-api-security-audit.md + - Request-Response Schema Validation: + - JSON Schema Validator: design/api-security/api-request-response-schema-validation/json-schema-validator.md + - OAuth2: + - Token types: + - JWT Access Tokens: design/api-security/oauth2/access-token-types/jwt-tokens.md + - OAuth2 Scopes: + - Role-Based Access Control with OAuth Scopes: design/api-security/oauth2/oauth2-scopes/fine-grained-access-control-with-oauth-scopes.md + - Scope Whitelisting: design/api-security/oauth2/oauth2-scopes/scope-whitelisting.md + - Grant Types: + - Overview: design/api-security/oauth2/grant-types/overview.md + - Password Grant: design/api-security/oauth2/grant-types/password-grant.md + - Client Credentials Grant: design/api-security/oauth2/grant-types/client-credentials-grant.md + - Authorization Code Grant: design/api-security/oauth2/grant-types/authorization-code-grant.md + - Refresh Token Grant: design/api-security/oauth2/grant-types/refresh-token-grant.md + - JWT Grant: design/api-security/oauth2/grant-types/jwt-grant.md + - SAML Extension Grant: design/api-security/oauth2/grant-types/saml-extension-grant.md + - Kerberos OAuth2 Grant: design/api-security/oauth2/grant-types/kerberos-oauth2-grant.md + - NTLM Grant: design/api-security/oauth2/grant-types/ntlm-grant.md + - Token Revocation: design/api-security/oauth2/token-revocation.md + - Token Expiration: design/api-security/oauth2/token-expiration.md + - Token Persistence: design/api-security/oauth2/token-persistence.md + - Encrypting OAuth2 Tokens: design/api-security/oauth2/encrypting-oauth2-tokens.md + - Hashing OAuth Keys: design/api-security/oauth2/hashing-oauth-keys.md + - Multiple Active Access Tokens: design/api-security/oauth2/multiple-active-access-tokens.md + - Provisioning Out-of-Band OAuth Clients: design/api-security/oauth2/provisioning-out-of-band-oauth-clients.md + - Securing OAuth Token with HMAC Validation: design/api-security/oauth2/securing-oauth-token-with-hmac-validation.md + - Threat Protection: + - Bot Detection: design/api-security/threat-protection/bot-detection.md + - Gateway Threat Protectors: design/api-security/threat-protection/gateway-threat-protectors/gateway-threat-protectors-for-api-manager.md - Regular Expression Threat Protection: deploy-and-publish/deploy-on-gateway/api-gateway/threat-protectors/regular-expression-threat-protection-for-api-gateway.md - JSON Threat Protection: deploy-and-publish/deploy-on-gateway/api-gateway/threat-protectors/json-threat-protection-for-api-gateway.md - XML Threat Protection: deploy-and-publish/deploy-on-gateway/api-gateway/threat-protectors/xml-threat-protection-for-api-gateway.md - - Pass End User Attributes to the Backend: deploy-and-publish/deploy-on-gateway/api-gateway/passing-enduser-attributes-to-the-backend-via-api-gateway.md - - Gateway Environments: deploy-and-publish/deploy-on-gateway/api-gateway/maintaining-separate-production-and-sandbox-gateways.md - - Scale the Gateway: deploy-and-publish/deploy-on-gateway/api-gateway/scaling-the-gateway.md - - Advanced Topics: - - API Gateways with Dedicated Backends: deploy-and-publish/deploy-on-gateway/api-gateway/api-gateways-with-dedicated-backends.md - - Mutual SSL Between API Gateway and Backend: deploy-and-publish/deploy-on-gateway/api-gateway/mutual-ssl-between-api-gateway-and-backend.md - - Storing Custom Synapse Artifacts in the Gateway: deploy-and-publish/deploy-on-gateway/api-gateway/custom-synapse-artifacts.md - - Federated Gateways: - - Deploy on AWS API Gateway: deploy-and-publish/deploy-on-gateway/federated-gateways/deploy-on-aws-api-gateway.md - - Publish on Developer Portal: - - Publish an API: deploy-and-publish/publish-on-dev-portal/publish-an-api.md - - Add a Third-party API: deploy-and-publish/publish-on-dev-portal/third-party-api-support.md - - Publish to Multiple External API Developer Portals: deploy-and-publish/publish-on-dev-portal/publish-to-multiple-external-api-stores.md - - Import APIs From AWS API-Gateway to WSO2 API-M: deploy-and-publish/publish-on-dev-portal/publish-aws-apis-in-the-dev-portal.md + - OpenID Connect: + - Obtain User Profile Information with OpenID Connect: design/api-security/openid-connect/obtaining-user-profile-information-with-openid-connect.md + - Open Policy Agent (OPA) Validation: + - Overview: design/api-security/opa-validation/overview.md + - Custom OPA Policy for Regualr Gateway: design/api-security/opa-validation/custom-opa-policy-for-regular-gateway.md + - Rate Limiting: + - Throttling Use-Cases: design/rate-limiting/introducing-throttling-use-cases.md + - Add New Throttling Policies: design/rate-limiting/adding-new-throttling-policies.md + - Set Throttling Limits: design/rate-limiting/setting-throttling-limits.md + - Reset Application Throttling Policies: design/rate-limiting/resetting-application-throttling-policies.md + - Access Control: design/rate-limiting/access-control.md + - Enforce Throttling and Resource Access Policies: design/rate-limiting/enforce-throttling-and-resource-access-policies.md + - Set Maximum Backend Throughput Limits: design/rate-limiting/setting-maximum-backend-throughput-limits.md + - Rate Limiting for Streaming APIs: design/rate-limiting/rate-limiting-for-streaming-apis.md + - Rate Limiting for AI APIs: design/rate-limiting/rate-limiting-for-ai-apis.md + - Query Limits for GraphQL: + - Overview: design/rate-limiting/graphql-api/overview-query-limits-for-graphql.md + - Query Depth Limit: design/rate-limiting/graphql-api/query-depth-limitation.md + - Query Complexity Limit: design/rate-limiting/graphql-api/query-complexity-limitation.md + - Advanced Topics: + - Custom Rate Limiting: design/rate-limiting/advanced-topics/custom-throttling.md + - Distributed Burst Control, Backend Rate Limiting for API Gateway Cluster: design/rate-limiting/advanced-topics/configuring-rate-limiting-api-gateway-cluster.md + - API Monetization: + - Monetize an API: design/api-monetization/monetizing-an-api.md + - B2B API Management: + - B2B API Consumption: design/b2b-api-management/api-consumption.md + - Setup WSO2 Identity Server as a Federated Authenticator: design/b2b-api-management/setup-identity-server.md + - Advanced Topics: + - Enable Publisher Access Control: design/advanced-topics/enable-publisher-access-control-in-api-publisher-portal.md + - Control API Visibility and Subscription Availability in the Developer Portal: design/advanced-topics/control-api-visibility-and-subscription-availability-in-developer-portal.md + - Enable CORS for APIs: design/advanced-topics/enabling-cors-for-apis.md + - Add an API State Change Workflow: design/advanced-topics/adding-an-api-state-change-workflow.md + - Block Subscription to an API: design/advanced-topics/block-subscription-to-an-api.md + - Disable Subscription Requirement for an API: design/advanced-topics/disable-subscriptions-for-an-api.md + - Validate API Definitions with Linters: design/advanced-topics/validate-api-definitions-with-linters.md + - API Governance CLI Tool: design/advanced-topics/api-governance-cli-tool.md + - Deploy and Publish APIs: + - Deploy on Gateway: + - Deploy API: + - Deploy an API: deploy-and-publish/deploy-on-gateway/deploy-api/deploy-an-api.md + - Expose APIs via Custom Hostnames: deploy-and-publish/deploy-on-gateway/deploy-api/exposing-apis-via-custom-hostnames.md + - Deploy Through Multiple API Gateways: deploy-and-publish/deploy-on-gateway/deploy-api/deploy-through-multiple-api-gateways.md + - Revision Deployment Workflow: deploy-and-publish/deploy-on-gateway/deploy-api/revision-deployment-workflow.md + - API Gateway: + - Overview of the WSO2 API Gateway: deploy-and-publish/deploy-on-gateway/api-gateway/overview-of-the-api-gateway.md + - Gateway Policies: deploy-and-publish/deploy-on-gateway/api-gateway/gateway-policies.md + - Response Caching: deploy-and-publish/deploy-on-gateway/api-gateway/response-caching.md + - Threat Protectors: + - Regular Expression Threat Protection: deploy-and-publish/deploy-on-gateway/api-gateway/threat-protectors/regular-expression-threat-protection-for-api-gateway.md + - JSON Threat Protection: deploy-and-publish/deploy-on-gateway/api-gateway/threat-protectors/json-threat-protection-for-api-gateway.md + - XML Threat Protection: deploy-and-publish/deploy-on-gateway/api-gateway/threat-protectors/xml-threat-protection-for-api-gateway.md + - Pass End User Attributes to the Backend: deploy-and-publish/deploy-on-gateway/api-gateway/passing-enduser-attributes-to-the-backend-via-api-gateway.md + - Gateway Environments: deploy-and-publish/deploy-on-gateway/api-gateway/maintaining-separate-production-and-sandbox-gateways.md + - Scale the Gateway: deploy-and-publish/deploy-on-gateway/api-gateway/scaling-the-gateway.md + - Advanced Topics: + - API Gateways with Dedicated Backends: deploy-and-publish/deploy-on-gateway/api-gateway/api-gateways-with-dedicated-backends.md + - Mutual SSL Between API Gateway and Backend: deploy-and-publish/deploy-on-gateway/api-gateway/mutual-ssl-between-api-gateway-and-backend.md + - Storing Custom Synapse Artifacts in the Gateway: deploy-and-publish/deploy-on-gateway/api-gateway/custom-synapse-artifacts.md + - Federated Gateways: + - Deploy on AWS API Gateway: deploy-and-publish/deploy-on-gateway/federated-gateways/deploy-on-aws-api-gateway.md + - Publish on Developer Portal: + - Publish an API: deploy-and-publish/publish-on-dev-portal/publish-an-api.md + - Add a Third-party API: deploy-and-publish/publish-on-dev-portal/third-party-api-support.md + - Publish to Multiple External API Developer Portals: deploy-and-publish/publish-on-dev-portal/publish-to-multiple-external-api-stores.md + - Import APIs From AWS API-Gateway to WSO2 API-M: deploy-and-publish/publish-on-dev-portal/publish-aws-apis-in-the-dev-portal.md - Consume APIs: - Consume APIs - Overview: consume/consume-api-overview.md - Discover APIs: @@ -329,8 +330,9 @@ nav: - How to Use: - Admin Capabilities: governance/api-governance-admin-capabilities.md - API Creator/Publisher Capabilities: governance/api-governance-api-creator-capabilities.md - - Analytics: + - Monitoring: - API Analytics: + - Overview: api-analytics/analytics-overview.md - Choreo Based Analytics: - Architecture: api-analytics/choreo-analytics/api-analytics-architecture.md - Getting Started Guide: api-analytics/choreo-analytics/getting-started-guide.md @@ -342,20 +344,20 @@ nav: - Datadog Analytics Installation Guide : api-analytics/on-prem/datadog-installation-guide.md - Publish Analytics Events to External Systems: api-analytics/samples/publishing-analytics-events-to-external-systems.md - Publish Custom Analytics Events Data: api-analytics/samples/publishing-custom-analytics-data.md - - Observe: - - Observability Overview: observe/observe-overview.md - - API Manager: - - Logs: - - Correlation Logs: observe/api-manager/monitoring-correlation-logs.md - - HTTP Access Logs: observe/api-manager/monitoring-http-access-logs.md - - Audit Logs: observe/api-manager/monitoring-audit-logs.md - - API Logs: observe/api-manager/monitoring-api-logs.md - - Websocket Logs : observe/api-manager/monitoring-websocket-logs.md - - Traces: - - OpenTracing: observe/api-manager/traces/monitoring-with-opentracing.md - - OpenTelemetry: observe/api-manager/traces/monitoring-with-opentelemetry.md - - Metrics: - - JMX-Based Monitoring: observe/api-manager/metrics/jmx-based-monitoring.md + - Observe: + - Overview: observe/observe-overview.md + - API Manager: + - Logs: + - Correlation Logs: observe/api-manager/monitoring-correlation-logs.md + - HTTP Access Logs: observe/api-manager/monitoring-http-access-logs.md + - Audit Logs: observe/api-manager/monitoring-audit-logs.md + - API Logs: observe/api-manager/monitoring-api-logs.md + - Websocket Logs: observe/api-manager/monitoring-websocket-logs.md + - Traces: + - OpenTracing: observe/api-manager/traces/monitoring-with-opentracing.md + - OpenTelemetry: observe/api-manager/traces/monitoring-with-opentelemetry.md + - Metrics: + - JMX-Based Monitoring: observe/api-manager/metrics/jmx-based-monitoring.md - Reference: - Product REST APIs: - Overview: reference/product-apis/overview.md @@ -1130,6 +1132,6 @@ extra: version: 1.2.0-1 git_tag: v1.2.0.1 site_version: 4.5.0 -# base_path: http://localhost:8000/en/latest - base_path: https://apim.docs.wso2.com/en/4.5.0 + base_path: http://localhost:8000/en/4.5.0 + # base_path: https://apim.docs.wso2.com/en/4.5.0 envoy_path: https://www.envoyproxy.io/docs/envoy/v1.24.1 \ No newline at end of file