OpenAPI file structure for Stoplight documentation
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- openapi, yaml
- 領域
- api, documentation
調査の方向性
この issue ではファイルもテストも指定されていません。まず現在の Stoplight/OpenAPI YAML レイアウトと CDS Events、Curb、Metrics API の定義を確認してください。各 API に専用の YAML ファイルがあり、共有モデルが一貫して参照されていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Is your feature request related to a problem? Please describe.
When we are building out the OpenAPI files within Stoplight, I believe we need to align on how we should structure the YAML files.
- Option A: 1 YAML file for all of the CDS APIs
- Option B: 1 YAML file for each of the CDS APIs
Describe the solution you'd like
I would like to pursue Option B which is the creation of a YAML file for each of the CDS APIs (Events, Curb, Metrics). This could make the documentation modular and easier to digest when being displayed through Stoplight.
Is this a breaking change
This isn't a breaking change since we have yet to finalize a full Open API version on our documentation
Impacted Spec
All APIs are impacted with this documentation standard.
Describe alternatives you've considered
We would want to use Stoplight to create shared models that can be referenced by multiple APIs if these are needed. This proposed structure does not conflict with previous decisions to maintain a single branch for each API version.
Additional context
Several members of the CDS WGSC collectively showed support for the option to move towards a model where 3 distinct files were used to document each API in the Oct 11th WGSC meeting.
- 主要言語
- JavaScript
- スター
- 7
- フォーク
- 0
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
openmobilityfoundation/cds-openapi のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
-
TODO: Update the text table for event_purpose.yaml再び着手できるかも @michael-danko-passport が 1154 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
openmobilityfoundation/cds-openapi#7 · コメント 1 件 · 担当者 1 名 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 32/100
openmobilityfoundation/cds-openapi#2 · コメント 1 件 ·
openmobilityfoundation/cds-openapi の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
pedroapfilho/localveil#120 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
ImpactMojo/ImpactMojo#1385 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
Seeed-Studio/wiki-documents#5974 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信