Skip to content

Commit

Permalink
Add pages for examples
Browse files Browse the repository at this point in the history
  • Loading branch information
ralfhandl committed Aug 14, 2024
1 parent 0b247d8 commit 3324562
Show file tree
Hide file tree
Showing 12 changed files with 145 additions and 0 deletions.
1 change: 1 addition & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ GEM

PLATFORMS
arm64-darwin-21
arm64-darwin-23
x86_64-darwin-23
x86_64-linux

Expand Down
18 changes: 18 additions & 0 deletions _includes/example-api-description.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# {{ include.name }}

{% assign json_file = include.name | append: ".json" %}
{% assign yaml_file = include.name | append: ".yaml" %}

{{ include.description }}

## JSON

```json
{% include_relative {{ json_file }} %}
```

## YAML

```yaml
{% include_relative {{ yaml_file }} %}
```
9 changes: 9 additions & 0 deletions examples/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
layout: default
title: Example API Descriptions
nav_order: 6
has_children: true
has_toc: true
---

# Example API Descriptions
13 changes: 13 additions & 0 deletions examples/v3.0/api-with-examples.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: default
title: api-with-examples
parent: Example API Descriptions
---

{% comment %}
{% capture description %}
Insert description here, then remove comment tag above and endcomment tag below
{% endcapture %}
{% endcomment %}

{% include example-api-description.md name=page.title description=description %}
13 changes: 13 additions & 0 deletions examples/v3.0/callback-example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: default
title: callback-example
parent: Example API Descriptions
---

{% comment %}
{% capture description %}
Insert description here, then remove comment tag above and endcomment tag below
{% endcapture %}
{% endcomment %}

{% include example-api-description.md name=page.title description=description %}
13 changes: 13 additions & 0 deletions examples/v3.0/link-example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: default
title: link-example
parent: Example API Descriptions
---

{% comment %}
{% capture description %}
Insert description here, then remove comment tag above and endcomment tag below
{% endcapture %}
{% endcomment %}

{% include example-api-description.md name=page.title description=description %}
13 changes: 13 additions & 0 deletions examples/v3.0/petstore-expanded.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: default
title: petstore-expanded
parent: Example API Descriptions
---

{% comment %}
{% capture description %}
Insert description here, then remove comment tag above and endcomment tag below
{% endcapture %}
{% endcomment %}

{% include example-api-description.md name=page.title description=description %}
13 changes: 13 additions & 0 deletions examples/v3.0/petstore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: default
title: petstore
parent: Example API Descriptions
---

{% comment %}
{% capture description %}
Insert description here, then remove comment tag above and endcomment tag below
{% endcapture %}
{% endcomment %}

{% include example-api-description.md name=page.title description=description %}
13 changes: 13 additions & 0 deletions examples/v3.0/uspto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: default
title: uspto
parent: Example API Descriptions
---

{% comment %}
{% capture description %}
Insert description here, then remove comment tag above and endcomment tag below
{% endcapture %}
{% endcomment %}

{% include example-api-description.md name=page.title description=description %}
13 changes: 13 additions & 0 deletions examples/v3.1/non-oauth-scopes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: default
title: non-oauth-scopes
parent: Example API Descriptions
---

{% comment %}
{% capture description %}
Insert description here, then remove comment tag above and endcomment tag below
{% endcapture %}
{% endcomment %}

{% include example-api-description.md name=page.title description=description %}
13 changes: 13 additions & 0 deletions examples/v3.1/tictactoe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: default
title: tictactoe
parent: Example API Descriptions
---

{% comment %}
{% capture description %}
Insert description here, then remove comment tag above and endcomment tag below
{% endcapture %}
{% endcomment %}

{% include example-api-description.md name=page.title description=description %}
13 changes: 13 additions & 0 deletions examples/v3.1/webhook-example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
layout: default
title: webhook-example
parent: Example API Descriptions
---

{% comment %}
{% capture description %}
Insert description here, then remove comment tag above and endcomment tag below
{% endcapture %}
{% endcomment %}

{% include example-api-description.md name=page.title description=description %}

0 comments on commit 3324562

Please sign in to comment.