Skip to content

feat: more doc consistency changes #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tjvantoll merged 1 commit into from
Apr 8, 2026
Merged

feat: more doc consistency changes #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 3 additions & 11 deletions lib_template/api_doc.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ Method | HTTP request | Description

{{#operations}}
{{#operation}}
## **{{{operationId}}}**

## {{{operationId}}}

> {{#returnType}}{{{.}}} {{/returnType}}{{{operationId}}}({{#allParams}}{{#required}}{{{paramName}}}{{/required}}{{^required}}{{{paramName}}}={{{paramName}}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})

{{{summary}}}{{#notes}}
Expand Down Expand Up @@ -60,15 +62,5 @@ Name | Type | Description | Notes
- **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
- **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}}

{{#responses.0}}
### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
{{#responses}}
**{{code}}** | {{message}} | {{#headers}} * {{baseName}} - {{description}} <br> {{/headers}}{{^headers.0}} - {{/headers.0}} |
{{/responses}}
{{/responses.0}}

{{/operation}}
{{/operations}}
9 changes: 1 addition & 8 deletions src/docs/AlertApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ All URIs are relative to *https://api.notefile.net*
| ---------------------------------------- | ------------------------------------------------- | ----------- |
| [**get_alerts**](AlertApi.md#get_alerts) | **GET** /v1/projects/{projectOrProductUID}/alerts |

## **get_alerts**
## get_alerts

> GetAlerts200Response get_alerts(project_or_product_uid, page_size=page_size, page_num=page_num, monitor_uid=monitor_uid)

Expand Down Expand Up @@ -76,10 +76,3 @@ with notehub_py.ApiClient(configuration) as api_client:

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
| ----------- | ------------------------------------------ | ---------------- |
| **200** | The response body from GET /alerts | - |
| **0** | The response body in case of an API error. | - |
21 changes: 2 additions & 19 deletions src/docs/AuthorizationApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ All URIs are relative to *https://api.notefile.net*
| [**login**](AuthorizationApi.md#login) | **POST** /auth/login |
| [**o_auth2_client_credentials**](AuthorizationApi.md#o_auth2_client_credentials) | **POST** /oauth2/token | Issue an OAuth 2.0 access token (Client Credentials) |

## **login**
## login

> Login200Response login(login_request)

Expand Down Expand Up @@ -62,15 +62,7 @@ No authorization required
- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
| ----------- | --------------------- | ---------------- |
| **200** | Successful operation | - |
| **400** | Bad Request | - |
| **500** | Internal Server Error | - |

## **o_auth2_client_credentials**
## o_auth2_client_credentials

> OAuth2TokenResponse o_auth2_client_credentials(client_id, client_secret, grant_type, scope=scope)

Expand Down Expand Up @@ -132,12 +124,3 @@ No authorization required

- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
| ----------- | ------------------------------------------------- | ---------------- |
| **200** | Successful token response | - |
| **400** | Invalid request (missing or malformed parameters) | - |
| **401** | Invalid client authentication | - |
| **403** | Unauthorized scope | - |
27 changes: 3 additions & 24 deletions src/docs/BillingAccountApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ All URIs are relative to *https://api.notefile.net*
| [**get_billing_account_balance_history**](BillingAccountApi.md#get_billing_account_balance_history) | **GET** /v1/billing-accounts/{billingAccountUID}/balance-history |
| [**get_billing_accounts**](BillingAccountApi.md#get_billing_accounts) | **GET** /v1/billing-accounts |

## **get_billing_account**
## get_billing_account

> GetBillingAccount200Response get_billing_account(billing_account_uid)

Expand Down Expand Up @@ -73,14 +73,7 @@ with notehub_py.ApiClient(configuration) as api_client:
- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
| ----------- | ------------------------------------------ | ---------------- |
| **200** | Successful operation | - |
| **0** | The response body in case of an API error. | - |

## **get_billing_account_balance_history**
## get_billing_account_balance_history

> GetBillingAccountBalanceHistory200Response get_billing_account_balance_history(billing_account_uid, start_date=start_date, end_date=end_date)

Expand Down Expand Up @@ -149,14 +142,7 @@ with notehub_py.ApiClient(configuration) as api_client:
- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
| ----------- | ------------------------------------------ | ---------------- |
| **200** | Successful operation | - |
| **0** | The response body in case of an API error. | - |

## **get_billing_accounts**
## get_billing_accounts

> GetBillingAccounts200Response get_billing_accounts()

Expand Down Expand Up @@ -217,10 +203,3 @@ This endpoint does not need any parameter.

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
| ----------- | ------------------------------------------ | ---------------- |
| **200** | Successful operation | - |
| **0** | The response body in case of an API error. | - |
Loading
Loading