Skip to content

Commit 3bff6bd

Browse files
committed
docs: reformat ADMINS.md and cmd/osgen/README.md tables
These files had table-column misalignment that the prettier check missed while its glob was broken. Reflow them so the now-fixed check passes. Signed-off-by: Sean Chittenden <sean.chittenden@crowdstrike.com>
1 parent 31dea9a commit 3bff6bd

2 files changed

Lines changed: 23 additions & 23 deletions

File tree

ADMINS.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ This document explains who the admins are (see below), what they do in this repo
1111

1212
## Current Admins
1313

14-
| Admin | GitHub ID | Affiliation |
15-
| --- | --- | --- |
16-
| Charlotte | [CEHENKLE](https://github.com/CEHENKLE) | Amazon |
17-
| Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon |
18-
| Jack Mazanec | [jmazanec15](https://github.com/jmazanec15) | Amazon |
19-
| Vamshi Vijay Nakkirtha | [vamshin](https://github.com/vamshin) | Amazon |
20-
| Vijayan Balasubramanian | [VijayanB](https://github.com/VijayanB) | Amazon |
14+
| Admin | GitHub ID | Affiliation |
15+
| ----------------------- | ------------------------------------------- | ----------- |
16+
| Charlotte | [CEHENKLE](https://github.com/CEHENKLE) | Amazon |
17+
| Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon |
18+
| Jack Mazanec | [jmazanec15](https://github.com/jmazanec15) | Amazon |
19+
| Vamshi Vijay Nakkirtha | [vamshin](https://github.com/vamshin) | Amazon |
20+
| Vijayan Balasubramanian | [VijayanB](https://github.com/VijayanB) | Amazon |
2121

2222
## Admin Responsibilities
2323

cmd/osgen/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -84,22 +84,22 @@ Generates API consumer files into `opensearchapi/` and plugin directories.
8484

8585
#### Flags
8686

87-
| Flag | Default | Description |
88-
| -------------------------------- | -------- | --------------------------------------------------------------------------- |
89-
| `-spec` | required | Path to the combined OpenAPI spec YAML |
90-
| `-out` | required | Output directory for core API files (e.g. `opensearchapi/`) |
91-
| `-pkg` | required | Go package name for generated files (e.g. `opensearchapi`) |
92-
| `-plugins-out` | (none) | Output directory for plugin files (e.g. `plugins/`) |
93-
| `-groups` | (all) | Comma-separated `x-operation-group` filter |
94-
| `-min-version` | `epoch` | Minimum OpenSearch version (default operator: `>=`) |
95-
| `-max-version` | `latest` | Maximum OpenSearch version (default operator: `<=`) |
96-
| `-remove-deprecated` | `epoch` | Treat operations deprecated at or before this version as removed |
97-
| `-min-version-preserve-optional` | `false` | Keep version-gated fields as pointers even when min-version covers them |
98-
| `-version-breadcrumb-operations` | `all` | Emit comments for excluded operations: `all`, `older`, `newer` |
99-
| `-version-breadcrumb-types` | `all` | Emit comments for excluded types: `all`, `older`, `newer` |
100-
| `-version-breadcrumb-fields` | `all` | Emit comments for excluded struct fields: `all`, `older`, `newer` |
101-
| `-version-breadcrumb-paths` | `all` | Emit comments for excluded path builders: `all`, `older`, `newer` |
102-
| `-version-breadcrumb-params` | `all` | Emit comments for excluded query parameters: `all`, `older`, `newer` |
87+
| Flag | Default | Description |
88+
| -------------------------------- | -------- | ----------------------------------------------------------------------- |
89+
| `-spec` | required | Path to the combined OpenAPI spec YAML |
90+
| `-out` | required | Output directory for core API files (e.g. `opensearchapi/`) |
91+
| `-pkg` | required | Go package name for generated files (e.g. `opensearchapi`) |
92+
| `-plugins-out` | (none) | Output directory for plugin files (e.g. `plugins/`) |
93+
| `-groups` | (all) | Comma-separated `x-operation-group` filter |
94+
| `-min-version` | `epoch` | Minimum OpenSearch version (default operator: `>=`) |
95+
| `-max-version` | `latest` | Maximum OpenSearch version (default operator: `<=`) |
96+
| `-remove-deprecated` | `epoch` | Treat operations deprecated at or before this version as removed |
97+
| `-min-version-preserve-optional` | `false` | Keep version-gated fields as pointers even when min-version covers them |
98+
| `-version-breadcrumb-operations` | `all` | Emit comments for excluded operations: `all`, `older`, `newer` |
99+
| `-version-breadcrumb-types` | `all` | Emit comments for excluded types: `all`, `older`, `newer` |
100+
| `-version-breadcrumb-fields` | `all` | Emit comments for excluded struct fields: `all`, `older`, `newer` |
101+
| `-version-breadcrumb-paths` | `all` | Emit comments for excluded path builders: `all`, `older`, `newer` |
102+
| `-version-breadcrumb-params` | `all` | Emit comments for excluded query parameters: `all`, `older`, `newer` |
103103

104104
#### Examples
105105

0 commit comments

Comments
 (0)