From d10841a9f2896af3739366baa5400fe2fdc3615d Mon Sep 17 00:00:00 2001 From: Danny Sheridan <83524670+dannysheridan@users.noreply.github.com> Date: Sun, 15 Dec 2024 14:03:05 -0500 Subject: [PATCH] chore(docs): Specify the protocol for each specification (#5418) * chore(docs): Specify the protocol for each specification I don't want to assume a reader knows that AsyncAPI is a websocket specification format. * Update title in API definition introduction --- .../introduction/what-is-an-api-definition.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/fern/pages/api-definition/introduction/what-is-an-api-definition.mdx b/fern/pages/api-definition/introduction/what-is-an-api-definition.mdx index e680dbeb15c..3332ab222ea 100644 --- a/fern/pages/api-definition/introduction/what-is-an-api-definition.mdx +++ b/fern/pages/api-definition/introduction/what-is-an-api-definition.mdx @@ -12,7 +12,7 @@ Fern integrates with several API definition formats: Formerly known as Swagger, [OpenAPI](https://swagger.io/specification/) is the most popular API definition format. OpenAPI can be used to document RESTful APIs and is defined in a YAML or JSON file. @@ -102,7 +102,7 @@ Fern integrates with several API definition formats: ``` [AsyncAPI](https://v2.asyncapi.com/docs) is a specification for defining event-driven APIs. It is used to document APIs that use WebSockets, MQTT, and other messaging protocols. @@ -156,7 +156,7 @@ Fern integrates with several API definition formats: The Fern Definition is our take on a simpler API definition format. It is designed with **best-practices**, supports **both RESTful and event-driven APIs**, and is optimized for **SDK generation**.