Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

QA (landing pages & reference) #187

Merged
merged 2 commits into from
Dec 20, 2024
Merged

QA (landing pages & reference) #187

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9be3153
QA
lmilan Dec 20, 2024
a900870
Update protocols.md
lmilan Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/_gateway_entities/consumer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ schema:

## What is a Consumer?

{{ page.description }} Consumers can be applications, services, or users who interact with your APIs.
{{ page.description | liquify }} Consumers can be applications, services, or users who interact with your APIs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }} Consumers can be applications, services, or users who interact with your APIs.
A Consumer typically refers to an entity that consumes or uses the APIs managed by {{site.base_gateway}}. Consumers can be applications, services, or users who interact with your APIs.

Fabian recommended just putting the description directly in the intro paragraph on one of my other PRs.

Since they are not always human, {{site.base_gateway}} calls them Consumers, because they "consume" the service.
{{site.base_gateway}} allows you to define and manage Consumers, apply access control policies, and monitor their API usage.

Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/route.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ schema:

## What is a route?

{{page.description}} Services can store collections of objects like plugin configurations, and policies, and they can be associated with routes. In {{site.base_gateway}}, routes typically map to endpoints that are exposed through the {{site.base_gateway}} application. Routes can also define rules that match requests to associated services. Because of this, one route can reference multiple endpoints. A basic route should have a name, path or paths, and reference an existing service.
{{page.description | liquify}} Services can store collections of objects like plugin configurations, and policies, and they can be associated with routes. In {{site.base_gateway}}, routes typically map to endpoints that are exposed through the {{site.base_gateway}} application. Routes can also define rules that match requests to associated services. Because of this, one route can reference multiple endpoints. A basic route should have a name, path or paths, and reference an existing service.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{page.description | liquify}} Services can store collections of objects like plugin configurations, and policies, and they can be associated with routes. In {{site.base_gateway}}, routes typically map to endpoints that are exposed through the {{site.base_gateway}} application. Routes can also define rules that match requests to associated services. Because of this, one route can reference multiple endpoints. A basic route should have a name, path or paths, and reference an existing service.
A route is a path to a resource within an upstream application. Services can store collections of objects like plugin configurations, and policies, and they can be associated with routes. In {{site.base_gateway}}, routes typically map to endpoints that are exposed through the {{site.base_gateway}} application. Routes can also define rules that match requests to associated services. Because of this, one route can reference multiple endpoints. A basic route should have a name, path or paths, and reference an existing service.


You can also configure routes with:

Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/service.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ api_specs:

## What is a Gateway Service?

{{ page.description }}
{{ page.description | liquify }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }}
A Gateway Service is an abstraction of an upstream application that services requests.

Services can store collections of objects like plugin configurations, and policies, and they can be associated with routes.

When defining a Service, the administrator provides a name and the upstream application connection information.
Expand Down
2 changes: 1 addition & 1 deletion app/_gateway_entities/target.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ schema:

## What is a Target?

