LukeParke/openapi-types
1
0
Fork 0
mirror of https://github.com/LukeHagar/openapi-types.git synced 2025-12-10 04:20:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add new OpenAPI 2.0 and 3.0 specifications, including comprehensive type definitions and example files. Update .gitignore and bunfig.toml, and remove obsolete MIGRATION.md. Enhance README with additional usage examples and clarify type definitions.

Browse Source
This commit is contained in:
Luke Hagar
2025-09-25 14:57:24 +00:00
parent 3d0a7a3e3f
commit adc25abc0b
181 changed files with 30313 additions and 14953 deletions
Download Patch File Download Diff File Expand all files Collapse all files

194
tests/3.0/api-with-examples.ts Normal file
View File

@@ -0,0 +1,194 @@
import type { Specification } from "../../3.0";
const _apiWithExamples: Specification = {
openapi: "3.0.0",
info: {
title: "Simple API overview",
version: "2.0.0",
},
paths: {
"/": {
get: {
operationId: "listVersionsv2",
summary: "List API versions",
responses: {
"200": {
description: "200 response",
content: {
"application/json": {
examples: {
foo: {
value: {
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: "300 response",
content: {
"application/json": {
examples: {
foo: {
value: {
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",
responses: {
"200": {
description: "200 response",
content: {
"application/json": {
examples: {
foo: {
value: {
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: "203 response",
content: {
"application/json": {
examples: {
foo: {
value: {
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",
},
],
},
},
},
},
},
},
},
},
},
},
},
};