mirror of
https://github.com/postmanlabs/openapi-to-postman.git
synced 2022-11-29 22:05:00 +03:00
92 lines
2.0 KiB
YAML
92 lines
2.0 KiB
YAML
openapi: 3.0.0
|
|
info:
|
|
version: '1.1.1'
|
|
title: 'ExampleYaml'
|
|
license:
|
|
name: MIT
|
|
servers:
|
|
- url: 'localhost:3000'
|
|
paths:
|
|
/user:
|
|
get:
|
|
summary: 'Sample endpoint: Returns details about a particular user'
|
|
operationId: listUser
|
|
tags:
|
|
- user
|
|
parameters:
|
|
- name: id
|
|
in: query
|
|
description: ID of the user
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
format: int32
|
|
responses:
|
|
'200':
|
|
description: 'Sample response: Details about a user by ID'
|
|
headers:
|
|
x-next:
|
|
description: A link to the next page of responses
|
|
schema:
|
|
type: string
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/User'
|
|
example:
|
|
id: "5789-6378-6372-6372"
|
|
name: Vani
|
|
tag: true
|
|
value: QA
|
|
lastmodifieddate: "2022-03-30T07:01:46"
|
|
lastmodifiedBy: VM
|
|
default:
|
|
description: Unexpected error
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/Error'
|
|
components:
|
|
schemas:
|
|
User:
|
|
type: object
|
|
required:
|
|
- id
|
|
- name
|
|
- tag
|
|
- value
|
|
- lastmodifieddate
|
|
- lastmodifiedBy
|
|
properties:
|
|
id:
|
|
type: integer
|
|
format: int64
|
|
name:
|
|
type: string
|
|
tag:
|
|
type: string
|
|
value:
|
|
type: string
|
|
lastmodifieddate:
|
|
type: integer
|
|
format: int64
|
|
lastmodifiedBy:
|
|
type: string
|
|
Error:
|
|
type: object
|
|
required:
|
|
- code
|
|
- message
|
|
properties:
|
|
code:
|
|
type: integer
|
|
format: int32
|
|
message:
|
|
type: string
|
|
securitySchemes:
|
|
BasicAuth:
|
|
type: http
|
|
scheme: basic
|
|
security:
|
|
- BasicAuth: []
|