WSO2 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Service Catalog Services API

10 actions 10 updates phrasing extends openapi/wso2-services-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for WSO2's API. It is a proposal applied on top of the contract, not a document WSO2 publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/services'].get
$.paths['/services'].post
$.paths['/services/{serviceId}'].get
$.paths['/services/{serviceId}'].put
$.paths['/services/{serviceId}'].delete
$.paths['/services/{serviceId}/definition'].get
$.paths['/services/{serviceId}/usage'].get
$.paths['/services/import'].post
$.paths['/services/export'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Service Catalog Services API
  version: 1.0.0
extends: openapi/wso2-services-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/services'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the service catalog
      effect: read
      questions:
      - Which services are registered in our service catalog?
      - Can I find a service in the catalog by name and version?
      - Is there a way to filter catalog services by definition type, like OAS or WSDL?
      instructions:
      - text: Search the service catalog for services named {name}.
        slots:
          name: query.name
      - text: Find catalog services with definition type {definitionType}.
        slots:
          definitionType: query.definitionType
      - text: List all services in the service catalog.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/services'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a service to the service catalog
      effect: write
      questions:
      - How do I register a new service with its definition in the service catalog?
      - Can I add a catalog service by pasting the definition inline instead of uploading a file?
      instructions:
      - text: Add a new service to the catalog with metadata {serviceMetadata}.
        slots:
          serviceMetadata: requestBody.serviceMetadata
      - text: Register a catalog service using {serviceMetadata} and definition file {definitionFile}.
        slots:
          serviceMetadata: requestBody.serviceMetadata
          definitionFile: requestBody.definitionFile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/services/{serviceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a catalog service's details
      effect: read
      questions:
      - What details does the catalog hold for a specific service?
      - Can I look up one catalog service by its id?
      instructions:
      - text: Show details of catalog service {serviceId}.
        slots:
          serviceId: path.serviceId
      - text: Get service {serviceId} from the service catalog.
        slots:
          serviceId: path.serviceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/services/{serviceId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a catalog service
      effect: write
      questions:
      - How do I update a catalog service's metadata and definition?
      - Can I replace the definition of a service already in the catalog?
      instructions:
      - text: Update catalog service {serviceId} with metadata {serviceMetadata}.
        slots:
          serviceId: path.serviceId
          serviceMetadata: requestBody.serviceMetadata
      - text: Replace the definition of service {serviceId} with {definitionFile}.
        slots:
          serviceId: path.serviceId
          definitionFile: requestBody.definitionFile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/services/{serviceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a catalog service
      effect: destructive
      questions:
      - How do I remove a service from the service catalog?
      - Can a service be deleted from the catalog by its id?
      instructions:
      - text: Delete service {serviceId} from the service catalog.
        slots:
          serviceId: path.serviceId
      - text: Remove catalog service {serviceId}.
        slots:
          serviceId: path.serviceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/services/{serviceId}/definition'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a catalog service's definition
      effect: read
      questions:
      - Where can I download the API definition stored for a catalog service?
      - Can I read the raw definition file behind a service in the catalog?
      instructions:
      - text: Get the definition of catalog service {serviceId}.
        slots:
          serviceId: path.serviceId
      - text: Show the stored definition for service {serviceId}.
        slots:
          serviceId: path.serviceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/services/{serviceId}/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: List APIs that use a catalog service
      effect: read
      questions:
      - Which APIs are built on a particular catalog service?
      - Can I see the name, context and version of every API using a service?
      instructions:
      - text: List the APIs that use catalog service {serviceId}.
        slots:
          serviceId: path.serviceId
      - text: Show which APIs depend on service {serviceId}.
        slots:
          serviceId: path.serviceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/services/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a service from an archive
      effect: write
      questions:
      - How do I import a service into the catalog from a zip archive?
      - Can an imported service overwrite one with the same name and version?
      instructions:
      - text: Import the service archive {file} into the catalog.
        slots:
          file: requestBody.file
      - text: Import service archive {file} and overwrite any existing match ({overwrite}).
        slots:
          file: requestBody.file
          overwrite: query.overwrite
      method: generated
      generated: '2026-10-01'
- target: $.paths['/services/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a service as a zip archive
      effect: read
      questions:
      - How do I export a catalog service as a zip file?
      - Can I download a specific version of a service as an archive?
      instructions:
      - text: Export service {name} version {version} as a zip.
        slots:
          name: query.name
          version: query.version
      - text: Download the archive for catalog service {name} {version}.
        slots:
          name: query.name
          version: query.version
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/wso2-services-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.