| 1 | {"version":"1.9.0","commands":{"call":{"id":"call","description":"Call API endpoints","pluginName":"openapicmd","pluginType":"core","aliases":[],"examples":["$ openapi call -o getPets","$ openapi call -o getPet -p id=1","$ openapi call -o createPet -d '{ \"name\": \"Garfield\" }'"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"dereference":{"name":"dereference","type":"boolean","char":"D","description":"resolve $ref pointers","allowNo":false},"bundle":{"name":"bundle","type":"boolean","char":"B","description":"resolve remote $ref pointers","allowNo":false},"root":{"name":"root","type":"option","char":"R","description":"override API root path","helpValue":"/"},"header":{"name":"header","type":"option","char":"H","description":"add request headers when calling remote urls"},"validate":{"name":"validate","type":"boolean","char":"V","description":"validate against openapi schema","allowNo":false},"server":{"name":"server","type":"option","char":"S","description":"override servers definition","helpValue":"http://localhost:9000"},"operation":{"name":"operation","type":"option","char":"o","description":"operationId","helpValue":"operationId"},"param":{"name":"param","type":"option","char":"p","description":"parameter","helpValue":"key=value"},"data":{"name":"data","type":"option","char":"d","description":"request body"},"include":{"name":"include","type":"boolean","char":"i","description":"include status code and response headers the output","allowNo":false}},"args":[{"name":"definition","description":"input definition file"}]},"info":{"id":"info","description":"Display API information","pluginName":"openapicmd","pluginType":"core","aliases":[],"examples":["$ openapi info https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml","$ openapi info ./openapi.yml"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"dereference":{"name":"dereference","type":"boolean","char":"D","description":"resolve $ref pointers","allowNo":false},"bundle":{"name":"bundle","type":"boolean","char":"B","description":"resolve remote $ref pointers","allowNo":false},"root":{"name":"root","type":"option","char":"R","description":"override API root path","helpValue":"/"},"header":{"name":"header","type":"option","char":"H","description":"add request headers when calling remote urls"},"validate":{"name":"validate","type":"boolean","char":"V","description":"validate against openapi schema","allowNo":false},"server":{"name":"server","type":"option","char":"S","description":"override servers definition","helpValue":"http://localhost:9000"},"operations":{"name":"operations","type":"boolean","description":"list operations in document","allowNo":false},"schemas":{"name":"schemas","type":"boolean","description":"list schemas in document","allowNo":false}},"args":[{"name":"definition","description":"input definition file"}]},"init":{"id":"init","description":"Initialise a definition file from scratch","pluginName":"openapicmd","pluginType":"core","aliases":[],"examples":["$ openapi init --title 'My API' > openapi.yml"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"title":{"name":"title","type":"option","char":"T","description":"The title for the API","default":"My API"},"description":{"name":"description","type":"option","char":"d","description":"Description for the API"},"version":{"name":"version","type":"option","char":"v","description":"Version of the API","default":"0.0.1"},"terms":{"name":"terms","type":"option","description":"A URL to the Terms of Service for the API."},"license":{"name":"license","type":"option","description":"The license for the API","options":["mit","apache2"]},"server":{"name":"server","type":"option","char":"S","description":"override servers definition","helpValue":"http://localhost:9000"},"format":{"name":"format","type":"option","char":"f","description":"[default: yaml] output format","helpValue":"(json|yaml|yml)","options":["json","yaml","yml"]},"json":{"name":"json","type":"boolean","description":"format as json (short for -f json)","allowNo":false},"yaml":{"name":"yaml","type":"boolean","description":"format as yaml (short for -f yaml)","allowNo":false}},"args":[]},"load":{"id":"load","description":"Set the default definition file for a workspace (writes to .openapiconfig)","pluginName":"openapicmd","pluginType":"core","aliases":[],"examples":["$ openapi load ./openapi.yml","$ openapi load https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"validate":{"name":"validate","type":"boolean","char":"V","description":"validate against openapi schema","allowNo":false}},"args":[{"name":"definition","description":"input definition file","required":true}]},"mock":{"id":"mock","description":"Start a local mock API server","pluginName":"openapicmd","pluginType":"core","aliases":[],"examples":["$ openapi mock ./openapi.yml","$ openapi mock https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"port","helpValue":"9000","default":9000},"logger":{"name":"logger","type":"boolean","description":"[default: true] log requests","allowNo":true},"server":{"name":"server","type":"option","char":"S","description":"override servers definition","helpValue":"http://localhost:9000"},"header":{"name":"header","type":"option","char":"H","description":"add request headers when calling remote urls"},"root":{"name":"root","type":"option","char":"R","description":"override API root path","helpValue":"/"},"swagger-ui":{"name":"swagger-ui","type":"option","char":"U","description":"Swagger UI endpoint","helpValue":"docs"},"validate":{"name":"validate","type":"boolean","description":"[default: true] validate requests according to schema","allowNo":true}},"args":[{"name":"definition","description":"input definition file"}]},"read":{"id":"read","description":"Read and manipulate definition files","pluginName":"openapicmd","pluginType":"core","aliases":[],"examples":["$ openapi read https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml","$ openapi read ./openapi.yml -f json > openapi.json"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"dereference":{"name":"dereference","type":"boolean","char":"D","description":"resolve $ref pointers","allowNo":false},"bundle":{"name":"bundle","type":"boolean","char":"B","description":"resolve remote $ref pointers","allowNo":false},"root":{"name":"root","type":"option","char":"R","description":"override API root path","helpValue":"/"},"header":{"name":"header","type":"option","char":"H","description":"add request headers when calling remote urls"},"validate":{"name":"validate","type":"boolean","char":"V","description":"validate against openapi schema","allowNo":false},"server":{"name":"server","type":"option","char":"S","description":"override servers definition","helpValue":"http://localhost:9000"},"format":{"name":"format","type":"option","char":"f","description":"[default: yaml] output format","helpValue":"(json|yaml|yml)","options":["json","yaml","yml"]},"json":{"name":"json","type":"boolean","description":"format as json (short for -f json)","allowNo":false},"yaml":{"name":"yaml","type":"boolean","description":"format as yaml (short for -f yaml)","allowNo":false}},"args":[{"name":"definition","description":"input definition file"}]},"readme":{"id":"readme","pluginName":"openapicmd","pluginType":"core","hidden":true,"aliases":[],"flags":{},"args":[]},"swagger-editor":{"id":"swagger-editor","description":"Start a Swagger Editor instance","pluginName":"openapicmd","pluginType":"core","aliases":[],"examples":["$ openapi swagger-editor","$ openapi swagger-editor ./openapi.yml"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"port","helpValue":"9000","default":9000},"logger":{"name":"logger","type":"boolean","description":"[default: true] log requests","allowNo":true},"header":{"name":"header","type":"option","char":"H","description":"add request headers when calling remote urls"}},"args":[{"name":"definition","description":"input definition file"}]},"swagger-ui":{"id":"swagger-ui","description":"Start or bundle a Swagger UI instance","pluginName":"openapicmd","pluginType":"core","aliases":[],"examples":["$ openapi swagger-ui","$ openapi swagger-ui ./openapi.yml","$ openapi swagger-ui ./openapi.yml --bundle outDir"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"port","helpValue":"9000","default":9000},"logger":{"name":"logger","type":"boolean","description":"[default: true] log requests","allowNo":true},"server":{"name":"server","type":"option","char":"S","description":"override servers definition","helpValue":"http://localhost:9000"},"expand":{"name":"expand","type":"option","description":"[default: list] default expansion setting for the operations and tags","options":["full","list","none"]},"operationids":{"name":"operationids","type":"boolean","description":"[default: true] display operationIds","allowNo":true},"filter":{"name":"filter","type":"boolean","description":"[default: true] enable filtering by tag","allowNo":true},"deeplinks":{"name":"deeplinks","type":"boolean","description":"[default: true] allow deep linking","allowNo":true},"withcredentials":{"name":"withcredentials","type":"boolean","description":"[default: true] send cookies in \"try it now\"","allowNo":true},"requestduration":{"name":"requestduration","type":"boolean","description":"[default: true] display request durations in \"try it now\"","allowNo":true},"header":{"name":"header","type":"option","char":"H","description":"add request headers when calling remote urls"},"root":{"name":"root","type":"option","char":"R","description":"override API root path","helpValue":"/"},"bundle":{"name":"bundle","type":"option","char":"B","description":"bundle a static site to directory","helpValue":"outDir"},"proxy":{"name":"proxy","type":"boolean","description":"set up a proxy for the api to avoid CORS issues","allowNo":false}},"args":[{"name":"definition","description":"input definition file"}]},"swagger2openapi":{"id":"swagger2openapi","description":"Convert Swagger 2.0 definitions to OpenAPI 3.0.x","pluginName":"openapicmd","pluginType":"core","aliases":[],"examples":["$ openapi swagger2openapi --yaml ./swagger.json > openapi.yml"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"dereference":{"name":"dereference","type":"boolean","char":"D","description":"resolve $ref pointers","allowNo":false},"bundle":{"name":"bundle","type":"boolean","char":"B","description":"resolve remote $ref pointers","allowNo":false},"root":{"name":"root","type":"option","char":"R","description":"override API root path","helpValue":"/"},"header":{"name":"header","type":"option","char":"H","description":"add request headers when calling remote urls"},"validate":{"name":"validate","type":"boolean","char":"V","description":"validate against openapi schema","allowNo":false},"server":{"name":"server","type":"option","char":"S","description":"override servers definition","helpValue":"http://localhost:9000"},"format":{"name":"format","type":"option","char":"f","description":"[default: yaml] output format","helpValue":"(json|yaml|yml)","options":["json","yaml","yml"]},"json":{"name":"json","type":"boolean","description":"format as json (short for -f json)","allowNo":false},"yaml":{"name":"yaml","type":"boolean","description":"format as yaml (short for -f yaml)","allowNo":false}},"args":[{"name":"definition","description":"input definition file"}]},"unload":{"id":"unload","description":"Unset the default definition file for a workspace (writes to .openapiconfig)","pluginName":"openapicmd","pluginType":"core","aliases":[],"examples":["$ openapi unload"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]}}} |