diff --git a/developer-support/inclusive-naming-policy.mdx b/developer-support/inclusive-naming-policy.mdx deleted file mode 100644 index 0a248315..00000000 --- a/developer-support/inclusive-naming-policy.mdx +++ /dev/null @@ -1,109 +0,0 @@ ---- -title: "Inclusive Naming Policy" -sidebarTitle: "Inclusive Naming Policy" -tags: ['Inclusive Naming Initiative', 'Inclusivity', 'Inclusive'] ---- - -In June, 2024, we announced the launch of our *Inclusive Naming* project, dedicated to updating our documentation and aligning with the [Inclusive Naming Initiative (INI)](https://inclusivenaming.org). This initiative reflects our commitment to fostering an inclusive and respectful environment for our users and within our company. - -The [Inclusive Naming Initiative](https://inclusivenaming.org/) is a community-driven effort to promote and standardize the use of inclusive language in software and documentation. By adhering to their guidelines, we aim to eliminate terms that can be considered exclusionary, offensive, or insensitive and replace them with language that is respectful and welcoming to all. - -## Purpose - -Our commitment to diversity, equity, and inclusion is foundational to our values. By updating our documentation to comply with the *Inclusive Naming Initiative (INI)*, we are taking a significant step towards ensuring that our language reflects our dedication to inclusivity. This project will help us: - -- **Create a more welcoming environment**: By using inclusive language, we create a space where everyone feels valued and respected. -- **Enhance accessibility**: Clear and inclusive documentation improves accessibility for all users, regardless of their background or identity. - -## Tier 1 word list - -INI sorts terms into word lists, considering both the severity of the term and the level of scrutiny it has received. [INI Tier 1 words](https://inclusivenaming.org/word-lists/tier-1) are considered critical and are recommended to be replaced immediately. - -INI has identified that terms included in this list have one or all of the following attributes: - -- Strong social consensus within the software development community on replacements -- Are identified by the INI as high-severity terms in need of immediate replacement -- Terms where the impact of change or removal is low: for example, there is little entanglement in low-level systems or standardized language set by standards bodies -- Have passed through all the review stages in Tiers 2 and 3 - -## Phase #1: Review of Tyk Documentation for Tier 1 Words - -An initial review of the Tyk documentation was conducted in April 2024 to check which tier 1 words can be replaced, which can't, and why. - -### Findings and planning -The main findings of the review are: - -1. **Explanatory content with INI tier 1 words**: The content on these pages can be easily rephrased and is now completed. -2. **Configuration parameters containing INI tier 1 words**: - - Some *INI tier 1 words* are embedded in the code as part of the name of parameters, fields, and keywords. - - These words are sourced from Tyk products, and third-party libraries, and tooling, e.g. Redis. - - Possible actions: - - Being part of the source code, we can't simply rephrase and use a different terminology. Such change requires following a deprecation process to ensure there are no breaking changes for our users. - - For now, we can minimize their usage and rephrase the explanatory content to use inclusive words. - - -## Phase #2: Removing Tier 1 words from Tyk documentation - -In June 2024, based on the review we executed the planned changes to the content in our [documentation](https://github.com/tykTechnologies/tyk-docs/). - -### Status update -This is the update on the status of our documentation -1. **Regular explanatory content with INI tier 1 words**: Content in the documentation has been rephrased and the work is now completed. -2. **Configuration parameters containing INI tier 1 words**: These words are still in our docs, however, we minimized their usage and rephrased their explanatory content to use inclusive words. - - **Tyk products**: These words are still in our docs, however, Tyk aims to gradually replace them (in a backward-compatible way) and update the docs accordingly. - - **Third-party and dependencies**: There's nothing much we can do at the moment except wait for them to replace these parameters, however, we are committed to updating our docs once this gets done. - -For your records, the following sections highlight the existing *INI tier 1 words* in our docs, per Tyk component: - -#### Tyk Gateway - -**Config parameters** - -- [allow_master_keys](/tyk-oss-gateway/configuration#allow_master_keys) -- [analytics_storage.master_name](/tyk-oss-gateway/configuration#analytics_storagemaster_name) -- [cache_storage.master_name](/tyk-oss-gateway/configuration#cache_storagemaster_name) -- [storage.master_name](/tyk-oss-gateway/configuration#storagemaster_name) -- [slave_options](/tyk-oss-gateway/configuration#slave_options) -- [blacklisted_ips](/api-management/gateway-config-tyk-classic#ip-access-control) -- [disable_ports_whitelist](/key-concepts/tcp-proxy#allowing-specific-ports) -- [enable_ip_blacklisting](/api-management/gateway-config-tyk-classic#ip-access-control) -- [ports_whitelist](/key-concepts/tcp-proxy#allowing-specific-ports) - -
Tyk Classic API Definition
-The [Tyk Gateway OpenAPI Document](https://github.com/TykTechnologies/tyk-docs/blob/master/tyk-docs/assets/others/gateway-swagger.yml) (Tyk Gateway swagger), includes references to the following Tyk Classic API Definition parameters: - -- [version_data.versions.\{version-name\}.extended_paths.black_list](/api-management/traffic-transformation/block-list#api-definition). There is also a parameter with equivalent functionality under the `paths` object (`version_data.versions.{version_name}.paths.black_list`). -- [version_data.versions.\{version-name\}.extended_paths.white_list](/api-management/traffic-transformation/allow-list#api-definition). There is also a parameter with equivalent functionality under the `paths` object (`version_data.versions.{version_name}.paths.while_list`). - -#### Tyk Dashboard - -**Config parameters** -- [enable_master_keys](/tyk-dashboard/configuration#enable_master_keys) -- [redis_master_name](/tyk-dashboard/configuration#redis_master_name) - -**Tyk Classic API Definition** - -The [Tyk Dashboard OpenAPI Document](https://github.com/TykTechnologies/tyk-docs/blob/master/tyk-docs/assets/others/dashboard-swagger.yml) (Tyk Dashboard swagger), contains references to [the parameters from the above Tyk Classic API Definition list](#gw-classic-api-definition). - -**Dashboard UI** - -The Tyk Classic APIs *Endpoint Designer* shows configuration of [blacklist](/api-management/traffic-transformation/block-list#api-designer) and [whitelist](/api-management/traffic-transformation/allow-list#api-definition) middleware plugins. - -#### Tyk MDCB - -The following MDCB configuration parameters contain tier 1 word occurrences: -- [analytics_storage.master_name](/tyk-multi-data-centre/mdcb-configuration-options#analytics_storagemaster_name) -- [storage.master_name](/tyk-multi-data-centre/mdcb-configuration-options#storagemaster_name) - -#### Tyk Pump - -The following Tyk Pump configuration parameters contain tier 1 word occurrences: -- [analytics_storage_config.master_name](/tyk-pump/tyk-pump-configuration/tyk-pump-environment-variables#analytics_storage_configmaster_name) - -#### Third-party dependencies - -Content contains *INI Tier 1 word* occurrences due to the following external dependencies: -- Links to Tyk Component GitHub repositories with a default branch set as `master`. -- Tyk Gateway and Tyk Pump content use Redis terminology for `master` in relation to key storage and analytics. -- Tyk Classic Developer Portal provides [documentation](/tyk-developer-portal/tyk-portal-classic/keycloak-dcr) that explains how to integrate Tyk with Keycloak using the [OpenID Connect Dynamic Client Registration](https://tools.ietf.org/html/rfc7591) protocol. The example in the guide uses the Keycloak default `master` realm. -- Tyk Bitnami Helm charts use a service with a DNS name of *tyk-redis-master.tyk.svc*. diff --git a/portal/api-consumer/invite-codes.mdx b/portal/api-consumer/invite-codes.mdx deleted file mode 100644 index f7039928..00000000 --- a/portal/api-consumer/invite-codes.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "Register a User using Invite Codes" -description: "How to configure basic authentication in Tyk?" -keywords: "Authentication, Authorization, Tyk Authentication, Tyk Authorization, Secure APIs, Basic Authentication" -sidebarTitle: "Invite Codes" ---- - -## Invite Codes - -Here you’ll learn about how to create invite codes to add a new external user to the developer portal. Invite codes can be used to simplify user onboarding. Using invite codes, users will be directly assigned to a team and organization, giving them the same access rights as this team. For example you can use invite codes to: -- Run a promotional campaign like a Hackathon and give access to specific plans to the users. -- Onboard a partner company into the portal by giving them this code for anyone registering. - -## Prerequisites - -- A Tyk Enterprise portal installation -- A portal admin app login - -## Instructions - -1. From the **API Consumers > Invite Codes** menu, click **Add**. - - Invite Codes menu - Invite Codes dialog - -2. Add the form details: - - - Set your desired **Quota**. Quota is the max number of slots available for your invite code. E.g. if set 100, this code can be used by the top 100 users. - - Set an expiry date, this is the date on which the code will expire and no more users can sign up to it. - - Set state to **Active** - this means the code is activated and developers can start using it. - - Specify the team that any new users that register with this invite code will be added to. - - Invite Codes dialog - -3. **Save** the invite code. -4. Share the invite codes. When the saving changes a new Invite code was created and can be viewed in the overview table. To share the invite code, copy it and send to your developer teams/users. - - Share Invite Codes dialog - diff --git a/product-stack/tyk-enterprise-developer-portal/api-documentation/list-of-endpoints/portal-1.13.0-list-of-endpoints.mdx b/product-stack/tyk-enterprise-developer-portal/api-documentation/list-of-endpoints/portal-1.13.0-list-of-endpoints.mdx deleted file mode 100644 index bb145764..00000000 --- a/product-stack/tyk-enterprise-developer-portal/api-documentation/list-of-endpoints/portal-1.13.0-list-of-endpoints.mdx +++ /dev/null @@ -1,275 +0,0 @@ ---- -title: "List of endpoints exposed by Tyk Enterprise Developer Portal v1.13.0" -description: "Internal APIs exposed by Tyk Developer Portal" -keywords: "Tyk Developer Portal, Enterprise Portal, Endpoints, Firewall, Integration, Portal 1.13.0" -order: 3 -sidebarTitle: "Enterprise Developer Portal Admin" ---- - - - -**Tyk Enterprise Developer Portal** - -If you are interested in getting access, contact us at [support@tyk.io]() - - - -## Introduction - -In highly secure environments, it is often necessary to configure a firewall precisely and to allow only the endpoints exposed for the portal, while banning all other routes. -For this purpose, we have prepared a list of all endpoints exposed by the Tyk Enterprise Developer Portal v1.13.0. - - - -Please note that this list only refers to v1.13.0 of the portal. The list of endpoints for other version might be different. - - - - -## List of the portal endpoints - -### Admin APIs -| **Resource** | **Endpoint** | -| :------------------ | :-------------------------------------------------------------------------------------- | -| Providers | `/providers` | -| Providers | `/providers/{provider_id}` | -| Providers | `/providers/{provider_id}/synchronize` | -| Users | `/users` | -| Users | `/users/{user_id}` | -| Users | `/users/{user_id}/custom-attributes` | -| Users | `/users/{user_id}/custom-attributes/{custom-attribute_id}` | -| Organizations | `/organisations` | -| Organizations | `/organisations/{organisation_id}` | -| Teams | `/organisations/{organisation_id}/teams` | -| Teams | `/organisations/{organisation_id}/teams/{team_id}` | -| Products | `/products` | -| Products | `/products/{product_id}` | -| Product Tags | `/products/{product_id}/tags` | -| Product Tags | `/products/{product_id}/tags/{tag_name}` | -| Product Client Types | `/products/{product_id}/client_types` | -| Product Client Types | `/products/{product_id}/client_types/{client_type_id}` | -| Product Logo Image | `/products/{product_id}/logo` | -| Product Preview Image | `/products/{product_id}/preview` | -| Product Docs | `/products/{product_id}/docs` | -| Product Docs | `/products/{product_id}/docs/{doc_id}` | -| Product Docs | `/products/{product_id}/docs/reorder` | -| API Doc | `/products/{product_id}/api-details` | -| API Doc | `/products/{product_id}/api-details/{api-id}` | -| API Doc | `/products/{product_id}/api-details/{api_id}/oas` | -| Product Spec | `/products/{product_id}/spec-details` | -| Product Spec | `/products/{product_id}/spec-details/{spec-id}` | -| Product Spec | `/products/{product_id}/spec-details/{spec-id}/oas` | -| Plans | `/plans` | -| Plans | `/plans/{plan_id}` | -| Catalogues | `/catalogues` | -| Catalogues | `/catalogues/{catalogue_id}` | -| Catalogues | `/catalogues/{catalogue_id}/audiences` | -| Catalogues | `/catalogues/{catalogue_id}/audiences/{audience_id}` | -| Access Requests | `/access_requests` | -| Access Requests | `/access_requests/{access_request_id}` | -| Access Requests | `/access_requests/{access_request_id}/approve` | -| Access Requests | `/access_requests/{access_request_id}/reject` | -| Applications | `/apps` | -| Applications | `/apps/{app_id}` | -| Applications | `/apps/{app_id}/access-requests` | -| Applications | `/apps/{app_id}/access-requests/{access-request_id}` | -| Credentials | `/apps/{app_id}/access-requests/{access-request_id}/credentials` | -| Credentials | `/apps/{app_id}/access-requests/{access-request_id}/credentials/{credential_id}` | -| Credentials | `/apps/{app_id}/access-requests/{access-request_id}/credentials/{credential_id}/rotate` | -| Applications | `/apps/{app_id}/provision` | -| Custom Credentials | `/apps/{app_id}/custom_credentials` | -| Custom Credentials | `/apps/{app_id}/custom_credentials/{credential_id}` | -| Config | `/configs` | -| Pages | `/pages` | -| Pages | `/pages/{page_id}` | -| Pages | `/pages/{page_id}/content-blocks` | -| Pages | `/pages/{page_id}/content-blocks/{content-block_id}` | -| Themes | `/themes` | -| Themes | `/themes/{theme_id}` | -| Themes | `/themes/{theme_id}/activate` | -| Themes | `/themes/{theme_id}/download` | -| Themes | `/themes/upload` | -| Custom Attributes | `/extended_attributes` | -| Custom Attributes | `/extended_attributes/{extended_attribute_id}` | -| Custom Attributes | `/extended_attributes/{extended_attribute_id}/custom-attributes` | -| Custom Attributes | `/extended_attributes/{extended_attribute_id}/custom-attributes/{custom_attribute_id}` | -| Custom Attributes | `/extended_attributes/{extended_attribute_id}/default-attributes` | -| Custom Attributes | `/extended_attributes/{extended_attribute_id}/default-attributes/{default_attribute_id}` | -| OAuth2.0 Providers | `/oauth-providers` | -| OAuth2.0 Providers | `/oauth-providers/{provider_id}` | -| OAuth2.0 Providers | `/oauth-providers/{provider_id}/client-types` | -| OAuth2.0 Providers | `/oauth-providers/{provider_id}/client-types/{client_type_id}` | -| Webhooks | `/webhooks` | -| Webhooks | `/webhooks/{webhook_id}` | -| Webhooks | `/webhooks/{webhook_id}/headers` | -| Webhooks | `/webhooks/{webhook_id}/headers/{header_id}` | -| Posts | `/posts` | -| Posts | `/posts/{post_id}` | -| Posts Categories | `/posts/{post_id}/categories` | -| Posts Categories | `/posts/{post_id}/categories/{category_id}` | -| Posts Tags | `/posts/{post_id}/tags` | -| Posts Tags | `/posts/{post_id}/tags/{tag_id}` | -| Tags | `/tags` | -| Tags | `/tags/{tag_id}` | -| SSO Profiles | `/sso_profiles` | -| SSO Profiles | `/sso_profiles/{sso_profile_id}` | - -### Admin dashboard endpoints -| **Resource** | **Endpoint** | -| :------------------ | :-------------------------------------------------------------- | -| Login | `/auth/password/login` | -| Logout | `/auth/password/logout` | -| Profile | `/admin/admin_profile` | -| Profile | `/admin/admin_profile/rotate` | -| Providers | `/admin/providers` | -| Providers | `/admin/providers/new` | -| Providers | `/admin/providers/{provider_id}` | -| Providers | `/admin/providers/{provider_id}/synchronize` | -| Products | `/admin/api_products` | -| Products | `/admin/api_products/new` | -| Products | `/admin/api_products/filter` | -| Products | `/admin/api_products/apis` | -| Products | `/admin/api_products/{api_product_id}` | -| Products | `/admin/api_products/{api_product_id}/posts/{post_id}/move_up` | -| Products | `/admin/api_products/{api_product_id}/posts/{post_id}/move_down` | -| Plans | `/admin/plans` | -| Plans | `/admin/plans/new` | -| Plans | `/admin/plans/{plan_id}` | -| Catalogues | `/admin/catalogues` | -| Catalogues | `/admin/catalogues/new` | -| Catalogues | `/admin/catalogues/{catalogue_id}` | -| Product Docs | `/admin/product_docs` | -| Product Docs | `/admin/product_docs/{product_doc_id}` | -| OAuth2.0 Providers | `/admin/oauth2-0-providers` | -| OAuth2.0 Providers | `/admin/oauth2-0-providers/new` | -| OAuth2.0 Providers | `/admin/oauth2-0-providers/{oauth2.0-provider_id}` | -| OAuth2.0 Providers | `/admin/oauth2-0-providers/ping` | -| OAuth2.0 Providers | `/admin/dcr_config_templates/filter` | -| Apps | `/admin/apps` | -| Apps | `/admin/apps/new` | -| Apps | `/admin/apps/{app_id}` | -| Access Requests | `/admin/access_requests` | -| Access Requests | `/admin/access_requests/{access_request_id}` | -| Access Requests | `/admin/access_requests/{access_request_id}/approve` | -| Access Requests | `/admin/access_requests/{access_request_id}/reject` | -| Users | `/admin/users` | -| Users | `/admin/admin_users` | -| Users | `/admin/users/new` | -| Users | `/admin/admin_users/new` | -| Users | `/admin/users/{user_id}` | -| Users | `/admin/admin_users/{user_id}` | -| Users | `/admin/users/{user_id}/activate` | -| Users | `/admin/admin_users/{user_id}/activate` | -| Users | `/admin/users/{user_id}/send_invite` | -| Users | `/admin/admin_users/{user_id}/send_invite` | -| Users | `/admin/users/{user_id}/deactivate` | -| Users | `/admin/admin_users/{user_id}/deactivate` | -| Organizations | `/admin/organisations` | -| Organizations | `/admin/organisations/new` | -| Organizations | `/admin/organisations/org:{organisation_id}` | -| Teams | `/admin/teams` | -| Teams | `/admin/teams/new` | -| Teams | `/admin/teams/filter` | -| Teams | `/admin/teams/{team_id}` | -| Invite Codes | `/admin/invite_codes` | -| Invite Codes | `/admin/invite_codes/new` | -| Invite Codes | `/admin/invite_codes/{invite_code_id}` | -| Themes | `/admin/themes` | -| Themes | `/admin/themes/new` | -| Themes | `/admin/themes/{theme_name}` | -| Themes | `/admin/themes/{theme_name}/activate` | -| Themes | `/files/download` | -| Pages | `/admin/pages` | -| Pages | `/admin/pages/new` | -| Pages | `/admin/pages/{page_id}` | -| Pages | `/admin/pages/{page_id}/to_draft` | -| Menus | `/admin/menus` | -| Menus | `/admin/menus/new` | -| Menus | `/admin/menus/{menu_id}` | -| Menus | `/admin/menus/{menu_id}/menu_items/{menu_item_id}/move_up` | -| Menus | `/admin/menus/{menu_id}/menu_items/{menu_item_id}/move_down` | -| Menu Items | `/admin/menu_items` | -| Menu Items | `/admin/menu_items/new` | -| Menu Items | `/admin/menu_items/{menu_item_id}` | -| Custom Attributes | `/admin/custom_attributes` | -| Custom Attributes | `/admin/custom_attributes/{custom_attribute_id}` | -| Posts | `/admin/posts` | -| Posts | `/admin/posts/new` | -| Posts | `/admin/posts/{post_id}` | -| Categories | `/admin/categories` | -| Categories | `/admin/categories/new` | -| Categories | `/admin/categories/{category_id}` | -| Tags | `/admin/tags` | -| Tags | `/admin/tags/new` | -| Tags | `/admin/tags/{tag_id}` | -| Settings | `/admin/general` | -| About | `/admin/about` | -| About | `/admin/about/clear-cache` | -| Webhooks | `/admin/webhooks` | -| Webhooks | `/admin/webhooks/new` | -| Webhooks | `/admin/webhooks/{webhook_id}` | -| Webhooks | `/admin/webhooks/ping` | -| SSO Profiles | `/admin/sso_profiles` | -| SSO Profiles | `/admin/sso_profiles/new` | -| SSO Profiles | `/admin/sso_profiles/{sso_profile_id}` | -| SSO Profiles | `/admin/sso_profiles/raw-editor` | -| SSO Profiles | `/admin/sso_profiles/{sso_profile_id}/raw-editor` | - -### Live portal endpoints -| **Resource** | **Endpoint** | -| :----------------- | :------------------------------------------------------------- | -| Auth | `/auth/password/login` | -| Auth | `/auth/password/register` | -| Auth | `/auth/password/logout` | -| Auth | `/auth/password/new` | -| Auth | `/auth/password/edit` | -| Auth | `/auth/password/recover` | -| Auth | `/auth/password/update` | -| Auth | `/api/sso` | -| Auth | `/api/portal/developers` | -| Auth | `/api/portal/developers/ssokey/{id}` | -| Auth | `/api/portal/developers/{id}` | -| Auth | `/sso` | -| Auth | `/tib/auth/{id}/{provider}` | -| Auth | `/tib/auth/{id}/{provider}/callback` | -| Posts | `/blog` | -| Posts | `/blog/category/{category}` | -| Posts | `/blog/{year}/{month}/{day}/{path}` | -| Pages | `/about-us` | -| Pages | `/portal/catalogue-products` | -| Products | `/portal/catalogue-products/{product_name}` | -| Products | `/portal/catalogue-products/{product_name}/{api}/docs` | -| Products | `/portal/catalogue-products/{product_name}/{api}/docs/download` | -| OAS Spec Render | `/portal/catalogue-products/{product_name}/*` | -| Cart | `/portal/private/cart/provision` | -| Cart | `/portal/private/cart/remove/{catalogue_id}/{product_id}` | -| Apps | `/portal/private/dashboard` | -| Apps | `/portal/private/apps` | -| Apps | `/portal/private/apps/{app_id}` | -| Apps | `/portal/private/apps/{app_id}/cert/{cert_id}` | -| Credentials | `/portal/private/credentials` | -| Profile | `/portal/private/profile` | -| Organization Flow | `/portal/private/organisation` | -| Organization Flow | `/portal/private/users` | -| Organization Flow | `/portal/private/users/{user_id}` | -| Organization Flow | `/portal/private/users/{user_id}/edit` | -| Organization Flow | `/portal/private/users/invite` | -| Analytics | `/portal/private/analytics` | -| Analytics | `/portal/private/analytics/api/chart/overview` | -| Analytics | `/portal/private/analytics/api/chart/traffic` | -| Analytics | `/portal/private/analytics/api/chart/error` | -| Analytics | `/portal/private/analytics/api/chart/latency` | - -### Assets endpoints -| **Resource** | **Endpoint** | -| :-------------- | :------------------------------- | -| Images | `/admin/assets/images/*` | -| Images | `/assets/images/*` | -| Fonts | `/admin/assets/fonts/*` | -| Fonts | `/assets/fonts/*` | -| Javascripts | `/admin/assets/javascripts/*` | -| Javascripts | `/assets/javascripts/*` | -| Stylesheets | `/admin/assets/stylesheets/*` | -| Stylesheets | `/assets/stylesheets/*` | -| Vendors | `/assets/vendor/bootstrap/*` | -| Vendors | `/assets/vendor/jquery/*` | diff --git a/tyk-developer-portal/tyk-enterprise-developer-portal/api-consumer-portal/access-api-product.mdx b/tyk-developer-portal/tyk-enterprise-developer-portal/api-consumer-portal/access-api-product.mdx deleted file mode 100644 index 27b752d2..00000000 --- a/tyk-developer-portal/tyk-enterprise-developer-portal/api-consumer-portal/access-api-product.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "Access an API Product" -description: "How to access an api product in Tyk developer portal" -keywords: "Developer Portal, Tyk, API Consumer" -sidebarTitle: "Access an API Product" ---- - -## Introduction - -This section explains how to access API products as a registered portal developer - -**Prerequisites** - -You need to have successfully registered for a portal. - -**Step by step instructions** - -1. Login to the external developer portal -2. Go to **Catalogs** to view the available API products - - - - - Using the filter at the top, you can filter on the different created catalogs including different API Products, e.g. a custom catalog that only you and a specific team can access. - - - -3. When selecting on a product, you can click **More info** to access the product overview page. -4. On the product overview page, you can view documentation for each API included in the API product. You can also view information about which catalog the API product is part of. Each catalog may have different plans available so you need to select a catalog based on which plan you want to access. -5. Click **Add to cart**. - - - - - You can add multiple products to the cart. You can receive one set of access credentials for multiple products as long as they are part of the same cart. If you are adding two products to the cart, and they are part of different catalogs, e.g. Private and Public, you will need to go through two request flows, and you will get two different sets of credentials for each API Product. - - - -6. Add the details needed and select a subscription plan for your API Product(s) chosen. -7. Create a new app or add to an existing one. If you already have an existing app created you can access it via the drop down or select **Create a new app** to add the credentials to an existing app. -8. Click **Request access**. -9. Navigate to My apps and view the app you created. Depending if the plan requires manual approval by an admin or not, you will either see that the request is pending or you can see the approved access credentials immediately you can start using them. - - - - - When sending a query, make sure to use the Base URL outlined in the overview of the API Product. - - - diff --git a/tyk-developer-portal/tyk-portal-classic/streams.mdx b/tyk-developer-portal/tyk-portal-classic/streams.mdx deleted file mode 100644 index 42ab4c2d..00000000 --- a/tyk-developer-portal/tyk-portal-classic/streams.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "Streams" -description: "How to publish Tyk Streams APIs to your Tyk Developer Portal" -keywords: "streaming, events, event-driven architecture, event-driven architectures, kafka" -order: 12 -noindex: True -sidebarTitle: "Streams with Classic Portal" ---- - - - -**Attention:** - -You’ve reached a page related to the *Tyk Classic Portal*. If you were searching for *API documentation of the new Tyk -Developer Portal* please use the latest -[Postman collection](/product-stack/tyk-enterprise-developer-portal/api-documentation/tyk-edp-api) page. -
-
-**Future deprecation of Tyk Classic Portal** - -This product is no longer actively developed as it -has been superseded by the new [Tyk Developer Portal](/portal/overview/intro). -
-Please note that the Tyk Classic Portal now has limited support and maintenance. Please contact us at -[support@tyk.io]()if you have any questions. - - - -As of Tyk v5.7.0, you can now publish Tyk Streams APIs to the Tyk Developer Portal. - -## How To Set Up - -Simply create a [Tyk Streams API](/api-management/event-driven-apis#getting-started), create a [Policy](/api-management/gateway-config-managing-classic#create-a-security-policy-with-the-dashboard) which protects it, and then [publish it to the Developer Portal Catalog](/portal/overview/getting-started#publish-an-api-product). \ No newline at end of file diff --git a/tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/manage-apps-credentials.mdx b/tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/manage-apps-credentials.mdx deleted file mode 100644 index 671688ca..00000000 --- a/tyk-stack/tyk-developer-portal/enterprise-developer-portal/api-access/manage-apps-credentials.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "Manage Applications in Developer Portal" -description: "How to configure applications in Tyk developer portal" -keywords: "Developer Portal, Tyk, Rate Limit" -sidebarTitle: "Manage Applications" ---- - -## Introduction - -**Prerequisites** - -- A Tyk Enterprise portal installation -- A portal admin app login -- A login to the already created app by an external API consumer - -### To view existing apps - -1. In the portal admin app, go to **Apps**. If there are some apps already created by external API-consumers, you’ll see them in the overview list. -List of applications - -2. Click on an app from the overview page. -3. On the right hand slideout, you will see the information about the created app. - -### Revoke app credentials - -1. In the portal admin app, go to **Apps** and open the app. -2. Click **credentials**. This means the developer will no longer be able to access the API Product via the selected plan. These actions will have an immediate effect. - diff --git a/tyk-stack/tyk-developer-portal/enterprise-developer-portal/getting-started-with-enterprise-portal/manage-get-started-guides-for-api-products.mdx b/tyk-stack/tyk-developer-portal/enterprise-developer-portal/getting-started-with-enterprise-portal/manage-get-started-guides-for-api-products.mdx deleted file mode 100644 index d83da922..00000000 --- a/tyk-stack/tyk-developer-portal/enterprise-developer-portal/getting-started-with-enterprise-portal/manage-get-started-guides-for-api-products.mdx +++ /dev/null @@ -1,105 +0,0 @@ ---- -title: "Create Get started guides for your API Products" -description: "How to configure API Providers in Tyk developer portal" -keywords: "Developer Portal, Tyk, Managing Access, Catalogs, Rate Limit, Dynamic Client Registration, Documenting APIs" -sidebarTitle: "Create Documentation" ---- - -## Introduction - -As an API Provider, you can package APIs into API Products and supply them with documentation to deliver value to your internal and external API Consumers.
-API documentation is essential for API Products. Good API documentation goes beyond just Open API Specification. To make your API Products easy to use and engaging, you can add technical and business guides to the documentation of your API Products, for instance: -* Get started guides explaining how to start with your API Product; -* Use-cases; -* Business documentation that explains the business value and helps to convince decision-makers. - -Tyk Enterprise Developer portal provides two ways of documenting APIs: -* Open API Specifications for APIs; -* The Get started documentation feature enables API Providers to add as many technical and business guides to API Products as needed. - -This section explains how to add the Get started documentation to API Products. - -### Create Get started guides for your API Product - - -1. **Create and publish an API Product** - - To start with, create and publish an API Product. Please refer to the [Publish API Products and Plans](/portal/overview/getting-started#publish-an-api-product) page for further guidance. - -2. **Add API Documentation to API Products** - - - - - If you are using Tyk Developer Portal version 1.13.0 or later, you can add API Documentation under the `"Getting Started" guides` tab of the API Product's view. - Add Product Guides - - - - To add API Documentation, select an API Product and navigate to the API Documentation section. - Click the ‘Add API Documentation’ button to add a new API Documentation page. - Navigate to the API Documentation section - -
- - Tyk developer portal stores two versions of each API Documentation page: in Markdown and HTML formats. - You can edit both versions, but only one version of the page will be displayed. - To edit the Markdown version, click on the ‘Change to Markdown’ button. - Toggle the Markdown editor - -
- - To edit the HTML version, click the 'Change to HTML' button. - Toggle the HTML editor - -
- - To select which version of the documentation to display, check the ‘Display Markdown’ checkbox. - When it’s checked, the portal will display the Markdown version of the page. - Otherwise, portal will display the HTML version. - Display the MD version of the page - -3. **Add more documentation pages and set the display order** - - With the Tyk developer portal, you can add multiple Markdown and HTML pages to your API Products and select their display order to form a table of contents suitable for your use case. - Please refer to the previous step to add one more documentation page to the API Product. - - To reorder API Documentation items, scroll down to the API Documentation section and click on the ‘Reorder items’ button. - Reorder API Docs - -
- - Then click on the ‘Move up’ button to move an API Documentation item one position up, and the ‘Move down’ button to bring it one position down. Click on the 'Done' button and then on the 'Save' button to save your changes. - Reorder API Docs - -
- - Once you save the changes, the new order of items will be reflected in the ‘Get started’ tab. - Reorder API Docs - -
- - All documentation pages are listed in the ‘Product docs’ section. You can access and edit the API docs from that section. - Product docs section - -4. **Add tags to blogs and API Products** - - Finally, you can add blog posts to your API Products using the Tags feature. - You can specify tags for API Product and blog posts, then the blog posts that match tags with an API Product will be displayed in the ‘Related blog content’ section. - Tags diagram - -
- - To specify tags for an API Product, select an API Product, scroll down to the ‘Tags’ section, type in a tag, and press the Enter key. - Specify tags for an API Product - -
- - To specify tags for a blog post, select a blog post, scroll down to the ‘Tags’ section, type in a tag, and press the Enter key. - Specify tags for a blog post - -
- - The blog posts that match tags with an API Product will be displayed in the ‘Related blog content’ section of the respective API Product page. - Related blog content - diff --git a/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-api-consumers.mdx b/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-api-consumers.mdx deleted file mode 100644 index f7738469..00000000 --- a/tyk-stack/tyk-developer-portal/enterprise-developer-portal/managing-access/manage-api-consumers.mdx +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: "Manage Users" -description: "How to manage users in Tyk developer portal" -keywords: "Developer Portal, Tyk, API Consumer, Users, Self Registration, Invite Users, Approve Requests" -sidebarTitle: "Users" ---- - -## Register a New API User - -Developers need to register with the portal to access API Products and manage their applications. This section outlines how developers can register with the portal, access API Products, and reset their passwords if needed. - -There are two ways for registering a new account -1. Self signup via the form. -2. Receive an invitation from the portal admin. - -Here you’ll learn about how to add and invite a new external user to the developer portal. - -**Prerequisites** - -- A Tyk portal installation -- Log in to the portal admin app - -## Self Registration/Signup - -To use the self sign up flow, you’ll need to: -1. Access the Portal and click **REGISTER**. - - Portal login and Register menu - -2. Complete the **Create an Account** form. - - Form to create a developer portal account - -3. Click **Register to developer portal**. -4. If the portal allows signup without approval, you'll get a message that allows you to log in straight away. - - Account registered to allow immediate access to the portal - -5. If the portal requires an admin to approve a registration request, after submitting the **Create an Account** form, you will get the following message. - - Registration account submitted for admin approval - -## Invite a New User - -1. From the **API Consumers > Users** menu Click **Add new user**. - - Portal API Users menu - -2. In the **Add user** dialog, enter **First** and **Last** names, and **Email**. -3. Select an organization to which to register your user. -4. You can also set a password for a user by typing it in the **Set password** field. Check the **User must change password at the next login** if you wish your developer to change their password at next login. - - Please note, that you can either send the invite email or set the password yourself, but you cannot use both methods. - - Add API Users dialog - -5. Click **Save** to add your user. -6. To generate the invite email, click **More Options** in the Overview section and then **Send invite**. - - The user will receive an email with a link to the registration form. This option is only available if you didn't set the password before. - To customize the invite email, please refer to the [Email customization section](/portal/customization/email-notifications) for guidance. - - Users Send invite dialog - -## Approve Self Registering Requests - -## Manual Approval - -This section explains how to approve/reject external users self-registering requests to the developer portal. Follow the step-by-step guide. - -**Prerequisites** - -A Tyk Enterprise portal installation - -**Step by step instructions** - -1. Click *Users* from the **API Consumers** menu - -Portal API Users menu - -2. When a new user has self-registered to access the developer portal, their user profile will be added to the overview in the **Users** section. - -List of Users for your portal app - -3. To approve a user, click on an **inactive** user. Select **Activate developer** from the dialog. - -Select Activate developer - -## Automatically Approve User Registrations - -If you want all Users to be automatically approved this setting can be changed under **Settings > General**. Select **Auto approve developer regestering requests**. - -Setting to automatically approve user registrations - - diff --git a/ui-examples/feature-cards.mdx b/ui-examples/feature-cards.mdx deleted file mode 100644 index 07fe15f7..00000000 --- a/ui-examples/feature-cards.mdx +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: "Feature Cards" -'og:description': "Documentation for the feature-cards shortcode in Tyk. Learn how to display responsive feature cards with icons, titles, and descriptions." -sidebarTitle: "UI Example: Feature Cards shortcode" -tags: ['UI Examples', 'Shortcodes', 'Feature Cards'] ---- - -import UIExampleCards from '/snippets/UIExampleCards.mdx'; - -The `feature-cards` shortcode creates a responsive grid of cards with icons, titles, and descriptions. This is ideal for presenting features or capabilities in a visually appealing way. - -## When to Use - -Use the feature-cards shortcode when you need to display a set of features or capabilities in a visually appealing grid format. It's particularly useful for: - -- Product feature highlights -- Service capabilities -- Key benefits lists -- Team member profiles -- Pricing plan comparisons - -The responsive design ensures your content looks great on all devices, from mobile phones to desktop screens. - -## Usage - -To use the feature cards shortcode in your markdown file, you need to specify a data file: - -```md -{{}} -``` - -## Configuration - -The feature cards are configured through JSON files located in the `data` directory. You must specify which data file to use with the `dataFile` parameter. Here's an example of how to structure a data file: - -```json -{ - "components": [ - { - "title": "Feature Title 1", - "icon": "🚀", - "description": "Description of the first feature." - }, - { - "title": "Feature Title 2", - "icon": "⚙️", - "description": "Description of the second feature." - }, - { - "title": "Feature Title 3", - "icon": "📊", - "description": "Description of the third feature." - }, - { - "title": "Feature Title 4", - "icon": "🔒", - "description": "Description of the fourth feature." - } - ] -} -``` - -### Data Structure - -Each feature card requires the following fields: - -- `title`: The title of the feature (displayed as a heading) -- `icon`: An emoji or character to use as the feature icon -- `description`: A short description of the feature - -Optionally, you can include: - -- `path`: A URL path for the "Learn More" button -- `button_text`: The text to display on the button (defaults to "Learn More") - -## Responsive Behavior - -The feature cards are fully responsive and will adjust based on screen size: - -- On mobile devices (width < 576px): 1 card per row -- On tablet devices (width 576px - 992px): 2 cards per row -- On desktop devices (width ≥ 992px): 4 cards per row - -## Styling - -The cards feature large, centered emoji icons with consistent styling: - -- White background -- Subtle shadow effect -- Rounded corners -- Centered content -- Consistent spacing -- Blue action buttons (optional) - -## Complete Example - -Here's a complete example of how to implement feature cards: - -1. Create or modify a JSON file in the data directory (e.g., `data/my-features.json`): - -```json -{ - "components": [ - { - "title": "Security", - "icon": "🔒", - "description": "Enterprise-grade security with robust authentication options." - }, - { - "title": "Analytics", - "icon": "📊", - "description": "Real-time insights into API usage and performance." - }, - { - "title": "Automation", - "icon": "⚙️", - "description": "Automate workflows and reduce manual intervention." - }, - { - "title": "Scalability", - "icon": "🚀", - "description": "Scale seamlessly to handle growth and demand spikes." - } - ] -} -``` - -2. Reference this data in the shortcode template (you'll need to modify the shortcode to use your custom data file). - -3. Use the shortcode in your markdown file with the custom data file: - -```md -{{}} -``` - -## Using Multiple Feature Card Sets - -You can use multiple different sets of feature cards in your documentation by: - -1. Creating additional JSON files in the data directory with different names -2. Specifying the appropriate data file when using the shortcode - -This approach allows you to have multiple independent sets of feature cards throughout your documentation. - -## Live Example - -The following example uses a custom data file called `ui-example-features.json`: - -```md -{{}} -``` - -Which renders as: - - diff --git a/ui-examples/test-pill-label-security.mdx b/ui-examples/test-pill-label-security.mdx deleted file mode 100644 index 675bb22e..00000000 --- a/ui-examples/test-pill-label-security.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "UI Examples: Pill Label Security Test" ---- - -## Security Test Cases for Pill Label Shortcode - -### Normal Usage -NORMAL - -### HTML Injection Attempt - - -### Invalid Class - Generates "Warning: Unsupported class" Message -INVALID CLASS - -### Malicious Style Attempt - Generates "Warning: Potentially unsafe style attribute" Message -BAD STYLE - -### Additional Unsafe Style Test - Generates "Warning: Potentially unsafe style attribute" Message -SCRIPT IN STYLE - -### Expression Style Test - Generates "Warning: Potentially unsafe style attribute" Message -EXPRESSION - -### Safe Complex Style Attempt -COMPLEX - -## Warning Messages Generated During Build - -The Hugo build log should show these warnings for the malicious test cases: - -1. For invalid class: - ``` - Warning: Unsupported class 'not-allowed-class' used in pill-label shortcode. Using default class instead. - ``` - -2. For unsafe style attributes: - ``` - Warning: Potentially unsafe style attribute in pill-label shortcode was sanitized - ``` - -## IMPORTANT - -This page is set to `draft: true` to prevent it from being built in production, -avoiding warning messages in deployment logs. To test the security features: - -1. Run Hugo locally with the draft flag: `hugo serve -D` -2. Observe the warning messages in the terminal -3. Verify the rendered output in the browser diff --git a/ui-examples/test-pill-label.mdx b/ui-examples/test-pill-label.mdx deleted file mode 100644 index 0f4b7047..00000000 --- a/ui-examples/test-pill-label.mdx +++ /dev/null @@ -1,193 +0,0 @@ ---- -title: "UI Examples: Pill label shortcode" -sidebarTitle: "UI Example: Pill Label Shortcode" ---- - -This page demonstrates all available styles and usage examples of the pill-label shortcode. - -**Feel free to contribute by adding more classes or adjusting the colors via PR.** - -Click on any example to see details about its usage and styling. - - ---- - -

Default style - Enterprise edition

-### Enterprise security features EE - - -Type: Default Style - -Usage: Used for Enterprise Edition features - -Class name: `pill-outline-brandpurple-light` (default) - -This creates a pill with: -- Transparent background -- Dark purple (#8438fa) border -- Dark purple (#8438fa) text - -Example appearance: `[ EE ]` (outline style with purple text) - -Code example: -``` -### Enterprise security features {{}} -``` - - ---- - -

Dark purple style - Cloud features

-### Governance CLOUD - - -Type: Dark Purple Style - -Usage: Used for Cloud Features - -Class name: `pill-brandpurple-dark` - -This creates a pill with: -- Dark purple (#8438fa) background -- White text - -Example appearance: `[CLOUD]` (solid purple background with white text) - -Code example: -``` -### Cloud-only feature {{}} -``` - - ---- - -

Yellow style - Lab releases

-### AI future feature LAB RELEASE - - -Type: Yellow Style - -Usage: Used for Lab Releases - -Class name: `pill-yellow` - -This creates a pill with: -- Yellow (#d6b218) background -- Black text - -Example appearance: `[LAB RELEASE]` (solid yellow background with black text) - -Code example: -``` -### Lab feature {{}} -``` - - ---- - -

Red style - Deprecated features

-### Tyk classic API definition DEPRECATED - - -Type: Red Style - -Usage: Used for Deprecated Features - -Class name: `pill-red` - -This creates a pill with: -- Red (#ff6c7d) background -- White text - -Example appearance: `[DEPRECATED]` (solid red background with white text) - -Code example: -``` -### Tyk classic API definition {{}} -``` - - ---- - -

Light purple style - Tutorials

-### Tyk streams getting started TUTORIAL - - -Type: Light Purple Style - -Usage: Used for Tutorials - -Class name: `pill-default` - -This creates a pill with: -- Light purple (#ededf9) background -- Medium purple (#505071) text - -Example appearance: `[TUTORIAL]` (light purple background with dark purple text) - -Code example: -``` -### Tyk streams getting started {{}} -``` - - ---- - -

Green style - New features

-### New feature NEW - - -Type: Green Style - -Usage: Used for New Features - -Class name: `pill-brandgreen` - -This creates a pill with: -- Green (#00cdb0) background -- Black text - -Example appearance: `[NEW]` (solid green background with black text) - -Code example: -``` -### New feature {{}} -``` - - ---- - -

Custom styling

-### Custom label CUSTOM - - -Type: Custom Styling - -Usage: Used for special cases requiring custom styling - -Uses inline `style` attribute instead of class - -This creates a pill with custom inline styling - in this case: -- Light gray background -- Dark gray text -- Light gray border - -Example appearance: `[CUSTOM]` (custom styling as specified) - -Code example: -``` -### Custom label {{}} -``` - - ---- - -

Reference table

-| Class Name | Best For | Background | Text Color | Border | -| :------------ | :---------- | :------------ | :------------ | :-------- | -| pill-outline-brandpurple-light (default) | Enterprise Edition | Transparent | Dark Purple | Dark Purple | -| pill-brandpurple-dark | Cloud Features | Dark Purple | White | None | -| pill-yellow | Lab Releases | Yellow | Black | None | -| pill-red | Deprecated Features | Red | White | None | -| pill-brandgreen | New Features | Green | Black | None | -| pill-default | Tutorials | Light Purple | Medium Purple | None | diff --git a/ui-examples/youtube-video-embed.mdx b/ui-examples/youtube-video-embed.mdx deleted file mode 100644 index dd3861e4..00000000 --- a/ui-examples/youtube-video-embed.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "YouTube Video Embed" -'og:description': "Documentation for the youtube-seo shortcode in Tyk. Learn how to embed YouTube videos in your documentation with proper styling and responsive behavior." -sidebarTitle: "UI Example: YouTube Video Embed shortcode" -tags: ['UI Examples', 'Shortcodes', 'Video Embed'] ---- - -The `youtube-seo` shortcode allows you to easily embed YouTube videos in your documentation with proper styling and responsive behavior. - -## When to Use - -Use the `youtube-seo` shortcode whenever you need to embed a YouTube video in your documentation, such as: - -- Product demonstrations -- Tutorial walkthroughs -- Conference presentations -- Webinar recordings -- Feature explanations - -The shortcode ensures consistent styling and proper SEO attributes for all embedded videos across your documentation. - -## Basic Usage - -To embed a YouTube video, simply use the shortcode with the video ID: - -```md -{{}} -``` - -Replace `VIDEO_ID` with the actual YouTube video ID (the part after `v=` in a YouTube URL) and `Video Title` with a descriptive title for the video. - -## Example - -```md - -``` - -## Parameters - -The shortcode supports several parameters: - -| Parameter | Required | Default | Description | -| :----------- | :---------- | :--------- | :------------- | -| id | Yes | - | The YouTube video ID | -| title | Yes | - | The title of the video (for SEO and accessibility) | -| width | No | 640 | The width of the video in pixels | -| height | No | 360 | The height of the video in pixels | -| allow | No | accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share | Permissions for the embedded iframe | -| frameborder | No | 0 | Border around the iframe | - -## Responsive Behavior - -The embedded video will: -- Be centered on the page -- Maintain its aspect ratio on all screen sizes -- Have appropriate margin spacing above and below -- Appear at a comfortable size (640x360 by default) - -## Advanced Usage - -If you need to customize the video dimensions: - -```md -{{< youtube-seo id="VIDEO_ID" title="Video Title" width="800" height="450" >}} -``` - -If you need to restrict certain iframe permissions: - -```md -{{< youtube-seo id="VIDEO_ID" title="Video Title" allow="accelerometer; encrypted-media" >}} -```