Skip to content

Commit d813d04

Browse files
spacetherspacether
authored
Improves generator docs, adds metadata section (#11262)
* Refactors generator md creation, adds generateMdMetadata * Removes extra space * Adds docs updates * Fixes table definition for metadata * Docs update * Docs update * Updates title, removes sidebar_label because it was not doing anything on pages like https://openapi-generator.tech/docs/generators/android * Docs updated
1 parent 4782197 commit d813d04

File tree

145 files changed

+1560
-368
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

145 files changed

+1560
-368
lines changed

‎docs/generators/ada-server.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
2-
title: Config Options for ada-server
3-
sidebar_label: ada-server
2+
title: Documentation for the ada-server Generator
43
---
54

5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
| -------- | ----- | ----- |
9+
| generator name | ada-server | pass this to the generate command after -g |
10+
| generator type | SERVER | |
11+
| helpTxt | Generates an Ada server implementation (beta). | |
12+
13+
## CONFIG OPTIONS
614
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
715

816
| Option | Description | Values | Default |

‎docs/generators/ada.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
2-
title: Config Options for ada
3-
sidebar_label: ada
2+
title: Documentation for the ada Generator
43
---
54

5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
| -------- | ----- | ----- |
9+
| generator name | ada | pass this to the generate command after -g |
10+
| generator type | CLIENT | |
11+
| helpTxt | Generates an Ada client implementation (beta). | |
12+
13+
## CONFIG OPTIONS
614
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
715

816
| Option | Description | Values | Default |

‎docs/generators/android.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
2-
title: Config Options for android
3-
sidebar_label: android
2+
title: Documentation for the android Generator
43
---
54

5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
| -------- | ----- | ----- |
9+
| generator name | android | pass this to the generate command after -g |
10+
| generator type | CLIENT | |
11+
| helpTxt | Generates an Android client library. | |
12+
13+
## CONFIG OPTIONS
614
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
715

816
| Option | Description | Values | Default |

‎docs/generators/apache2.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
2-
title: Config Options for apache2
3-
sidebar_label: apache2
2+
title: Documentation for the apache2 Generator
43
---
54

5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
| -------- | ----- | ----- |
9+
| generator name | apache2 | pass this to the generate command after -g |
10+
| generator type | CONFIG | |
11+
| helpTxt | Generates an Apache2 Config file with the permissions | |
12+
13+
## CONFIG OPTIONS
614
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
715

816
| Option | Description | Values | Default |

‎docs/generators/apex.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
2-
title: Config Options for apex
3-
sidebar_label: apex
2+
title: Documentation for the apex Generator
43
---
54

5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
| -------- | ----- | ----- |
9+
| generator name | apex | pass this to the generate command after -g |
10+
| generator type | CLIENT | |
11+
| helpTxt | Generates an Apex API client library. | |
12+
13+
## CONFIG OPTIONS
614
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
715

816
| Option | Description | Values | Default |

‎docs/generators/asciidoc.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
2-
title: Config Options for asciidoc
3-
sidebar_label: asciidoc
2+
title: Documentation for the asciidoc Generator
43
---
54

5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
| -------- | ----- | ----- |
9+
| generator name | asciidoc | pass this to the generate command after -g |
10+
| generator type | DOCUMENTATION | |
11+
| helpTxt | Generates asciidoc markup based documentation. | |
12+
13+
## CONFIG OPTIONS
614
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
715

816
| Option | Description | Values | Default |

‎docs/generators/aspnetcore.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
2-
title: Config Options for aspnetcore
3-
sidebar_label: aspnetcore
2+
title: Documentation for the aspnetcore Generator
43
---
54

5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
| -------- | ----- | ----- |
9+
| generator name | aspnetcore | pass this to the generate command after -g |
10+
| generator type | SERVER | |
11+
| helpTxt | Generates an ASP.NET Core Web API server. | |
12+
13+
## CONFIG OPTIONS
614
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
715

816
| Option | Description | Values | Default |

‎docs/generators/avro-schema.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
2-
title: Config Options for avro-schema
3-
sidebar_label: avro-schema
2+
title: Documentation for the avro-schema Generator
43
---
54

5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
| -------- | ----- | ----- |
9+
| generator name | avro-schema | pass this to the generate command after -g |
10+
| generator type | SCHEMA | |
11+
| helpTxt | Generates a Avro model (beta). | |
12+
13+
## CONFIG OPTIONS
614
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
715

816
| Option | Description | Values | Default |

‎docs/generators/bash.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
2-
title: Config Options for bash
3-
sidebar_label: bash
2+
title: Documentation for the bash Generator
43
---
54

5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
| -------- | ----- | ----- |
9+
| generator name | bash | pass this to the generate command after -g |
10+
| generator type | CLIENT | |
11+
| helpTxt | Generates a Bash client script based on cURL. | |
12+
13+
## CONFIG OPTIONS
614
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
715

816
| Option | Description | Values | Default |

‎docs/generators/c.md‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
2-
title: Config Options for c
3-
sidebar_label: c
2+
title: Documentation for the c Generator
43
---
54

5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
| -------- | ----- | ----- |
9+
| generator name | c | pass this to the generate command after -g |
10+
| generator type | CLIENT | |
11+
| helpTxt | Generates a C (libcurl) client library (beta). | |
12+
13+
## CONFIG OPTIONS
614
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
715

816
| Option | Description | Values | Default |

0 commit comments

Comments
 (0)