Files
OpenBB/website/content/platform/developer_guide/command_coverage.mdx
Danglewood 3a8a71dd15 [Docs] Refactor Docs Pages For Diataxis (#6315)
* This change creates a PR

* start moving stuff around

* data_models/_category_.json

* reference/_category_.json

* moving some stuff around

* Introduction

* Documentation updates

* few broken links, clean up sidebar titles for how-to

* codespell

* quickstart - new provider extension

* add a comment

* map provider interface

* quickstart for new router extension

* [Docs] diataxis refactor refactor (#6425)

* Start refactor

* Edits

* [DOCS] Reorganize and edit. Fix sidebar navigation (#6445)

* Reorganize and edit. Fix sidebar navigation

* Fix broken linkages

* Edit

---------

Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>

* Fix links

---------

Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>

* Fix broken links

* Reword CLA part in the Licensing FAQ

* change titles and order suggestion - cc @IgorWounds @piiq

---------

Co-authored-by: Igor Radovanovic <74266147+IgorWounds@users.noreply.github.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Theodore Aptekarev <aptekarev@gmail.com>
Co-authored-by: hjoaquim <henriquecjoaquim@gmail.com>
2024-05-22 13:50:43 +00:00

39 lines
949 B
Plaintext
Vendored

---
title: Command Coverage
sidebar_position: 6
description: This page details the instructions for determining the command coverage provided by the installed extensions.
keywords:
- tutorial
- standardized output
- OBBject
- provider
- results
- warnings
- chart
- extra
- command coverage
---
## Commands and Provider Coverage
The installed commands and data providers are found under, `obb.coverage`.
```python
obb.coverage
```
```console
/coverage
providers
commands
command_model
command_schemas
```
`obb.coverage.providers` is a dictionary of the installed provider extensions, each with its own list of available commands.
`obb.coverage.commands` is a dictionary of commands, each with its own list of available providers for the data.
`obb.coverage.command_model` is a dictionary where the keys are the command paths and the values is a nested dictionary of QueryParams and Data models associated with that function.