Skip to content

Commit 535ea35

Browse files
ota-meshiota-meshi
committed
fix head.meta
1 parent 5295366 commit 535ea35

10 files changed

+94
-84
lines changed

‎documents/forAWSResource/AWSインフラリソース命名規約.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
sidebarDepth: 4
33
title: AWSインフラ命名規約
44
author: フューチャー株式会社
5-
meta:
6-
- name: keywords
7-
content: AWS,命名規約,コーディング規約
5+
head:
6+
- - meta
7+
- name: keywords
8+
content: AWS,命名規約,コーディング規約
89
---
910

1011
<page-title/>

‎documents/forGitBranch/git_branch_standards.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
sidebarDepth: 4
33
title: Gitブランチフロー規約
44
author: フューチャー株式会社
5-
meta:
6-
- name: keywords
7-
content: Git
5+
head:
6+
- - meta
7+
- name: keywords
8+
content: Git
89
---
910

1011
<page-title/>

‎documents/forJava/Javaコーディング規約.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
sidebarDepth: 4
33
title: Javaコーディング規約
44
author: Future Enterprise Coding Standards
5-
meta:
6-
- name: keywords
7-
content: Javaコーディング規約,Java17,コーディング規約,Java
5+
head:
6+
- - meta
7+
- name: keywords
8+
content: Javaコーディング規約,Java17,コーディング規約,Java
89
---
910

1011
<page-title/>

‎documents/forJava/Javaコーディング規約_for_11.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
sidebarDepth: 4
33
title: Javaコーディング規約 for Java11
44
author: Future Enterprise Coding Standards
5-
meta:
6-
- name: keywords
7-
content: Javaコーディング規約,Java11,コーディング規約,Java,Java9
5+
head:
6+
- - meta
7+
- name: keywords
8+
content: Javaコーディング規約,Java11,コーディング規約,Java,Java9
89
---
910

1011
<page-title/>

‎documents/forJava/Javaコーディング規約_for_8.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
sidebarDepth: 4
33
title: Javaコーディング規約 for Java8
44
author: Future Enterprise Coding Standards
5-
meta:
6-
- name: keywords
7-
content: Javaコーディング規約,Java8,コーディング規約,Java
5+
head:
6+
- - meta
7+
- name: keywords
8+
content: Javaコーディング規約,Java8,コーディング規約,Java
89
---
910

1011
<page-title/>

‎documents/forOpenAPISpecification/OpenAPI_Specification_2.0.md‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
sidebarDepth: 4
33
title: OpenAPI Specification 2.0規約
44
author: フューチャー株式会社
5-
meta:
6-
- name: keywords
7-
content: OpenAPI,Swagger,命名規約,コーディング規約
5+
head:
6+
- - meta
7+
- name: keywords
8+
content: OpenAPI,Swagger,命名規約,コーディング規約
89
---
910

1011
<page-title/>
@@ -132,14 +133,14 @@ definitions:
132133
info オブジェクトには Web API に関するメタデータを記載する。
133134
`title`, `description`, `version` を必須項目とする。
134135

135-
| フィールド名 | 必須 | 記載内容 |
136-
| -------------- | :--: | -------------------------------- |
137-
| title | ○ | Web API の総称 |
138-
| description | ○ | Web API の簡単な説明 |
139-
| version | ○ | OpenAPI ドキュメントのバージョン |
140-
| termsOfService | | 利用規約の URL |
141-
| contact | | 連絡先情報 |
142-
| license | | ライセンス情報 |
136+
| フィールド名 | 必須 | 記載内容 |
137+
| -------------- | :---: | -------------------------------- |
138+
| title | ○ | Web API の総称 |
139+
| description | ○ | Web API の簡単な説明 |
140+
| version | ○ | OpenAPI ドキュメントのバージョン |
141+
| termsOfService | | 利用規約の URL |
142+
| contact | | 連絡先情報 |
143+
| license | | ライセンス情報 |
143144

144145
### title
145146

‎documents/forOpenAPISpecification/OpenAPI_Specification_3.0.3.md‎

Lines changed: 46 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
sidebarDepth: 4
33
title: OpenAPI Specification 3.0.3規約
44
author: フューチャー株式会社
5-
meta:
6-
- name: keywords
7-
content: OpenAPI,命名規約,コーディング規約
5+
head:
6+
- - meta
7+
- name: keywords
8+
content: OpenAPI,命名規約,コーディング規約
89
---
910

1011
<page-title/>
@@ -39,16 +40,16 @@ OpenAPI ドキュメントを構成する要素はオブジェクトと呼ばれ
3940

