mirror of
https://github.com/LukeHagar/openapi-types.git
synced 2025-12-06 12:37:47 +00:00
148 lines
4.9 KiB
TypeScript
148 lines
4.9 KiB
TypeScript
import type { Specification } from "../../2.0";
|
|
|
|
export const apiWithExamples: Specification = {
|
|
swagger: "2.0",
|
|
info: {
|
|
title: "Simple API overview",
|
|
version: "v2",
|
|
},
|
|
paths: {
|
|
"/": {
|
|
get: {
|
|
operationId: "listVersionsv2",
|
|
summary: "List API versions",
|
|
produces: ["application/json"],
|
|
responses: {
|
|
"200": {
|
|
description: "200 300 response",
|
|
examples: {
|
|
"application/json": {
|
|
versions: [
|
|
{
|
|
status: "CURRENT",
|
|
updated: "2011-01-21T11:33:21Z",
|
|
id: "v2.0",
|
|
links: [{ href: "http://127.0.0.1:8774/v2/", rel: "self" }],
|
|
},
|
|
{
|
|
status: "EXPERIMENTAL",
|
|
updated: "2013-07-23T11:33:21Z",
|
|
id: "v3.0",
|
|
links: [{ href: "http://127.0.0.1:8774/v3/", rel: "self" }],
|
|
},
|
|
],
|
|
},
|
|
},
|
|
},
|
|
"300": {
|
|
description: "200 300 response",
|
|
examples: {
|
|
"application/json": {
|
|
versions: [
|
|
{
|
|
status: "CURRENT",
|
|
updated: "2011-01-21T11:33:21Z",
|
|
id: "v2.0",
|
|
links: [{ href: "http://127.0.0.1:8774/v2/", rel: "self" }],
|
|
},
|
|
{
|
|
status: "EXPERIMENTAL",
|
|
updated: "2013-07-23T11:33:21Z",
|
|
id: "v3.0",
|
|
links: [{ href: "http://127.0.0.1:8774/v3/", rel: "self" }],
|
|
},
|
|
],
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"/v2": {
|
|
get: {
|
|
operationId: "getVersionDetailsv2",
|
|
summary: "Show API version details",
|
|
produces: ["application/json"],
|
|
responses: {
|
|
"200": {
|
|
description: "200 203 response",
|
|
examples: {
|
|
"application/json": {
|
|
version: {
|
|
status: "CURRENT",
|
|
updated: "2011-01 - 21T11: 33: 21Z",
|
|
"media - types": [
|
|
{
|
|
base: "application / xml",
|
|
type: "application / vnd.openstack.compute + xml; version=2",
|
|
},
|
|
{
|
|
base: "application / json",
|
|
type: "application / vnd.openstack.compute + json; version=2",
|
|
},
|
|
],
|
|
id: "v2.0",
|
|
links: [
|
|
{ href: "http://127.0.0.1:8774/v2/", rel: "self" },
|
|
{
|
|
href: "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf",
|
|
type: "application/pdf",
|
|
rel: "describedby",
|
|
},
|
|
{
|
|
href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
|
|
type: "application/vnd.sun.wadl+xml",
|
|
rel: "describedby",
|
|
},
|
|
{
|
|
href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
|
|
type: "application/vnd.sun.wadl+xml",
|
|
rel: "describedby",
|
|
},
|
|
],
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"203": {
|
|
description: "200 203 response",
|
|
examples: {
|
|
"application/json": {
|
|
version: {
|
|
status: "CURRENT",
|
|
updated: "2011-01 - 21T11: 33: 21Z",
|
|
"media - types": [
|
|
{
|
|
base: "application / xml",
|
|
type: "application / vnd.openstack.compute + xml; version=2",
|
|
},
|
|
{
|
|
base: "application / json",
|
|
type: "application / vnd.openstack.compute + json; version=2",
|
|
},
|
|
],
|
|
id: "v2.0",
|
|
links: [
|
|
{ href: "http://23.253.228.211:8774/v2/", rel: "self" },
|
|
{
|
|
href: "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf",
|
|
type: "application/pdf",
|
|
rel: "describedby",
|
|
},
|
|
{
|
|
href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl",
|
|
type: "application/vnd.sun.wadl+xml",
|
|
rel: "describedby",
|
|
},
|
|
],
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
consumes: ["application/json"],
|
|
};
|