Jump to Content
Home
Guides
Recipes
Endpoints
Updates
Forum
Custom HTML
v1.0
v2.0
v3.0
Log In
Endpoints
Log In
cookie
Home
Guides
Recipes
Endpoints
Updates
Forum
Custom HTML
Get doc
Search
JUMP TO
Swagger Petstore
Intro
pet
uploads an image
post
Add a new pet to the store
post
Update an existing pet
put
Finds Pets by status
get
Finds Pets by tags
get
Find pet by ID
get
Updates a pet in the store with form data
post
Deletes a pet
del
store
Place an order for a pet
post
Find purchase order by ID
get
Delete purchase order by ID
del
Returns pet inventories by status
get
user
Creates list of users with given input array
post
Creates list of users with given input array
post
Get user by user name
get
Updated user
put
Delete user
del
Logs user into the system
get
Logs out current logged in user session
get
Create user
post
RGD2
Test Path Params
get
API Endpoints
API Registry
Retrieve an entry from the API Registry
get
API Specification
Get metadata
get
Upload specification
post
Update specification
put
Delete specification
del
Apply to ReadMe
Submit your application!
post
Categories
Get all categories
get
Get category
get
Get docs for category
get
Changelog
Get changelogs
get
Create changelog
post
Get changelog
get
Update changelog
put
Delete changelog
del
Custom Pages
Get custom pages
get
Create custom page
post
Get custom page
get
Update custom page
put
Delete custom page
del
Docs
Get doc
get
Update doc
put
Delete doc
del
Create doc
post
Search docs
post
Errors
Get errors
get
Projects
Get metadata about the current project
get
Version
Get versions
get
Create version
post
Get version
get
Update version
put
Delete version
del
Support for parameter serialization
Cookie
Standard (no style)
get
Form (non-exploded)
get
Form (exploded)
get
Header
Standard (no style)
get
Simple (non-exploded)
get
Simple (exploded)
post
Path
Standard (no style)
get
Matrix (non-exploded)
get
Matrix (exploded)
post
Label (non-exploded)
get
Label (exploded)
post
Simple (non-exploded)
get
Simple (exploded)
post
Query
Standard (no style)
get
Form (non-exploded)
get
Form (exploded)
post
spaceDelimited (non-exploded)
get
pipeDelimited (non-exploded)
get
deepObject (exploded)
get
multipart/form-data Encoding
Standard (no encoding)
post
Form (non-exploded)
post
Form (exploded)
put
spaceDelimited (non-exploded)
get
pipeDelimited (non-exploded)
post
deepObject (exploded)
post
Get doc
get
https://dash.readme.com/api/v1/docs/
{slug}
Returns the doc with this slug
Language
Shell
Node
Ruby
PHP
Python
Credentials
Basic
base64
Basic
:
Response
Click
Try It!
to start a request and see the response here!