Try referencing the README in github

ElyxorCorp · Jan 31, 2024 · 94ecadc · 94ecadc
1 parent 3816a52
commit 94ecadc
Show file tree

Hide file tree

Showing 41 changed files with 3,285 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -20,7 +20,6 @@ build.sbt
 
 # swagger
 .swagger-codegen/
-docs/
 generated/
 python-client/
 

diff --git a/PYPI-README.md b/PYPI-README.md
@@ -0,0 +1,12 @@
+# cachethq-client
+A Python package with client-side methods for the Cachet Status Page https://cachethq.io/
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
+
+## Requirements.
+
+Python 3.7+
diff --git a/api-doc/README.md b/api-doc/README.md
@@ -0,0 +1,178 @@
+# cachethq-client
+A java-friendly swagger documentation file based on the documentation for the Cachet Status Page https://cachethq.io/
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
+
+## 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 cachethq_client
+```
+
+### 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 cachethq_client
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import time
+import cachethq_client
+from cachethq_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to /api/v1
+# See configuration.py for a list of all supported configuration parameters.
+configuration = cachethq_client.Configuration(
+    host = "/api/v1"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure API key authorization: apiKey
+configuration.api_key['apiKey'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['apiKey'] = 'Bearer'
+
+
+# Enter a context with an instance of the API client
+with cachethq_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = cachethq_client.ComponentGroupsApi(api_client)
+    body = cachethq_client.ComponentGroup() # ComponentGroup | Component Group to be created.
+
+    try:
+        # Create a new Component Group.
+        api_response = api_instance.create_component_group(body)
+        print("The response of ComponentGroupsApi->create_component_group:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling ComponentGroupsApi->create_component_group: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to */api/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*ComponentGroupsApi* | [**create_component_group**](docs/ComponentGroupsApi.md#create_component_group) | **POST** /components/groups | Create a new Component Group.
+*ComponentGroupsApi* | [**delete_component_group_by_id**](docs/ComponentGroupsApi.md#delete_component_group_by_id) | **DELETE** /components/groups/{group} | Delete a Component Group.
+*ComponentGroupsApi* | [**get_component_group_by_id**](docs/ComponentGroupsApi.md#get_component_group_by_id) | **GET** /components/groups/{group} | Get a Component Group.
+*ComponentGroupsApi* | [**get_component_groups**](docs/ComponentGroupsApi.md#get_component_groups) | **GET** /components/groups | Get all Component Groups.
+*ComponentGroupsApi* | [**update_component_group_by_id**](docs/ComponentGroupsApi.md#update_component_group_by_id) | **PUT** /components/groups/{group} | Update a Component Group.
+*ComponentsApi* | [**create_component**](docs/ComponentsApi.md#create_component) | **POST** /components | Create a new component.
+*ComponentsApi* | [**delete_component_by_id**](docs/ComponentsApi.md#delete_component_by_id) | **DELETE** /components/{component} | Delete a component.
+*ComponentsApi* | [**get_component_by_id**](docs/ComponentsApi.md#get_component_by_id) | **GET** /components/{component} | Get a component.
+*ComponentsApi* | [**get_components**](docs/ComponentsApi.md#get_components) | **GET** /components | Get all components.
+*ComponentsApi* | [**update_component_by_id**](docs/ComponentsApi.md#update_component_by_id) | **PUT** /components/{component} | Update a component.
+*GeneralApi* | [**ping**](docs/GeneralApi.md#ping) | **GET** /ping | Test that the API is responding to your requests.
+*GeneralApi* | [**version**](docs/GeneralApi.md#version) | **GET** /version | Get the Cachet version.
+*IncidentsApi* | [**create_incident**](docs/IncidentsApi.md#create_incident) | **POST** /incidents | Create a new incident.
+*IncidentsApi* | [**delete_incident_by_id**](docs/IncidentsApi.md#delete_incident_by_id) | **DELETE** /incidents/{incident} | Delete an incident
+*IncidentsApi* | [**get_incident_by_id**](docs/IncidentsApi.md#get_incident_by_id) | **GET** /incidents/{incident} | Get an incident
+*IncidentsApi* | [**get_incident_updates_by_id**](docs/IncidentsApi.md#get_incident_updates_by_id) | **GET** /incidents/{incident}/updates | Get incident updates
+*IncidentsApi* | [**get_incidents**](docs/IncidentsApi.md#get_incidents) | **GET** /incidents | Get all incidents.
+*IncidentsApi* | [**update_incident_by_id**](docs/IncidentsApi.md#update_incident_by_id) | **PUT** /incidents/{incident} | Update an incident
+*MetricsApi* | [**create_metric**](docs/MetricsApi.md#create_metric) | **POST** /metrics | Create a metric
+*MetricsApi* | [**create_metric_point_by_id**](docs/MetricsApi.md#create_metric_point_by_id) | **POST** /metrics/{metric}/points | Create point for a metric
+*MetricsApi* | [**delete_metric_by_id**](docs/MetricsApi.md#delete_metric_by_id) | **DELETE** /metrics/{metric} | Delete a metric
+*MetricsApi* | [**delete_metric_point_by_id**](docs/MetricsApi.md#delete_metric_point_by_id) | **DELETE** /metrics/{metric}/points/{point} | Delete a metric point
+*MetricsApi* | [**get_metric_by_id**](docs/MetricsApi.md#get_metric_by_id) | **GET** /metrics/{metric} | Get a metric
+*MetricsApi* | [**get_metric_points_by_id**](docs/MetricsApi.md#get_metric_points_by_id) | **GET** /metrics/{metric}/points | Get points for a metric
+*MetricsApi* | [**get_metrics**](docs/MetricsApi.md#get_metrics) | **GET** /metrics | Get all metrics
+*DefaultApi* | [**get_incident_update_by_id**](docs/DefaultApi.md#get_incident_update_by_id) | **GET** /incidents/{incident}/updates/{update} | Get an incident update
+
+
+## Documentation For Models
+
+ - [Component](docs/Component.md)
+ - [ComponentGroup](docs/ComponentGroup.md)
+ - [ComponentGroupResponse](docs/ComponentGroupResponse.md)
+ - [ComponentResponse](docs/ComponentResponse.md)
+ - [Error](docs/Error.md)
+ - [Incident](docs/Incident.md)
+ - [IncidentResponse](docs/IncidentResponse.md)
+ - [IncidentUpdateResponse](docs/IncidentUpdateResponse.md)
+ - [ListComponentGroupsResponse](docs/ListComponentGroupsResponse.md)
+ - [ListComponentsResponse](docs/ListComponentsResponse.md)
+ - [ListIncidentUpdatesResponse](docs/ListIncidentUpdatesResponse.md)
+ - [ListIncidentsResponse](docs/ListIncidentsResponse.md)
+ - [ListMetricPointsResponse](docs/ListMetricPointsResponse.md)
+ - [ListMetricsResponse](docs/ListMetricsResponse.md)
+ - [MetaData](docs/MetaData.md)
+ - [Metric](docs/Metric.md)
+ - [MetricPoint](docs/MetricPoint.md)
+ - [MetricPointsResponse](docs/MetricPointsResponse.md)
+ - [MetricsResponse](docs/MetricsResponse.md)
+ - [Pagination](docs/Pagination.md)
+ - [PaginationLinks](docs/PaginationLinks.md)
+ - [Ping](docs/Ping.md)
+ - [SingleComponentGroupResponse](docs/SingleComponentGroupResponse.md)
+ - [SingleComponentResponse](docs/SingleComponentResponse.md)
+ - [SingleIncidentResponse](docs/SingleIncidentResponse.md)
+ - [SingleIncidentUpdateResponse](docs/SingleIncidentUpdateResponse.md)
+ - [SingleMetricPointResponse](docs/SingleMetricPointResponse.md)
+ - [SingleMetricResponse](docs/SingleMetricResponse.md)
+ - [Version](docs/Version.md)
+ - [VersionMeta](docs/VersionMeta.md)
+ - [VersionMetaLatest](docs/VersionMetaLatest.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="apiKey"></a>
+### apiKey
+
+- **Type**: API key
+- **API key parameter name**: X-Cachet-Token
+- **Location**: HTTP header
+
+
+## Author
+
+
+
+
diff --git a/api-doc/docs/Component.md b/api-doc/docs/Component.md
@@ -0,0 +1,34 @@
+# Component
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**link** | **str** |  | [optional] 
+**status** | **int** |  | [optional] 
+**order** | **int** |  | [optional] 
+**group_id** | **int** |  | [optional] 
+**enabled** | **bool** |  | [optional] 
+
+## Example
+
+```python
+from cachethq_client.models.component import Component
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Component from a JSON string
+component_instance = Component.from_json(json)
+# print the JSON string representation of the object
+print Component.to_json()
+
+# convert the object into a dict
+component_dict = component_instance.to_dict()
+# create an instance of Component from a dict
+component_form_dict = component.from_dict(component_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/api-doc/docs/ComponentGroup.md b/api-doc/docs/ComponentGroup.md
@@ -0,0 +1,30 @@
+# ComponentGroup
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] 
+**order** | **int** |  | [optional] 
+**collapsed** | **int** |  | [optional] 
+
+## Example
+
+```python
+from cachethq_client.models.component_group import ComponentGroup
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ComponentGroup from a JSON string
+component_group_instance = ComponentGroup.from_json(json)
+# print the JSON string representation of the object
+print ComponentGroup.to_json()
+
+# convert the object into a dict
+component_group_dict = component_group_instance.to_dict()
+# create an instance of ComponentGroup from a dict
+component_group_form_dict = component_group.from_dict(component_group_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/api-doc/docs/ComponentGroupResponse.md b/api-doc/docs/ComponentGroupResponse.md
@@ -0,0 +1,36 @@
+# ComponentGroupResponse
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **int** |  | [optional] 
+**name** | **str** |  | [optional] 
+**created_at** | **str** |  | [optional] 
+**updated_at** | **str** |  | [optional] 
+**order** | **int** |  | [optional] 
+**collapsed** | **float** |  | [optional] 
+**visible** | **float** |  | [optional] 
+**enabled_components** | [**List[ComponentResponse]**](ComponentResponse.md) |  | [optional] 
+**enabled_components_lowest** | [**List[ComponentResponse]**](ComponentResponse.md) |  | [optional] 
+
+## Example
+
+```python
+from cachethq_client.models.component_group_response import ComponentGroupResponse
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ComponentGroupResponse from a JSON string
+component_group_response_instance = ComponentGroupResponse.from_json(json)
+# print the JSON string representation of the object
+print ComponentGroupResponse.to_json()
+
+# convert the object into a dict
+component_group_response_dict = component_group_response_instance.to_dict()
+# create an instance of ComponentGroupResponse from a dict
+component_group_response_form_dict = component_group_response.from_dict(component_group_response_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+