Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WSO2 API Documents API

The API Documents API from WSO2 — 3 operation(s) for api documents.

WSO2 API Documents API is one of 90 APIs that WSO2 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include API Documents. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version v4.

Requests are made against a single base URL, https://apis.wso2.com/api/am/admin/v4.

3 operations 3 paths 5 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v4
Base URL
https://apis.wso2.com
Authentication
OAuth 2.0
Contact
License
Resource Areas
1

Authentication & Security 1

WSO2 API Documents API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the password flow, exposing 41 scopes.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

API Documents 3
GET
/apis/{apiId}/documents
Get a List of Documents of an API
5 params → 200304404406
GET
/apis/{apiId}/documents/{documentId}
Get a Document of an API
4 params → 200304404406
GET
/apis/{apiId}/documents/{documentId}/content
Get the Content of an API Document
4 params → 200303304404406

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Document (7 properties), Error (5 properties), Pagination (5 properties), DocumentList (3 properties). Each schema is shown below with its type and property counts.

Document
object
7 properties 3 required
ErrorListItem
object
2 properties 2 required
Pagination
object
5 properties
Error
object
5 properties 2 required
DocumentList
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wso2-api-documents-api-openapi.yml Raw ↑

Other APIs WSO2 publishes across the network.

WSO2 Advanced Policy (Collection) API
WSO2 Advanced Policy (Individual) API
WSO2 AIServiceProvider API
WSO2 AIServiceProviders API
WSO2 Alert Subscriptions API
WSO2 Alerts API
WSO2 Api Artifact API
WSO2 API Categories API
WSO2 API Category (Collection) API
WSO2 API Category (Individual) API
WSO2 API Chat API
WSO2 API Monetization API