# webstatus-openapi
A tool to monitor and track the status of all Web Platform features across dimensions that are related to availability and implementation quality across browsers, and adoption by web developers.


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 1.0.0
- Generator version: 7.6.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.7+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import webstatus_openapi
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import webstatus_openapi
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import webstatus_openapi
from webstatus_openapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.webstatus.dev
# See configuration.py for a list of all supported configuration parameters.
configuration = webstatus_openapi.Configuration(
    host = "https://api.webstatus.dev"
)



# Enter a context with an instance of the API client
with webstatus_openapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = webstatus_openapi.DefaultApi(api_client)
    feature_id = 'feature_id_example' # str | Feature ID
    wpt_metric_view = webstatus_openapi.WPTMetricView() # WPTMetricView |  (optional)

    try:
        # Get Feature
        api_response = api_instance.get_feature(feature_id, wpt_metric_view=wpt_metric_view)
        print("The response of DefaultApi->get_feature:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->get_feature: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.webstatus.dev*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**get_feature**](docs/DefaultApi.md#get_feature) | **GET** /v1/features/{feature_id} | Get Feature
*DefaultApi* | [**get_feature_metadata**](docs/DefaultApi.md#get_feature_metadata) | **GET** /v1/features/{feature_id}/feature-metadata | Get metadata for a given feature from github.com/web-platform-dx/web-features
*DefaultApi* | [**get_saved_search**](docs/DefaultApi.md#get_saved_search) | **GET** /v1/saved-searches/{search_id} | Get saved search
*DefaultApi* | [**list_aggregated_feature_support**](docs/DefaultApi.md#list_aggregated_feature_support) | **GET** /v1/stats/features/browsers/{browser}/feature_counts | Returns the count of features supported for a specified browser over time. The timestamps for the individual metrics represent the releases of the specified browser. 
*DefaultApi* | [**list_aggregated_wpt_metrics**](docs/DefaultApi.md#list_aggregated_wpt_metrics) | **GET** /v1/stats/wpt/browsers/{browser}/channels/{channel}/{metric_view} | Gets aggregated WPT test counts for a specified browser and channel. Optionally filter by feature IDs. 
*DefaultApi* | [**list_chromium_daily_usage_stats**](docs/DefaultApi.md#list_chromium_daily_usage_stats) | **GET** /v1/features/{feature_id}/stats/usage/chromium/daily_stats | Get Chromium daily usage metrics for a given feature
*DefaultApi* | [**list_feature_wpt_metrics**](docs/DefaultApi.md#list_feature_wpt_metrics) | **GET** /v1/features/{feature_id}/stats/wpt/browsers/{browser}/channels/{channel}/{metric_view} | Retrieve the wpt stats for a particular feature.
*DefaultApi* | [**list_features**](docs/DefaultApi.md#list_features) | **GET** /v1/features | List features
*DefaultApi* | [**list_missing_one_implemenation_counts**](docs/DefaultApi.md#list_missing_one_implemenation_counts) | **GET** /v1/stats/features/browsers/{browser}/missing_one_implementation_counts | Returns the count of features that are supported by all of the specified comparison browsers but not supported by the specified target browser, as of each browser&#39;s (target browser or comparison browser) release date. 
*DefaultApi* | [**list_saved_searches**](docs/DefaultApi.md#list_saved_searches) | **GET** /v1/saved-searches | List saved searches


## Documentation For Models

 - [BaselineInfo](docs/BaselineInfo.md)
 - [BasicErrorModel](docs/BasicErrorModel.md)
 - [BrowserImplementation](docs/BrowserImplementation.md)
 - [BrowserReleaseFeatureMetric](docs/BrowserReleaseFeatureMetric.md)
 - [BrowserReleaseFeatureMetricsPage](docs/BrowserReleaseFeatureMetricsPage.md)
 - [BrowserUsage](docs/BrowserUsage.md)
 - [CanIUseInfo](docs/CanIUseInfo.md)
 - [CanIUseItem](docs/CanIUseItem.md)
 - [ChromiumDailyStatsPage](docs/ChromiumDailyStatsPage.md)
 - [ChromiumUsageInfo](docs/ChromiumUsageInfo.md)
 - [ChromiumUsageStat](docs/ChromiumUsageStat.md)
 - [ExtendedErrorModel](docs/ExtendedErrorModel.md)
 - [Feature](docs/Feature.md)
 - [FeatureMetadata](docs/FeatureMetadata.md)
 - [FeaturePage](docs/FeaturePage.md)
 - [FeatureSpecInfo](docs/FeatureSpecInfo.md)
 - [FeatureWPTSnapshots](docs/FeatureWPTSnapshots.md)
 - [GenericUpdatableUniqueModel](docs/GenericUpdatableUniqueModel.md)
 - [PageMetadata](docs/PageMetadata.md)
 - [PageMetadataWithTotal](docs/PageMetadataWithTotal.md)
 - [SavedSearch](docs/SavedSearch.md)
 - [SavedSearchPage](docs/SavedSearchPage.md)
 - [SavedSearchResponse](docs/SavedSearchResponse.md)
 - [SpecLink](docs/SpecLink.md)
 - [SupportedBrowsers](docs/SupportedBrowsers.md)
 - [WPTFeatureData](docs/WPTFeatureData.md)
 - [WPTMetricView](docs/WPTMetricView.md)
 - [WPTRunMetric](docs/WPTRunMetric.md)
 - [WPTRunMetricsPage](docs/WPTRunMetricsPage.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author




