OpenAPI Specification
openapi: 3.1.0
info:
title: ReadMe Developer Metrics Analytics Guides API
description: The ReadMe Developer Metrics API powers the Developer Dashboard. It accepts API request logs from Metrics SDKs (Node.js, Python, Ruby, PHP, .NET) and exposes analytics including page quality scores, page view statistics, and search analytics so teams can investigate API usage by key or email and debug requests in real time.
version: '1.0'
contact:
name: ReadMe Support
url: https://docs.readme.com
servers:
- url: https://metrics.readme.io/v1
description: ReadMe Metrics API
security:
- basicAuth: []
tags:
- name: Guides
description: Manage knowledge base guide pages
paths:
/branches/{branch}/guides:
get:
tags:
- Guides
summary: List Guide Pages
parameters:
- name: branch
in: path
required: true
schema:
type: string
responses:
'200':
description: List of guides
post:
tags:
- Guides
summary: Create A Guide Page
parameters:
- name: branch
in: path
required: true
schema:
type: string
responses:
'201':
description: Created
/branches/{branch}/guides/{slug}:
get:
tags:
- Guides
summary: Get A Guide By Slug
parameters:
- name: branch
in: path
required: true
schema:
type: string
- name: slug
in: path
required: true
schema:
type: string
responses:
'200':
description: Guide page
put:
tags:
- Guides
summary: Update A Guide
parameters:
- name: branch
in: path
required: true
schema:
type: string
- name: slug
in: path
required: true
schema:
type: string
responses:
'200':
description: Updated
delete:
tags:
- Guides
summary: Delete A Guide
parameters:
- name: branch
in: path
required: true
schema:
type: string
- name: slug
in: path
required: true
schema:
type: string
responses:
'204':
description: Deleted
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
description: HTTP Basic auth using your ReadMe API key as the username (password blank).