Skip to content

Commit

Permalink
api update
Browse files Browse the repository at this point in the history
  • Loading branch information
lajos88 committed Oct 14, 2020
1 parent ebda6d9 commit e656850
Show file tree
Hide file tree
Showing 103 changed files with 3,524 additions and 356 deletions.
36 changes: 33 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Go API client for configcatpublicapi

**Base API URL**: https://api.configcat.com If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON and JSON+HAL format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available here: [swagger.json](v1/swagger.json). You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). <!-- ReDoc-Inject: <security-definitions> --> # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header.
**Base API URL**: https://localhost If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger). The purpose of this API is to access the ConfigCat platform programmatically. You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature Flags, Configs, Environments** or **Products** within ConfigCat. The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON and JSON+HAL format. Do not use this API for accessing and evaluating feature flag values. Use the [SDKs instead](https://configcat.com/docs/sdk-reference/overview). # OpenAPI Specification The complete specification is publicly available here: [swagger.json](v1/swagger.json). You can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) or [Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact with this API. # Authentication This API uses the [Basic HTTP Authentication Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). <!-- ReDoc-Inject: <security-definitions> --> # Throttling and rate limits All the rate limited API calls are returning information about the current rate limit period in the following HTTP headers: | Header | Description | | :- | :- | | X-Rate-Limit-Remaining | The maximum number of requests remaining in the current rate limit period. | | X-Rate-Limit-Reset | The time when the current rate limit period resets. | When the rate limit is exceeded by a request, the API returns with a `HTTP 429 - Too many requests` status along with a `Retry-After` HTTP header.

## Overview
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
Expand All @@ -18,13 +18,19 @@ import "./configcatpublicapi"

## Documentation for API Endpoints

