Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1,142 changes: 797 additions & 345 deletions README.md

Large diffs are not rendered by default.

Binary file modified bun.lockb
Binary file not shown.
13 changes: 13 additions & 0 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# The Speakeasy Bar API

## Introduction

TODO: Introduction to the Speakeasy Bar API example

## Installing The Speakeasy Bar API

TODO: Installing The Speakeasy Bar API

## Overview Of The Speakeasy Bar API

TODO: Overview Of The Speakeasy Bar API, discuss endpoints and components one by one with inline snippets.
11 changes: 11 additions & 0 deletions glossary/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# OpenAPI Glossary

TODO: Write short definitions for OpenAPI terms, link to our reference docs. Examples:

## OpenAPI specification

## OpenAPI document

## JSON-Schema

## SDK generator
20 changes: 20 additions & 0 deletions guides/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# OpenAPI Guides

## Introduction

TODO: OpenAPI Guides Introduction

## Guides

TODO: Guides, categorised/structured according to e.g. documentation, SDKs, CI/CD, etc.

Some examples:

- How to add a webhook using OpenAPI.
- How to add a list as a path parameter in OpenAPI.
- Add SDK generation to your CI/CD workflows.
- Lint and edit documentation strings in your OpenAPI documents.
- How to generate API documentation using Redoc.
- How to add Redoc-generated OpenAPI documentation to Docusaurus.
- How to validate your OpenAPI document as part of CI/CD.
- etc.
Loading