ジャンプ先

• リクエスト
• レスポンス

すべてのバージョンのメタデータの取得

get

/omlmod/

OML Services APIの使用可能なすべてのバージョンを記述するメタデータを返します。

リクエスト

この操作にはリクエスト・パラメータはありません。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

使用可能なすべてのバージョンのリスト。

本文()

ルート・スキーマ : ApiVersionCollection

型: object

ソースの表示

• items(required): array items
• links(required): array links

{
    "required":[
        "items",
        "links"
    ],
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ApiVersion"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OMLResourceLink"
            }
        }
    }
}

ネストされたスキーマ : items

型: array

ソースの表示

• 配列: object ApiVersion

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ApiVersion"
    }
}

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object OMLResourceLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OMLResourceLink"
    }
}

ネストされたスキーマ : ApiVersion

型: object

ソースの表示

• isLatest(required): boolean
  これがAPIの最新バージョンである場合はTrue。
• lifecycle(required): string
  指定可能な値: [ "active", "deprecated" ]
• links(required): array links
• version(required): string
  このAPIのバージョン。

{
    "required":[
        "version",
        "isLatest",
        "lifecycle",
        "links"
    ],
    "properties":{
        "version":{
            "type":"string",
            "description":"Version of this API."
        },
        "isLatest":{
            "type":"boolean",
            "description":"True if this is the latest version of the API."
        },
        "lifecycle":{
            "type":"string",
            "enum":[
                "active",
                "deprecated"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OMLResourceLink"
            }
        }
    }
}

ネストされたスキーマ : links

型: array

ソースの表示

• 配列: object OMLResourceLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OMLResourceLink"
    }
}

ネストされたスキーマ : OMLResourceLink

型: object

ソースの表示

• href(required): string
• rel(required): string

{
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        }
    }
}

先頭に戻る