4041
各オブジェクトの詳細については[公式ドキュメント](https://spec.openapis.org/oas/v3.0.3#openapi-object)を参照されたい。
4142

42-
| フィールド名 | 必須 | 説明 |
43-
| ------------ | :--: | ----------------------------------------------------------- |
44-
| openapi | ○ | OpenAPI ドキュメントが使用する OpenAPI 仕様のバージョン番号 |
45-
| info | ○ | API に関するメタデータ |
46-
| servers | | API サーバへの接続情報 |
47-
| paths | ○ | API の利用可能なパスと操作方法 |
48-
| components | | 複数の API における共通の定義 |
49-
| security | | API 全体で利用可能なセキュリティ（認証）機構 |
50-
| tags | | 各種 API をグルーピングするためのタグ |
51-
| externalDocs | | 追加の外部ドキュメント |
43+
| フィールド名 | 必須 | 説明 |
44+
| ------------ | :---: | ----------------------------------------------------------- |
45+
| openapi | ○ | OpenAPI ドキュメントが使用する OpenAPI 仕様のバージョン番号 |
46+
| info | ○ | API に関するメタデータ |
47+
| servers | | API サーバへの接続情報 |
48+
| paths | ○ | API の利用可能なパスと操作方法 |
49+
| components | | 複数の API における共通の定義 |
50+
| security | | API 全体で利用可能なセキュリティ（認証）機構 |
51+
| tags | | 各種 API をグルーピングするためのタグ |
52+
| externalDocs | | 追加の外部ドキュメント |
5253

5354
# 要素規約
5455

@@ -78,14 +79,14 @@ openapi: 3.0
7879

7980
`title`, `description`, `version` を必須項目とする。
8081

81-
| フィールド名 | 必須 | 記載内容 |
82-
| -------------- | :--: | -------------------------------- |
83-
| title | ○ | Web API の総称 |
84-
| description | ○ | Web API の簡単な説明 |
85-
| version | ○ | OpenAPI ドキュメントのバージョン |
86-
| termsOfService | | 利用規約の URL |
87-
| contact | | 連絡先情報 |
88-
| license | | ライセンス情報 |
82+
| フィールド名 | 必須 | 記載内容 |
83+
| -------------- | :---: | -------------------------------- |
84+
| title | ○ | Web API の総称 |
85+
| description | ○ | Web API の簡単な説明 |
86+
| version | ○ | OpenAPI ドキュメントのバージョン |
87+
| termsOfService | | 利用規約の URL |
88+
| contact | | 連絡先情報 |
89+
| license | | ライセンス情報 |
8990

9091
### info > title
9192

@@ -229,20 +230,20 @@ API の利用可能なエンドポイントと操作方法を記載する。
229230

230231
- HTTP メソッドの配下に定義されるオペレーションオブジェクトは、下記の項目を必須項目とする
231232

232-
| フィールド名 | 必須 | 記載内容 |
233-
|--------------| :--: |------------------------|
234-
| tags | ○ | API の論理的なグループ |
235-
| summary | ○ | API の操作概要 |
236-
| description | ○ | API の振る舞いの詳細や注意点 |
237-
| externalDocs | | API に関する追加の文書 |
238-
| operationId | ○ | API の利用可能なエンドポイントと操作方法 |
239-
| parameters | | API のリクエストパラメータ |
240-
| requestBody | | API のリクエストボディ |
241-
| responses | ○ | API のレスポンス |
242-
| callbacks | | |
243-
| deprecated | | API が非推奨であることの宣言 |
244-
| security | | API のセキュリティ機構 |
245-
| servers | | API に対応する代替サーバ |
233+
| フィールド名 | 必須 | 記載内容 |
234+
| ------------ | :---: | ---------------------------------------- |
235+
| tags | ○ | API の論理的なグループ |
236+
| summary | ○ | API の操作概要 |
237+
| description | ○ | API の振る舞いの詳細や注意点 |
238+
| externalDocs | | API に関する追加の文書 |
239+
| operationId | ○ | API の利用可能なエンドポイントと操作方法 |
240+
| parameters | | API のリクエストパラメータ |
241+
| requestBody | | API のリクエストボディ |
242+
| responses | ○ | API のレスポンス |
243+
| callbacks | | |
244+
| deprecated | | API が非推奨であることの宣言 |
245+
| security | | API のセキュリティ機構 |
246+
| servers | | API に対応する代替サーバ |
246247

247248
### paths > {path} > {method} > tags
248249

@@ -618,17 +619,17 @@ API の認証方式を記載する。
618619

619620
API 定義で利用する共通のデータモデルを定義する。定義方針は下記の通りである。
620621

621-
| フィールド名 | 方針 |
622-
|-----------------|------------------------------------------------|
622+
| フィールド名 | 方針 |
623+
| --------------- | -------------------------------------------------------------------------------------- |
623624
| schemas | API 共通的なリソース（例. ユーザや商品など）やエラー等のドメインオブジェクトを定義する |
624-
| responses | API 共通的なレスポンス（例. 異常系（`4xx`, `5xx`）のレスポンス）を定義する |
625-
| parameters | API 共通的なリクエストパラメータ（HTTP ヘッダやクエリパラメータ等）を定義する |
626-
| examples | 原則何も定義しない |
627-
| requestBodies | 原則何も定義せず、リクエストボディは API 個別に定義する |
628-
| headers | API 共通的なレスポンスヘッダを定義する |
629-
| securitySchemes | 標準で用いる API 認証のスキームを定義する |
630-
| links | 原則何も定義しない |
631-
| callbacks | 原則何も定義しない |
625+
| responses | API 共通的なレスポンス（例. 異常系（`4xx`, `5xx`）のレスポンス）を定義する |
626+
| parameters | API 共通的なリクエストパラメータ（HTTP ヘッダやクエリパラメータ等）を定義する |
627+
| examples | 原則何も定義しない |
628+
| requestBodies | 原則何も定義せず、リクエストボディは API 個別に定義する |
629+
| headers | API 共通的なレスポンスヘッダを定義する |
630+
| securitySchemes | 標準で用いる API 認証のスキームを定義する |
631+
| links | 原則何も定義しない |
632+
| callbacks | 原則何も定義しない |
632633

633634
※ リクエストボディやレスポンスボディにおいてオブジェクトがネストする場合、 API 固有のオブジェクトであっても `schemas` に定義する。
634635
これは、定義するオブジェクトの `properties` 配下に更に `type: object` が定義される場合に、生成ツールによってはうまく型が生成されないためである。

‎documents/forSQL/SQLコーディング規約（Oracle）.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
sidebarDepth: 4
33
title: SQLコーディング規約（Oracle）
44
author: Future Enterprise Coding Standards
5-
meta:
6-
- name: keywords
7-
content: SQLコーディング規約,Oracle,コーディング規約,SQL
5+
head:
6+
- - meta
7+
- name: keywords
8+
content: SQLコーディング規約,Oracle,コーディング規約,SQL
89
---
910

1011
<page-title/>

‎documents/forSQL/SQLコーディング規約（PostgreSQL）.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
sidebarDepth: 4
33
title: SQLコーディング規約（PostgreSQL）
44
author: Future Enterprise Coding Standards
5-
meta:
6-
- name: keywords
7-
content: SQLコーディング規約,PostgreSQL,コーディング規約,SQL
5+
head:
6+
- - meta
7+
- name: keywords
8+
content: SQLコーディング規約,PostgreSQL,コーディング規約,SQL
89
---
910

1011
<page-title/>

‎documents/forSlack/slack_usage_guidelines.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
sidebarDepth: 4
33
title: Slack利用ガイドライン
44
author: フューチャー株式会社
5-
meta:
6-
- name: keywords
7-
content: Slack
5+
head:
6+
- - meta
7+
- name: keywords
8+
content: Slack
89
---
910

1011
<page-title/>
@@ -200,10 +201,10 @@ timesスレッドでメンションを飛ばすと、その後の投稿によっ
200201

201202
チャンネルのメッセージ（スレッド先頭の投稿）では、話題を端的に表現する。ただし、返信スレッドの中を確認しないと内容が分からないようなメッセージ（タイトル）は非推奨とする。
202203

203-
| | メッセージ（スレッド先頭の投稿） |
204-
| :---- | :---- |
205-
| ✅推奨例 | @mirai チケット \#4191 foo bar failed のビルドエラーの解消についての相談です。スタックトレースはスレッド内に記載します |
206-
| ❌非推奨例 | レビュー依頼 |
204+
| | メッセージ（スレッド先頭の投稿） |
205+
| :-------- | :--------------------------------------------------------------------------------------------------------------------- |
206+
| ✅推奨例 | @mirai チケット \#4191 foo bar failed のビルドエラーの解消についての相談です。スタックトレースはスレッド内に記載します |
207+
| ❌非推奨例 | レビュー依頼 |
207208

208209
なお、メンションはメッセージ（スレッド先頭）に付けるか、返信スレッド内に付けるかは任意とする。
209210

0 commit comments

Comments
 (0)