{{page.description}} Each [Upstream](/gateway/entities/upstream/) can have many Targets. Targets are used by Upstreams for [load balancing](https://docs.konghq.com/gateway/latest/how-kong-works/load-balancing/). For example, if you have an `example_upstream` Upstream, you can point it to two different Targets: `httpbin.konghq.com` and `httpbun.com`. This is so that if one of the servers (like `httpbin.konghq.com`) is unavailable, it automatically detects the problem and routes all traffic to the working server (`httpbun.com`).
{{page.description | liquify}} Each [Upstream](/gateway/entities/upstream/) can have many Targets. Targets are used by Upstreams for [load balancing](https://docs.konghq.com/gateway/latest/how-kong-works/load-balancing/). For example, if you have an `example_upstream` Upstream, you can point it to two different Targets: `httpbin.konghq.com` and `httpbun.com`. This is so that if one of the servers (like `httpbin.konghq.com`) is unavailable, it automatically detects the problem and routes all traffic to the working server (`httpbun.com`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{page.description | liquify}} Each [Upstream](/gateway/entities/upstream/) can have many Targets. Targets are used by Upstreams for [load balancing](https://docs.konghq.com/gateway/latest/how-kong-works/load-balancing/). For example, if you have an `example_upstream` Upstream, you can point it to two different Targets: `httpbin.konghq.com` and `httpbun.com`. This is so that if one of the servers (like `httpbin.konghq.com`) is unavailable, it automatically detects the problem and routes all traffic to the working server (`httpbun.com`).
A Target is an IP address/hostname with a port that identifies an instance of a backend service. Each [Upstream](/gateway/entities/upstream/) can have many Targets. Targets are used by Upstreams for [load balancing](https://docs.konghq.com/gateway/latest/how-kong-works/load-balancing/). For example, if you have an `example_upstream` Upstream, you can point it to two different Targets: `httpbin.konghq.com` and `httpbun.com`. This is so that if one of the servers (like `httpbin.konghq.com`) is unavailable, it automatically detects the problem and routes all traffic to the working server (`httpbun.com`).


The following diagram illustrates how Targets are used by Upstreams for load balancing:

Expand Down
2 changes: 2 additions & 0 deletions app/_gateway_entities/workspace.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ schema:
path: /schemas/Workspace
---

TODO

## What is a workspace?

This page is a stub
Expand Down
2 changes: 1 addition & 1 deletion app/_includes/plugins/ai-proxy/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
{% assign options = include.params.options %}
{% assign providers = site.data.plugins.ai-proxy.providers %}

{{ page.description }}
{{ page.description | liquify }}

The plugin accepts requests in one of a few defined and standardized formats, translates them to the configured target format, and then transforms the response back into a standard format.

Expand Down
6 changes: 3 additions & 3 deletions app/_landing_pages/gateway.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ rows:
PostgreSQL database.

Pass the `-- -h` option to the script to see all possible configuration options, including how to pass a license
to the script, how to switch to an open-source Gateway image, enable RBAC, and more.
to the script, switch to an open-source Gateway image, enable RBAC, and more.

Visit the [Gateway install page](/gateway/install/) for all other installation options.
Visit the [Gateway install page](https://docs.konghq.com/gateway/latest/install/) for all other installation options.

- header:
type: h2
Expand Down Expand Up @@ -101,7 +101,7 @@ rows:
oss: true
enterprise: true
- title: Gateway Mocking
subtitle: Mock API responses directly on the API gateway.
subtitle: Mock API responses directly on the API gateway
oss: false
enterprise: true
- title: "Kong Manager: Admin GUI"
Expand Down
2 changes: 1 addition & 1 deletion app/_landing_pages/gateway/rate-limiting.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ rows:
text: |
{{site.base_gateway}} allows you to limit how many HTTP requests can be made in a given period.

Rate limits can be applied to a [service](/gateway/entities/service/) or individual [routes](/gateway/entities/route/) to protect the upstream API, or to a [consumer](/gateway/entities/consumer/) to restrict how many times a user can call the API in the specified period.
Rate limits can be applied to a [Gateway Service](/gateway/entities/service/) or individual [Routes](/gateway/entities/route/) to protect the upstream API, or to a [Consumer](/gateway/entities/consumer/) to restrict how many times a user can call the API in the specified period.

Kong offers two standard HTTP rate limiting plugins: [Rate Limiting](/plugins/rate-limiting) or [Rate Limiting Advanced](/plugins/rate-limiting-advanced) plugins in addition to a series [specialized](#specialized-rate-limiting-plugins) AI, GraphQL and dynamic rate limiting plugins.
- columns:
Expand Down
2 changes: 1 addition & 1 deletion app/_landing_pages/kic/rate-limiting.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ rows:
- header:
type: h1
text: "Rate Limiting with {{site.kic_product_name}}"

# TODO
- header:
type: h2
text: How-to Guides
Expand Down
2 changes: 1 addition & 1 deletion app/_landing_pages/mesh/rate-limiting.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ rows:
- header:
type: h1
text: "Rate Limiting with {{site.mesh_product_name}}"

#TODO
- header:
type: h2
text: How-to Guides
Expand Down
2 changes: 1 addition & 1 deletion app/deck/distributed-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ breadcrumbs:
- /deck/
---

{{ page.description }}
{{ page.description | liquify }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }}
decK can operate on a subset of configuration instead of managing the entire configuration of {{site.base_gateway}}.

You can do this by breaking up the configuration into multiple files and managing them using tags.

With tags, you can use decK's `select-tag` feature to export, sync, or reset
Expand Down
2 changes: 1 addition & 1 deletion app/deck/manage-deck-with-docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ breadcrumbs:
- /deck/
---

{{ page.description }}
{{ page.description | liquify }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }}
If you used the [kong/deck](https://hub.docker.com/r/kong/deck) Docker image to install decK, you can use the same Docker image to manage decK.


Adjust `KONG_ADMIN_HOST` and the port `8001` in the following examples to the
host and port of your own {{site.base_gateway}} instance.
Expand Down
6 changes: 3 additions & 3 deletions app/deck/object-defaults.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ breadcrumbs:
- /deck/
---

{{ page.description }} You can see what the defaults are for each object in the
{{ page.description | liquify }} You can see what the defaults are for each object in the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }} You can see what the defaults are for each object in the
{{site.base_gateway}} sets some default values for most objects, including Kong plugins. You can see what the defaults are for each object in the

[Admin API reference](https://docs.konghq.com/gateway/latest/admin-api/), or use the
[`/schemas`](#find-defaults-for-an-object) endpoint to
check the latest object schemas for your instance of the {{site.base_gateway}}.
Expand All @@ -45,7 +45,7 @@ enforce a set of standard values and avoid repetition in your configuration.
decK assigns values in the following order of precedence, from highest to lowest:

1. Values set for a specific instance of an object in the state file
(for example, for a service named `example_service` defined in `kong.yml`).
(for example, for a Gateway Service named `example_service` defined in `kong.yaml`).
2. Values set in the `{_info: defaults:}` object in the state file.
3. Self-managed {{site.base_gateway}} only: Values are checked against the Kong
Admin API schemas.
Expand Down Expand Up @@ -237,7 +237,7 @@ For all available properties, see the
Use the Kong Admin API `/schemas` endpoint to find default values:

```sh
curl -i http://localhost:8001/schemas/plugins/<plugin-name>
curl -i http://localhost:8001/schemas/plugins/$PLUGIN_NAME
```

decK doesn't support setting custom default values for the plugin object.
Expand Down
2 changes: 1 addition & 1 deletion app/gateway/routing/expressions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ breadcrumbs:
- /gateway/routing/
---

{{ page.description }} Expressions can be used to perform tasks such as defining
{{ page.description | liquify }} Expressions can be used to perform tasks such as defining
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }} Expressions can be used to perform tasks such as defining
{{site.base_gateway}} includes a rule-based engine using a domain-specific expressions language. Expressions can be used to perform tasks such as defining

complex routing logic.
This guide is a reference for the expressions language and explains how it can be used.

Expand Down
20 changes: 10 additions & 10 deletions app/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ <h3>Gateway</h3>
</div>
<div class="flex flex-col w-full text-primary text-sm">
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/gateway/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/gateway/install/">Install <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="https://docs.konghq.com/gateway/latest/install/">Install <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/how-to/">How-to Guides <span class="text-terciary">&rarr;</span></a>
</div>
</div>
Expand All @@ -62,8 +62,8 @@ <h3>Mesh</h3>
<p class="text-sm text-secondary">Secure and control traffic with Kong Mesh's distributed service mesh capabilities.</p>
</div>
<div class="flex flex-col w-full text-primary text-sm">
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/mesh/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/mesh/install/">Install <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="https://docs.konghq.com/mesh/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="https://docs.konghq.com/mesh/latest/introduction/install/">Install <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/how-to/">How-to Guides <span class="text-terciary">&rarr;</span></a>
</div>
</div>
Expand All @@ -74,8 +74,8 @@ <h3>KIC</h3>
<p class="text-sm text-secondary">Kong’s Kubernetes-native controller to manage API traffic for containerized apps.</p>
</div>
<div class="flex flex-col w-full text-primary text-sm">
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/kic/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/kic/install/">Install <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="https://docs.konghq.com/kubernetes-ingress-controller">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="https://docs.konghq.com/kubernetes-ingress-controller/latest/get-started/">Install <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/how-to/">How-to Guides <span class="text-terciary">&rarr;</span></a>
</div>
</div>
Expand All @@ -92,7 +92,7 @@ <h3>Portal</h3>
<p class="text-sm text-secondary">Empower API consumers with self-service API documentation and developer tools.</p>
</div>
<div class="flex flex-col w-full text-primary text-sm">
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/dev-portal/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="https://docs.konghq.com/konnect/dev-portal/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="#use-cases">Use Cases <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/how-to/">How-to Guides <span class="text-terciary">&rarr;</span></a>
</div>
Expand All @@ -104,7 +104,7 @@ <h3>Analytics</h3>
<p class="text-sm text-secondary">Gain visibility into API performance and usage patterns with Kong's analytics.</p>
</div>
<div class="flex flex-col w-full text-primary text-sm">
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/analytics/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="https://docs.konghq.com/konnect/analytics/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="#use-cases">Use Cases <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/how-to/">How-to Guides <span class="text-terciary">&rarr;</span></a>
</div>
Expand All @@ -116,7 +116,7 @@ <h3>Service Catalog</h3>
<p class="text-sm text-secondary">Manage and discover services within the Kong ecosystem effortlessly.</p>
</div>
<div class="flex flex-col w-full text-primary text-sm">
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/service-catalog/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="https://docs.konghq.com/konnect/service-catalog/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="#use-cases">Use Cases <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/how-to/">How-to Guides <span class="text-terciary">&rarr;</span></a>
</div>
Expand All @@ -133,7 +133,7 @@ <h3>Org Management</h3>
<p class="text-sm text-secondary">Streamline and govern organization-wide API access and operations.</p>
</div>
<div class="flex flex-col w-full text-primary text-sm">
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/org-management/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="https://docs.konghq.com/konnect/account-management/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="#use-cases">Use Cases <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/how-to/">How-to Guides <span class="text-terciary">&rarr;</span></a>
</div>
Expand All @@ -145,7 +145,7 @@ <h3>Auditing</h3>
<p class="text-sm text-secondary">Streamline and govern organization-wide API access and operations.</p>
</div>
<div class="flex flex-col w-full text-primary text-sm">
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/audit/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="https://docs.konghq.com/konnect/org-management/audit-logging/">Overview <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 border-b border-primary/5 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="#use-cases">Use Cases <span class="text-terciary">&rarr;</span></a>
<a class="flex justify-between py-3 hover:bg-hover-component/100 hover:px-6 hover:-mx-6 hover:no-underline" href="/how-to/">How-to Guides <span class="text-terciary">&rarr;</span></a>
</div>
Expand Down
2 changes: 1 addition & 1 deletion app/insomnia/api-specs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ breadcrumbs:

## What are API specs?

{{ page.description }}
{{ page.description | liquify }}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{ page.description | liquify }}
API specifications explain how an API behaves and how it interacts with other APIs.

API specs can function like API documentation, but they also explain the values, parameters, and objects in the schema of the API. An API spec helps users know how to make requests to the APIs contained within the spec.

## How does Insomnia parse API specs?
Expand Down
2 changes: 1 addition & 1 deletion app/insomnia/cloud-sync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ faqs:

---

{{page.description}}
{{page.description | liquify}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{page.description | liquify}}
Cloud sync enables users to store and synchronize their project data in the cloud securely as well as use [version control](/insomnia/version-control).

This feature is beneficial for collaboration, providing easy access to projects from different devices and locations.

Cloud sync provides the following abilities on top of the base Insomnia functionality:
Expand Down
Loading
Loading