openapi

Documentation

Overview

Package openapi provides search functionality over a pre-processed Microsoft Graph OpenAPI index.

Index

• type Endpoint
• type Index
  • func LoadIndex(path string) (*Index, error)
  • func (idx *Index) Search(query, resource, method string, limit int) []SearchResult
• type SearchResult

Types

type Endpoint

type Endpoint struct {
	Path        string   `json:"path"`
	Method      string   `json:"method"`
	Summary     string   `json:"summary"`
	Description string   `json:"description,omitempty"`
	Scopes      []string `json:"scopes,omitempty"`
	Resource    string   `json:"resource,omitempty"` // e.g. "users", "groups", "messages"
}

Endpoint represents a single API endpoint in the index.

type Index

type Index struct {
	Endpoints []Endpoint `json:"endpoints"`
}

Index holds the full searchable OpenAPI index.

func LoadIndex

func LoadIndex(path string) (*Index, error)

LoadIndex reads and parses the pre-processed OpenAPI index JSON file.

func (*Index) Search

func (idx *Index) Search(query, resource, method string, limit int) []SearchResult

Search finds endpoints matching the given criteria. All criteria are ANDed together. Empty criteria are ignored.

type SearchResult

type SearchResult struct {
	Endpoint
	MatchReason string `json:"matchReason"`
}

SearchResult wraps an endpoint with a relevance indicator.