Skip to content
Kong Gateway 2.8 Increases Security and Simplifies API Management.  —Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Konnect Cloud
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Kong Konnect Platform

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Request Demo
  • Kong Gateway
  • Konnect Cloud
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Kong Konnect Platform

  • Docs contribution guidelines
    • Using the Konnect Docs
    • Key Concepts and Terms
    • Access a Konnect Account
      • Manage a Konnect Account or Plan
      • Change to a Different Plan
      • Manage Payment Methods and Invoices
      • Manage Users and Roles
      • Set up SSO with Okta
    • Account and Org Deactivation
    • License Management
    • Port and Network Requirements
    • Network Resiliency and Availability
    • Migrate from Kong Gateway to Konnect Cloud
      • Set up a Runtime
      • Configure a Service
      • Implement and Test the Service
    • Manage Konnect Cloud with decK
    • Manage Services
      • Manage Service Documentation
      • Publish a Service to Dev Portal
      • Docker
      • Kubernetes
      • Linux
      • Runtime Parameter Reference
    • Upgrade a Runtime to a New Version
    • Renew Certificates
      • Developer Registration
      • Manage Developer Access
      • Auto Approve Dev and App Registrations
      • Application Overview
      • Create, Edit, and Delete an Application
      • Enable App Registration
      • Disable App Registration
      • Manage Application Registration Requests
      • Manage Application Connections
      • Register an Application with a Service
      • Generate Credentials for an Application
      • Appearance
      • Public Portal
      • Add a Custom Domain
    • Generating Vitals Reports
    • Configure a Plugin on a Service
    • Configure a Plugin on a Route
    • Configure Global or Consumer Plugins
    • Proxy Traffic
      • Konnect API Reference

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this page
  • Service Descriptions
    • Add a Markdown File for a Service
    • Update or Delete a Markdown File for a Service
  • Version Specs
    • Upload a Version Spec
    • Update or Delete a Version Spec
Konnect Cloud
  • Kong Konnect Platform
  • Konnect Cloud
  • ServiceHub
  • Dev portal

Dev Portal Service Documentation

Upload documentation for your Services through ServiceHub to display it on the Dev Portal.

You can upload Service descriptions and version specs. At a minimum, we recommend uploading an API spec for each Service version.

After adding documentation for your Services, publish them to the Dev Portal.

Service Descriptions

Provide extended descriptions of your Services with Markdown. The description applies to the whole Service, and appears on every version of that Service in the Dev Portal.

Add a Markdown File for a Service

  1. From the left navigation menu, open the Services page.

  2. Select a Service to open its overview.

  3. In the Service Document section, click Upload Document.

  4. Select an .md file to upload. Click Open.

Update or Delete a Markdown File for a Service

Upload a new document to replace an existing Service document.

  1. From the Services page, select a Service to open its overview.

  2. In the Service Document section:

    • To upload a new file, click the file icon, then Replace. Select a new .md file to upload.
    • To delete the file, click the gear icon, then Delete. Click Delete again to confirm.

Version Specs

Upload a spec to document a Service version.

Konnect accepts OpenAPI (Swagger) specs in YAML or JSON format.

Upload a Version Spec

  1. From the left navigation menu, open the Services page.

  2. Open a Service version.

  3. In the Version Spec section, click Upload Spec.

  4. Select a spec file to upload.

    The spec must be in YAML or JSON format. To test this functionality, you can use vitalsSpec.yaml as a sample spec.

    If the Service was previously published to the Dev Portal, the documentation for the Service gets automatically updated with your changes. If not, publish the Service.

Update or Delete a Version Spec

  1. From the left navigation menu, open the Services page.

  2. Open a Service version.

  3. In the Version Spec section:

    • Click the spec to update it, then click Replace. Choose a new YAML or JSON spec to replace the existing one.

    • Or, click the gear icon > Delete to remove the spec.

    The published documentation for the Service gets automatically updated with your changes.

Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2022