Edit

Share via

Adding an API to search

  • Article

The search command relies on multiple indices to find OpenAPI descriptions that can be used to generate clients. If you maintain APIs, you can add your own description to the results by updating one of the following indices:

GitHub

You can add your API descriptions to the search result by following these steps:

  1. Add the kiota-index topic to your GitHub repository.
  2. Add an apis.json or apis.yaml file at the root of your repository on your main branch.
  3. Make sure the repository has a description and:
    1. The repository is public
    2. Or the kiota GitHub application is installed on the repository, users are allowed to read the repository, and they are signed into kiota.

Example apis.yaml

name: Microsoft Graph OpenAPI registry
description: This repository contains the OpenAPI definitions for Microsoft Graph APIs.
tags:
- microsoft
apis:
- name: Microsoft Graph v1.0
  description: The Microsoft Graph API offers a single endpoint, to provide access to rich, people-centric data and insights in the Microsoft cloud.
  baseUrl: https://graph.microsoft.com/v1.0
  properties:
  - type: x-openapi
    url: openapi/v1.0/openapi.yaml # can be the relative path on the repository or a publicly accessible URL

Note

For more information about apis.yaml, see What is APIs.json?.

Example apis.json

{
    "name": "Microsoft Graph OpenAPI registry",
    "description": "This repository contains the OpenAPI definitions for Microsoft Graph APIs.",
    "tags": [
        "microsoft"
    ],
    "apis": [
        {
            "name": "Microsoft Graph v1.0",
            "description": "The Microsoft Graph API offers a single endpoint, to provide access to rich, people-centric data and insights in the Microsoft cloud.",
            "baseUrl": "https://graph.microsoft.com/v1.0",
            "properties": [
                {
                    "type": "x-openapi",
                    "url": "openapi/v1.0/openapi.yaml" // can be the relative path on the repository or a publicly accessible URL
                }
            ]
        }
    ]
}

Note

For more information about apis.json, see What is APIs.json?.

APIs guru

You can add your description to the APIs guru index by filling the following form.