Skip to content
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.

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

Generate based on live api #15

Merged
merged 2 commits into from
Sep 10, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
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.

**Base API URL**: https://test-api.configcat.com
**Base API URL**: https://api.configcat.com

If you prefer the swagger documentation, you can find it here: [Swagger UI](https://test-api.configcat.com/swagger).
If you prefer the swagger documentation, you can find it here: [Swagger UI](https://api.configcat.com/swagger).

The API is based on HTTP REST, uses resource-oriented URLs, status codes and supports JSON
format.
Expand All @@ -15,8 +15,8 @@ format.
# OpenAPI Specification

The complete specification is publicly available in the following formats:
- [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json)
- [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json)
- [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json)
- [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.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.
Expand Down Expand Up @@ -109,7 +109,7 @@ ctx = context.WithValue(context.Background(), configcatpublicapi.ContextOperatio

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
Expand Down
79 changes: 51 additions & 28 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ info:
description: "The purpose of this API is to access the ConfigCat platform programmatically.\n\
You can **Create**, **Read**, **Update** and **Delete** any entities like **Feature\
\ Flags, Configs, Environments** or **Products** within ConfigCat.\n\n**Base API\
\ URL**: https://test-api.configcat.com\n\nIf you prefer the swagger documentation,\
\ you can find it here: [Swagger UI](https://test-api.configcat.com/swagger).\n\
\nThe API is based on HTTP REST, uses resource-oriented URLs, status codes and\
\ supports JSON \nformat. \n\n**Important:** Do not use this API for accessing\
\ and evaluating feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview)\
\ URL**: https://api.configcat.com\n\nIf you prefer the swagger documentation,\
\ you can find it here: [Swagger UI](https://api.configcat.com/swagger).\n\nThe\
\ API is based on HTTP REST, uses resource-oriented URLs, status codes and supports\
\ JSON \nformat. \n\n**Important:** Do not use this API for accessing and evaluating\
\ feature flag values. Use the [SDKs](https://configcat.com/docs/sdk-reference/overview)\
\ or the [ConfigCat Proxy](https://configcat.com/docs/advanced/proxy/proxy-overview/)\
\ instead.\n\n# OpenAPI Specification\n\nThe complete specification is publicly\
\ available in the following formats: \n- [OpenAPI v3](https://test-api.configcat.com/docs/v1/swagger.json)\n\
- [Swagger v2](https://test-api.configcat.com/docs/v1/swagger.v2.json)\n\nYou\
\ can use it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator)\
\ available in the following formats: \n- [OpenAPI v3](https://api.configcat.com/docs/v1/swagger.json)\n\
- [Swagger v2](https://api.configcat.com/docs/v1/swagger.v2.json)\n\nYou can use\
\ it to generate client libraries in various languages with [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator)\
\ or\n[Swagger Codegen](https://swagger.io/tools/swagger-codegen/) to interact\
\ with this API.\n\n# Authentication\nThis API uses the [Basic HTTP Authentication\
\ Scheme](https://en.wikipedia.org/wiki/Basic_access_authentication). \n\n<!--\
Expand All @@ -32,9 +32,9 @@ info:
title: ConfigCat Public Management API
version: v1
x-logo:
url: https://test-api.configcat.com/resources/configcat-logo-horiz.svg
url: https://api.configcat.com/resources/configcat-logo-horiz.svg
servers:
- url: https://test-api.configcat.com
- url: https://api.configcat.com
security:
- Basic: []
tags:
Expand Down Expand Up @@ -3305,7 +3305,7 @@ paths:
description: This example adds an evaluation rule with two conditions
to the Flag's targeting rules.
value:
- op: replace
- op: add
path: /targetingRules/-
value:
conditions:
Expand Down Expand Up @@ -3386,7 +3386,7 @@ paths:
description: This example adds an evaluation rule with two conditions
to the Flag's targeting rules.
value:
- op: replace
- op: add
path: /targetingRules/-
value:
conditions:
Expand Down Expand Up @@ -3467,7 +3467,7 @@ paths:
description: This example adds an evaluation rule with two conditions
to the Flag's targeting rules.
value:
- op: replace
- op: add
path: /targetingRules/-
value:
conditions:
Expand Down Expand Up @@ -3918,7 +3918,7 @@ paths:
description: This example adds an evaluation rule with two conditions
to the Flag's targeting rules.
value:
- op: replace
- op: add
path: /targetingRules/-
value:
conditions:
Expand Down Expand Up @@ -3999,7 +3999,7 @@ paths:
description: This example adds an evaluation rule with two conditions
to the Flag's targeting rules.
value:
- op: replace
- op: add
path: /targetingRules/-
value:
conditions:
Expand Down Expand Up @@ -4080,7 +4080,7 @@ paths:
description: This example adds an evaluation rule with two conditions
to the Flag's targeting rules.
value:
- op: replace
- op: add
path: /targetingRules/-
value:
conditions:
Expand Down Expand Up @@ -4556,7 +4556,7 @@ paths:
\ on those Feature Flags and Settings, which are set in the request. \nIt's\
\ important to set every other field that you don't want to change in its\
\ original state. Not listing a field means that it will reset.\n\nFor example:\
\ We have the following resource of a Feature Flag.\n```json\n{\n \"settingValues\"\
\ We have the following resource of a Feature Flag.\n```json\n{\n \"settingFormulas\"\
: [\n {\n \"defaultValue\": {\n \"boolValue\": false\n \
\ },\n \"targetingRules\": [\n {\n \"conditions\": [\n\
\ {\n \"userCondition\": {\n \"comparisonAttribute\"\
Expand All @@ -4566,11 +4566,11 @@ paths:
\ ],\n \"percentageOptions\": [],\n \"value\":\
\ {\n \"boolValue\": true\n }\n }\n ],\n \
\ \"settingId\": 1\n }\n ]\n}\n```\nIf we send a batch replace request\
\ body as below:\n```json\n{ \n \"settingValues\": [\n {\n \"defaultValue\"\
\ body as below:\n```json\n{ \n \"updateFormulas\": [\n {\n \"defaultValue\"\
: {\n \"boolValue\": false\n },\n \"settingId\": 1\n }\n\
\ ]\n}\n```\nThen besides that the default value is set to `true`, all Targeting\
\ Rules of the related Feature Flag are deleted.\nSo we get a response like\
\ this:\n```json\n{\n \"settingValues\": [\n {\n \"defaultValue\"\
\ this:\n```json\n{\n \"settingFormulas\": [\n {\n \"defaultValue\"\
: {\n \"boolValue\": false\n },\n \"targetingRules\": [],\n\
\ \"setting\": \n {\n \"settingId\": 1\n }\n }\n\
\ ]\n}\n```"
Expand Down Expand Up @@ -7248,7 +7248,6 @@ components:
description: The key of the Feature Flag or Setting.
maxLength: 255
minLength: 1
pattern: "^[a-zA-Z]+[a-zA-Z0-9_-]*$"
type: string
name:
description: The name of the Feature Flag or Setting.
Expand Down Expand Up @@ -7766,6 +7765,15 @@ components:
additionalProperties: false
description: Details of the Integration.
example:
product:
productId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
organization:
organizationId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
name: name
name: name
description: description
order: 0
reasonRequired: true
integrationType: null
environmentIds:
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
Expand All @@ -7778,6 +7786,8 @@ components:
parameters:
key: parameters
properties:
product:
$ref: '#/components/schemas/ProductModel'
integrationId:
description: Identifier of the Integration.
format: uuid
Expand Down Expand Up @@ -7825,7 +7835,16 @@ components:
additionalProperties: false
example:
integrations:
- integrationType: null
- product:
productId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
organization:
organizationId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
name: name
name: name
description: description
order: 0
reasonRequired: true
integrationType: null
environmentIds:
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
Expand All @@ -7836,7 +7855,16 @@ components:
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
parameters:
key: parameters
- integrationType: null
- product:
productId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
organization:
organizationId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
name: name
name: name
description: description
order: 0
reasonRequired: true
integrationType: null
environmentIds:
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
- 046b6c7f-0b8a-43b9-b35d-6489e6daee91
Expand Down Expand Up @@ -10851,9 +10879,6 @@ components:
description: The URL of the Webhook.
maxLength: 1000
minLength: 7
pattern: "^(https?:\\/\\/(?:www\\.|(?!www)|(?!a-zA-Z))[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]\\\
.[^\\s]{2,}|https?:\\/\\/(?:www\\.|(?!www)|(?!a-zA-Z))[a-zA-Z0-9]\\.[^\\\
s]{2,})$"
type: string
content:
description: The HTTP body content.
Expand Down Expand Up @@ -10915,13 +10940,11 @@ components:
description: The HTTP header key.
maxLength: 255
minLength: 1
pattern: "^[a-zA-Z0-9_\\-]*$"
type: string
value:
description: The HTTP header value.
maxLength: 1000
minLength: 1
pattern: "^[a-zA-Z0-9\\- _\\\\:;.,\\/\"'?!(){}\\[\\]@<>=+*#$&`|~^%]*$"
type: string
isSecure:
description: Indicates whether the header value is sensitive.
Expand Down Expand Up @@ -10996,7 +11019,7 @@ components:
description: |-
To authenticate with the API you have to fill the `Authorization` HTTP request header with your Public API credentials.

You can create your credentials on the <a target="_blank" href="https://test-app.configcat.com/my-account/public-api-credentials">Public API credentials management page</a>.
You can create your credentials on the <a target="_blank" href="https://app.configcat.com/my-account/public-api-credentials">Public API credentials management page</a>.
scheme: basic
type: http
x-tagGroups:
Expand Down
2 changes: 1 addition & 1 deletion api_audit_logs.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion api_code_references.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading