> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAPI 規約

> Base URL、命名規則、タイムスタンプ、ページネーション、エラー、認証の規約。

以下の規約は、個別のエンドポイントドキュメントに記載がない限り、すべての Teams OpenAPI エンドポイントに適用されます。

## ベース URL

本番環境：

`https://api.qoder.com`

完全な URL の例：

`https://api.qoder.com/v1/organizations/{organization_id}/members`

## フィールド命名規則

JSON は **lowerCamelCase** を使用します。例：

`organizationId`、`repositoryUrl`、`createdAt`、`maxResults`、`nextToken`

## タイムスタンプ

**ISO 8601（RFC 3339）** 形式を使用します。例：`2025-01-01T00:00:00Z`。一部のクエリパラメータは **Unix ミリ秒タイムスタンプ** も受け付けます—各エンドポイントを確認してください。

## カーソルページネーション

リスト系エンドポイントは通常 **カーソル** ページネーションを使用します：

### クエリパラメータ

| パラメータ        | 型       | 必須  | デフォルト | 説明                         |
| ------------ | ------- | --- | ----- | -------------------------- |
| `maxResults` | integer | いいえ | 20    | ページサイズ、最大 **100**          |
| `nextToken`  | string  | いいえ | —     | 前回のレスポンスからのカーソル；最初のページでは省略 |

使用量エンドポイントでは、個別に記載がない限り **`nextToken`** をカーソルとして使用します。

### レスポンスフィールド

| フィールド        | 型       | 説明                        |
| ------------ | ------- | ------------------------- |
| `maxResults` | integer | このレスポンスで使用されたページサイズ       |
| `nextToken`  | string  | 次ページカーソル；**空または省略**はリスト終端 |

<Note>
  グローバルな `totalCount` に依存せず、カーソルが空になるまでページングしてください。
</Note>

## エラーレスポンス

失敗時、HTTP ステータスは非 2xx で、ボディはトップレベルの `status` フィールドを**含まない** JSON です。形式：

```json theme={null}
{
  "requestId": "req_abc123",
  "code": "NotFound",
  "message": "resource not found",
  "details": ["the requested resource does not exist"]
}
```

### エラーオブジェクトフィールド

| フィールド       | 型      | 必須  | 説明                         |
| ----------- | ------ | --- | -------------------------- |
| `requestId` | string | はい  | 関連 ID—サポートへの問い合わせ時に含めてください |
| `code`      | string | はい  | プログラム処理用の安定したコード           |
| `message`   | string | はい  | 人間が読める概要                   |
| `details`   | array  | いいえ | オプションの追加コンテキスト             |

### 一般的な HTTP ステータスと `code` 値

| HTTP | `code` 例        | 意味                  |
| ---- | --------------- | ------------------- |
| 400  | `BadRequest`    | 無効な入力               |
| 401  | `Unauthorized`  | API キーが欠落または無効      |
| 403  | `Forbidden`     | この組織またはリソースへのアクセス不可 |
| 404  | `NotFound`      | リソースが見つからない         |
| 409  | `AlreadyExists` | 競合                  |
| 500  | `InternalError` | サーバーエラー             |

<Note>
  ゲートウェイやサービスマッピング後、HTTP ステータスと `code` の組み合わせは**実際のレスポンス**で定義されます—ステータスだけに依存しないでください。
</Note>

## 認証

以下を送信してください：

```http theme={null}
Authorization: Bearer <api_key>
```

コンソールで作成したキーを使用します。実際のキーをパブリッククライアントやリポジトリに含めないでください。

## 組織パスプレフィックス

ほとんどのルートは以下を拡張します：

`/v1/organizations/{organization_id}`

`organization_id` はパスパラメータです。サブパスについては **メンバー**、**使用量**、**AI コード指標** セクションを参照してください。