Skip to content

Commit

Permalink
chore(docs): Specify the protocol for each specification (#5418)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
dannysheridan authored Dec 15, 2024
1 parent 1de7ec5 commit d10841a
Showing 1 changed file with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Fern integrates with several API definition formats:

<AccordionGroup>
<Accordion
title="OpenAPI (Swagger)"
title="OpenAPI (REST & Webhook APIs)"
>
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.
Expand Down Expand Up @@ -102,7 +102,7 @@ Fern integrates with several API definition formats:
```
</Accordion>
<Accordion
title="AsyncAPI"
title="AsyncAPI (WebSocket APIs)"
>
[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.
Expand Down Expand Up @@ -156,7 +156,7 @@ Fern integrates with several API definition formats:
</Accordion>
<Accordion
title="Fern Definition"
title="Fern Definition (REST, Webhook, & WebSocket APIs)"
>
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**.
Expand Down

0 comments on commit d10841a

Please sign in to comment.