All URIs are relative to *https://api.configcat.com*
All URIs are relative to *https://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuditLogsApi* | [**GetAuditlogs**](docs/AuditLogsApi.md#getauditlogs) | **Get** /v1/products/{productId}/auditlogs | List Audit logs
*ConfigsApi* | [**CreateConfig**](docs/ConfigsApi.md#createconfig) | **Post** /v1/products/{productId}/configs | Create Config
*ConfigsApi* | [**DeleteConfig**](docs/ConfigsApi.md#deleteconfig) | **Delete** /v1/configs/{configId} | Delete Config
*ConfigsApi* | [**GetConfig**](docs/ConfigsApi.md#getconfig) | **Get** /v1/configs/{configId} | Get Config
*ConfigsApi* | [**GetConfigs**](docs/ConfigsApi.md#getconfigs) | **Get** /v1/products/{productId}/configs | List Configs
*ConfigsApi* | [**UpdateConfig**](docs/ConfigsApi.md#updateconfig) | **Put** /v1/configs/{configId} | Update Config
*EnvironmentsApi* | [**CreateEnvironment**](docs/EnvironmentsApi.md#createenvironment) | **Post** /v1/products/{productId}/environments | Create Environment
*EnvironmentsApi* | [**DeleteEnvironment**](docs/EnvironmentsApi.md#deleteenvironment) | **Delete** /v1/environments/{environmentId} | Delete Environment
*EnvironmentsApi* | [**GetEnvironment**](docs/EnvironmentsApi.md#getenvironment) | **Get** /v1/environments/{environmentId} | Get Environment
*EnvironmentsApi* | [**GetEnvironments**](docs/EnvironmentsApi.md#getenvironments) | **Get** /v1/products/{productId}/environments | List Environments
*EnvironmentsApi* | [**UpdateEnvironment**](docs/EnvironmentsApi.md#updateenvironment) | **Put** /v1/environments/{environmentId} | Update Environment
*FeatureFlagSettingValuesApi* | [**GetSettingValue**](docs/FeatureFlagSettingValuesApi.md#getsettingvalue) | **Get** /v1/environments/{environmentId}/settings/{settingId}/value | Get value
Expand All @@ -42,7 +48,17 @@ Class | Method | HTTP request | Description
*IntegrationLinksApi* | [**DeleteIntegrationLink**](docs/IntegrationLinksApi.md#deleteintegrationlink) | **Delete** /v1/environments/{environmentId}/settings/{settingId}/integrationLinks/{integrationLinkType}/{key} | Delete Integration link
*IntegrationLinksApi* | [**GetIntegrationLinkDetails**](docs/IntegrationLinksApi.md#getintegrationlinkdetails) | **Get** /v1/integrationLink/{integrationLinkType}/{key}/details | Get Integration link
*MeApi* | [**GetMe**](docs/MeApi.md#getme) | **Get** /v1/me | Get authenticated user details
*OrganizationsApi* | [**GetOrganizations**](docs/OrganizationsApi.md#getorganizations) | **Get** /v1/organizations | List Organizations
*ProductsApi* | [**CreateProduct**](docs/ProductsApi.md#createproduct) | **Post** /v1/organizations/{organizationId}/products | Create Product
*ProductsApi* | [**DeleteProduct**](docs/ProductsApi.md#deleteproduct) | **Delete** /v1/products/{productId} | Delete Product
*ProductsApi* | [**GetProduct**](docs/ProductsApi.md#getproduct) | **Get** /v1/products/{productId} | Get Product
*ProductsApi* | [**GetProducts**](docs/ProductsApi.md#getproducts) | **Get** /v1/products | List Products
*ProductsApi* | [**UpdateProduct**](docs/ProductsApi.md#updateproduct) | **Put** /v1/products/{productId} | Update Product
*TagsApi* | [**CreateTag**](docs/TagsApi.md#createtag) | **Post** /v1/products/{productId}/tags | Create Tag
*TagsApi* | [**DeleteTag**](docs/TagsApi.md#deletetag) | **Delete** /v1/tags/{tagId} | Delete Tag
*TagsApi* | [**GetTag**](docs/TagsApi.md#gettag) | **Get** /v1/tags/{tagId} | Get Tag
*TagsApi* | [**GetTags**](docs/TagsApi.md#gettags) | **Get** /v1/products/{productId}/tags | List Tags
*TagsApi* | [**UpdateTag**](docs/TagsApi.md#updatetag) | **Put** /v1/tags/{tagId} | Update Tag

## Documentation For Models

Expand All @@ -52,17 +68,24 @@ Class | Method | HTTP request | Description
- [ConfigModel](docs/ConfigModel.md)
- [ConfigModelHaljson](docs/ConfigModelHaljson.md)
- [ConfigModelhaljsonLinks](docs/ConfigModelhaljsonLinks.md)
- [CreateConfigRequest](docs/CreateConfigRequest.md)
- [CreateEnvironmentModel](docs/CreateEnvironmentModel.md)
- [CreateProductRequest](docs/CreateProductRequest.md)
- [CreateSettingModel](docs/CreateSettingModel.md)
- [CreateTagModel](docs/CreateTagModel.md)
- [DeleteIntegrationLinkModel](docs/DeleteIntegrationLinkModel.md)
- [EnvironmentModel](docs/EnvironmentModel.md)
- [EnvironmentModelHaljson](docs/EnvironmentModelHaljson.md)
- [EnvironmentModelhaljsonLinks](docs/EnvironmentModelhaljsonLinks.md)
- [IntegrationLinkDetail](docs/IntegrationLinkDetail.md)
- [IntegrationLinkDetailsModel](docs/IntegrationLinkDetailsModel.md)
- [IntegrationLinkModel](docs/IntegrationLinkModel.md)
- [IntegrationLinkType](docs/IntegrationLinkType.md)
- [MeModel](docs/MeModel.md)
- [Operation](docs/Operation.md)
- [OrganizationModel](docs/OrganizationModel.md)
- [OrganizationModelHaljson](docs/OrganizationModelHaljson.md)
- [OrganizationModelhaljsonLinks](docs/OrganizationModelhaljsonLinks.md)
- [ProductModel](docs/ProductModel.md)
- [ProductModelHaljson](docs/ProductModelHaljson.md)
- [ProductModelhaljsonEmbedded](docs/ProductModelhaljsonEmbedded.md)
Expand All @@ -73,6 +96,9 @@ Class | Method | HTTP request | Description
- [RolloutRuleModel](docs/RolloutRuleModel.md)
- [SettingDataModel](docs/SettingDataModel.md)
- [SettingModel](docs/SettingModel.md)
- [SettingModelHaljson](docs/SettingModelHaljson.md)
- [SettingModelhaljsonEmbedded](docs/SettingModelhaljsonEmbedded.md)
- [SettingModelhaljsonEmbeddedTags](docs/SettingModelhaljsonEmbeddedTags.md)
- [SettingTagModel](docs/SettingTagModel.md)
- [SettingType](docs/SettingType.md)
- [SettingValueModel](docs/SettingValueModel.md)
Expand All @@ -83,9 +109,13 @@ Class | Method | HTTP request | Description
- [SettingValueModelhaljsonEmbeddedIntegrationLinks](docs/SettingValueModelhaljsonEmbeddedIntegrationLinks.md)
- [SettingValueModelhaljsonEmbeddedSetting](docs/SettingValueModelhaljsonEmbeddedSetting.md)
- [SettingValueModelhaljsonEmbeddedSettingTags](docs/SettingValueModelhaljsonEmbeddedSettingTags.md)
- [SettingValueModelhaljsonLinks](docs/SettingValueModelhaljsonLinks.md)
- [TagModel](docs/TagModel.md)
- [TagModelHaljson](docs/TagModelHaljson.md)
- [UpdateConfigRequest](docs/UpdateConfigRequest.md)
- [UpdateEnvironmentModel](docs/UpdateEnvironmentModel.md)
- [UpdateProductRequest](docs/UpdateProductRequest.md)
- [UpdateSettingValueModel](docs/UpdateSettingValueModel.md)
- [UpdateTagModel](docs/UpdateTagModel.md)

## Documentation For Authorization

Expand Down
Loading

0 comments on commit e656850

Please sign in to comment.