1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-10-13 11:17:26 +02:00
unleash.unleash/src/lib/openapi/spec
David Leek 485dab87d4
docs: openapi schema specifications for Projects tag (#3571)
<!-- Thanks for creating a PR! To make it easier for reviewers and
everyone else to understand what your changes relate to, please add some
relevant content to the headings below. Feel free to ignore or delete
sections that you don't think are relevant. Thank you! ❤️ -->

## About the changes
<!-- Describe the changes introduced. What are they and why are they
being introduced? Feel free to also add screenshots or steps to view the
changes if they're visual. -->

Improves the openapi schema specifications for the schemas belonging to
the "Projects" tag.
Expected error codes/http statues, descriptions, and example data

---------

Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
2023-05-19 09:07:23 +02:00
..
__snapshots__ docs: openapi schema specifications for Projects tag (#3571) 2023-05-19 09:07:23 +02:00
addon-create-update-schema.ts OpenAPI: addon operations (#3421) 2023-04-18 10:50:34 +00:00
addon-parameter-schema.ts OpenAPI: addon operations (#3421) 2023-04-18 10:50:34 +00:00
addon-schema.test.ts OpenAPI: addon operations (#3421) 2023-04-18 10:50:34 +00:00
addon-schema.ts OpenAPI: addon operations (#3421) 2023-04-18 10:50:34 +00:00
addon-type-schema.ts OpenAPI: addon operations (#3421) 2023-04-18 10:50:34 +00:00
addons-schema.test.ts OpenAPI: addon operations (#3421) 2023-04-18 10:50:34 +00:00
addons-schema.ts OpenAPI: addon operations (#3421) 2023-04-18 10:50:34 +00:00
admin-features-query-schema.test.ts feature: add query support to features endpoint (#2693) 2022-12-16 12:05:18 +01:00
admin-features-query-schema.ts feature: add query support to features endpoint (#2693) 2022-12-16 12:05:18 +01:00
api-token-schema.test.ts docs: openapi schema specifications for Projects tag (#3571) 2023-05-19 09:07:23 +02:00
api-token-schema.ts docs: openapi schema specifications for Projects tag (#3571) 2023-05-19 09:07:23 +02:00
api-tokens-schema.ts docs: openapi schema specifications for Projects tag (#3571) 2023-05-19 09:07:23 +02:00
application-schema.ts docs: Metrics tag openapi docs (#3572) 2023-04-26 12:10:57 +02:00
applications-schema.ts docs: Metrics tag openapi docs (#3572) 2023-04-26 12:10:57 +02:00
batch-features-schema.ts feat: bulk stale features (#3311) 2023-03-15 08:37:06 +02:00
batch-stale-schema.ts feat: bulk stale features (#3311) 2023-03-15 08:37:06 +02:00
bulk-metrics-schema.ts docs: Metrics tag openapi docs (#3572) 2023-04-26 12:10:57 +02:00
bulk-registration-schema.ts docs: Added docs for edge endpoints (#3501) 2023-04-14 15:39:39 +02:00
bulk-toggle-features-schema.ts feat: create stubs for bulk toggle (#3792) 2023-05-17 10:21:08 +02:00
change-password-schema.test.ts Task/open api reset password (#1740) 2022-06-22 14:31:41 +03:00
change-password-schema.ts Task/open api reset password (#1740) 2022-06-22 14:31:41 +03:00
client-application-schema.test.ts refactor: add schemas to client application registration (#1746) 2022-06-24 15:29:27 +02:00
client-application-schema.ts refactor: add schemas to client application registration (#1746) 2022-06-24 15:29:27 +02:00
client-feature-schema.ts feat: filter out all data fields other than explicit openapi fields (#3284) 2023-03-09 14:45:03 +01:00
client-features-query-schema.test.ts open api implementation - client features controller (#1745) 2022-06-30 12:54:14 +03:00
client-features-query-schema.ts fix: fix broken OpenAPI spec (#1846) 2022-07-28 09:19:58 +02:00
client-features-schema.test.ts refactor: use the same variant schema for the admin and client APIs (#1882) 2022-08-08 16:21:57 +02:00
client-features-schema.ts refactor: use the same variant schema for the admin and client APIs (#1882) 2022-08-08 16:21:57 +02:00
client-metrics-env-schema.ts docs: Metrics tag openapi docs (#3572) 2023-04-26 12:10:57 +02:00
client-metrics-schema.test.ts feat: metrics for variants (#3685) 2023-05-05 11:10:54 +03:00
client-metrics-schema.ts docs: Metrics tag openapi docs (#3572) 2023-04-26 12:10:57 +02:00
clone-feature-schema.ts refactor: add soft response schema validation (#1657) 2022-06-08 08:01:14 +02:00
constraint-schema.test.ts refactor: add OpenAPI schema to constraints controller (#1683) 2022-06-09 10:35:39 +02:00
constraint-schema.ts docs: open api examples for segment schemas (#3503) 2023-04-12 09:29:51 +00:00
context-field-schema.test.ts refactor: remove bootstrap endpoint (#1900) 2022-08-09 15:58:27 +02:00
context-field-schema.ts refactor: add OpenAPI schema to context controller (#1711) 2022-06-17 10:11:55 +01:00
context-fields-schema.ts refactor: add OpenAPI schema to context controller (#1711) 2022-06-17 10:11:55 +01:00
create-api-token-schema.ts chore: deprecate username on api-tokens (#3616) 2023-05-04 09:56:00 +02:00
create-application-schema.ts docs: Metrics tag openapi docs (#3572) 2023-04-26 12:10:57 +02:00
create-feature-schema.ts refactor: add soft response schema validation (#1657) 2022-06-08 08:01:14 +02:00
create-feature-strategy-schema.ts Feat/enable disable strategies (#3566) 2023-04-21 12:09:07 +03:00
create-invited-user-schema.ts Feat/invite user (#2061) 2022-09-30 13:01:32 +02:00
create-user-schema.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
date-schema.ts OAS for client-api metrics.ts (#1753) 2022-06-30 13:27:12 +03:00
edge-token-schema.ts docs: Added docs for edge endpoints (#3501) 2023-04-14 15:39:39 +02:00
email-schema.test.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
email-schema.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
environment-project-schema.ts Feat: default strategy UI (#3682) 2023-05-05 14:32:44 +03:00
environment-schema.ts docs: Flesh out openapi for tag: Environments (#3440) 2023-04-04 15:45:34 +02:00
environments-project-schema.ts docs: Flesh out openapi for tag: Environments (#3440) 2023-04-04 15:45:34 +02:00
environments-schema.ts refactor: add OpenAPI schema to environments controller (#1682) 2022-06-10 10:04:56 +02:00
event-schema.test.ts feat: add OpenAPI spec to events controller. (#1754) 2022-06-30 08:12:34 +00:00
event-schema.ts feat: add OpenAPI spec to events controller. (#1754) 2022-06-30 08:12:34 +00:00
events-schema.test.ts feat: add OpenAPI spec to events controller. (#1754) 2022-06-30 08:12:34 +00:00
events-schema.ts feat: add count to event list (#2036) 2022-09-02 08:35:31 +02:00
export-query-parameters.ts fix: fix broken OpenAPI spec (#1846) 2022-07-28 09:19:58 +02:00
export-query-schema.test.ts Export with strategies (#2877) 2023-01-11 15:00:20 +00:00
export-query-schema.ts feat: export by tags (#3635) 2023-04-27 10:22:14 +02:00
export-result-schema.test.ts Export tag types (#3026) 2023-02-01 13:14:49 +02:00
export-result-schema.ts feat: Export segments limited info (#3109) 2023-02-14 15:35:10 +01:00
feature-environment-metrics-schema.ts feat: metrics for variants (#3685) 2023-05-05 11:10:54 +03:00
feature-environment-schema.test.ts fix feature-schema.ts (#2729) 2023-01-11 10:53:43 +02:00
feature-environment-schema.ts feat: Gradual schema improvements (#3075) 2023-02-10 15:05:57 +01:00
feature-events-schema.test.ts feat: add OpenAPI spec to events controller. (#1754) 2022-06-30 08:12:34 +00:00
feature-events-schema.ts fix: enabling more tests with strict schema validation (#3081) 2023-02-14 11:25:13 +01:00
feature-metrics-schema.test.ts OAS for client-metrics controller (#1739) 2022-06-27 11:17:44 +03:00
feature-metrics-schema.ts docs: Metrics tag openapi docs (#3572) 2023-04-26 12:10:57 +02:00
feature-schema.test.ts fix feature-schema.ts (#2729) 2023-01-11 10:53:43 +02:00
feature-schema.ts Fix: feature schema (#3456) 2023-04-07 09:16:00 +00:00
feature-strategy-schema.ts Feat/enable disable strategies (#3566) 2023-04-21 12:09:07 +03:00
feature-strategy-segment-schema.ts Task/open api state (#1738) 2022-06-22 09:09:49 +02:00
feature-tag-schema.ts docs: improve open api (#3535) 2023-04-18 08:50:36 +02:00
feature-type-schema.test.ts refactor: add OpenAPI schema to feature types controller (#1684) 2022-06-09 13:17:13 +02:00
feature-type-schema.ts refactor: add OpenAPI schema to feature types controller (#1684) 2022-06-09 13:17:13 +02:00
feature-types-schema.ts refactor: add OpenAPI schema to feature types controller (#1684) 2022-06-09 13:17:13 +02:00
feature-usage-schema.test.ts OAS for client-metrics controller (#1739) 2022-06-27 11:17:44 +03:00
feature-usage-schema.ts docs: Metrics tag openapi docs (#3572) 2023-04-26 12:10:57 +02:00
feature-variants-schema.ts refactor: add soft response schema validation (#1657) 2022-06-08 08:01:14 +02:00
features-schema.test.ts refactor: add soft response schema validation (#1657) 2022-06-08 08:01:14 +02:00
features-schema.ts fix feature-schema.ts (#2729) 2023-01-11 10:53:43 +02:00
feedback-schema.ts fix: fix broken OpenAPI spec (#1846) 2022-07-28 09:19:58 +02:00
group-schema.ts feat: root roles from groups (#3559) 2023-04-20 12:29:30 +02:00
group-user-model-schema.ts UX additions to groups SSO syncing (#2200) 2022-10-20 10:47:19 +03:00
groups-schema.test.ts Fix/remove group owner concept (#1905) 2022-08-11 08:23:08 +02:00
groups-schema.ts Feat/grouping (#1845) 2022-07-21 16:23:56 +02:00
health-check-schema.ts refactor: add OpenAPI schema to health-check controller (#1732) 2022-06-20 11:22:41 +01:00
health-overview-schema.ts docs: openapi schema specifications for Projects tag (#3571) 2023-05-19 09:07:23 +02:00
health-report-schema.ts docs: openapi schema specifications for Projects tag (#3571) 2023-05-19 09:07:23 +02:00
id-schema.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
import-toggles-schema.ts feat: oss import (#3123) 2023-02-16 08:08:51 +01:00
import-toggles-validate-item-schema.ts feat: oss import (#3123) 2023-02-16 08:08:51 +01:00
import-toggles-validate-schema.ts feat: oss import (#3123) 2023-02-16 08:08:51 +01:00
index.ts feat: message banner (variants) (#3788) 2023-05-18 09:38:59 +01:00
instance-admin-stats-schema.test.ts Feat/stats service (#2211) 2022-10-25 13:10:27 +02:00
instance-admin-stats-schema.ts Feat/stats service (#2211) 2022-10-25 13:10:27 +02:00
legal-value-schema.ts refactor: add OpenAPI schema to context controller (#1711) 2022-06-17 10:11:55 +01:00
login-schema.ts refactor: add OpenAPI schema to simple-password-provider controller (#1734) 2022-06-23 08:40:25 +01:00
maintenance-schema.ts feat: Maintenance openapi (#3478) 2023-04-10 09:55:29 +02:00
me-schema.test.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
me-schema.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
name-schema.ts refactor: add OpenAPI schema to context controller (#1711) 2022-06-17 10:11:55 +01:00
override-schema.ts refactor: add soft response schema validation (#1657) 2022-06-08 08:01:14 +02:00
parameters-schema.ts refactor: add soft response schema validation (#1657) 2022-06-08 08:01:14 +02:00
password-schema.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
pat-schema.ts docs: openapi schema for PATs (#3605) 2023-05-11 09:11:17 +02:00
patch-schema.ts refactor: add soft response schema validation (#1657) 2022-06-08 08:01:14 +02:00
patches-schema.ts refactor: add soft response schema validation (#1657) 2022-06-08 08:01:14 +02:00
pats-schema.ts docs: openapi schema for PATs (#3605) 2023-05-11 09:11:17 +02:00
permission-schema.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
playground-constraint-schema.ts feat(#1873/playground): Return detailed information on feature toggle evaluation (#1839) 2022-08-04 15:41:52 +02:00
playground-feature-schema.test.ts Feat/enable disable strategies (#3566) 2023-04-21 12:09:07 +03:00
playground-feature-schema.ts feat(#1873/playground): Return detailed information on feature toggle evaluation (#1839) 2022-08-04 15:41:52 +02:00
playground-request-schema.test.ts feat: add playground API post endpoint (#1791) 2022-07-12 13:01:10 +02:00
playground-request-schema.ts feat(#1873/playground): Return detailed information on feature toggle evaluation (#1839) 2022-08-04 15:41:52 +02:00
playground-response-schema.test.ts feat: add all feature variants to the playground payload (#1835) 2022-07-20 08:54:34 +02:00
playground-response-schema.ts feat(#1873/playground): Return detailed information on feature toggle evaluation (#1839) 2022-08-04 15:41:52 +02:00
playground-segment-schema.ts feat(#1873/playground): Return detailed information on feature toggle evaluation (#1839) 2022-08-04 15:41:52 +02:00
playground-strategy-schema.ts Feat/enable disable strategies (#3566) 2023-04-21 12:09:07 +03:00
profile-schema.test.ts Add some extra fields for profile (#2119) 2022-09-30 14:36:45 +03:00
profile-schema.ts Add some extra fields for profile (#2119) 2022-09-30 14:36:45 +03:00
project-environment-schema.ts docs: openapi schema specifications for Projects tag (#3571) 2023-05-19 09:07:23 +02:00
project-overview-schema.ts Feat: project default strategy (#3644) 2023-04-28 14:59:04 +03:00
project-schema.test.ts feat: Gradual schema improvements (#3075) 2023-02-10 15:05:57 +01:00
project-schema.ts Fix: make stickiness accept any string (#3408) 2023-03-28 16:42:16 +03:00
project-stats-schema.ts fix: refactor calculate time to prod (#3333) 2023-03-16 15:45:24 +01:00
projects-schema.ts feat: Gradual schema improvements (#3075) 2023-02-10 15:05:57 +01:00
proxy-client-schema.ts feat: embed proxy endpoints (#1926) 2022-08-16 15:33:33 +02:00
proxy-feature-schema.ts feat: message banner (variants) (#3788) 2023-05-18 09:38:59 +01:00
proxy-features-schema.ts feat: embed proxy endpoints (#1926) 2022-08-16 15:33:33 +02:00
public-signup-schema.test.ts Feat/invite user (#2061) 2022-09-30 13:01:32 +02:00
public-signup-token-create-schema.ts chore: docs for public signup token tag (#3486) 2023-04-21 11:26:54 +00:00
public-signup-token-schema.ts chore: docs for public signup token tag (#3486) 2023-04-21 11:26:54 +00:00
public-signup-token-update-schema.ts chore: docs for public signup token tag (#3486) 2023-04-21 11:26:54 +00:00
public-signup-tokens-schema.ts chore: docs for public signup token tag (#3486) 2023-04-21 11:26:54 +00:00
push-variants-schema.ts feat: Add ability to push variants to multiple environments (#2914) 2023-01-20 10:30:20 +01:00
requests-per-second-schema.ts perf: Simplify queries to prometheus (#2706) 2022-12-19 17:06:59 +01:00
requests-per-second-segmented-schema.ts task: Expose prometheus metrics (#2586) 2022-12-12 14:05:56 +01:00
reset-password-schema.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
role-schema.test.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
role-schema.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
sdk-context-schema.test.ts feat: add playground API post endpoint (#1791) 2022-07-12 13:01:10 +02:00
sdk-context-schema.ts Orval generator POC (#2724) 2023-01-05 11:57:53 +01:00
search-events-schema.ts feat: add event search endpoint (#1893) 2022-08-09 16:14:50 +02:00
segment-schema.ts fix: segments schemas (#3525) 2023-04-17 10:51:48 +02:00
set-strategy-sort-order-schema.test.ts Strategy sort order endpoint (#1855) 2022-07-26 14:16:30 +02:00
set-strategy-sort-order-schema.ts Strategy sort order endpoint (#1855) 2022-07-26 14:16:30 +02:00
set-ui-config-schema.ts openapi: improve validation testing (#2058) 2022-09-23 15:02:09 +02:00
sort-order-schema.test.ts refactor: add OpenAPI schema to environments controller (#1682) 2022-06-10 10:04:56 +02:00
sort-order-schema.ts refactor: add OpenAPI schema to environments controller (#1682) 2022-06-10 10:04:56 +02:00
splash-schema.ts refactor: add schemas to splash controller (#1697) 2022-06-10 15:11:07 +02:00
state-schema.ts feat: deprecate state api (#3551) 2023-04-18 18:34:12 +02:00
strategies-schema.ts refactor: add schemas to strategy controller (#1744) 2022-06-23 08:10:20 +02:00
strategy-schema.test.ts feat: add title to strategy (#3510) 2023-04-18 08:59:02 +02:00
strategy-schema.ts feat: add title to strategy (#3510) 2023-04-18 08:59:02 +02:00
tag-schema.ts docs: improve open api (#3535) 2023-04-18 08:50:36 +02:00
tag-type-schema.ts Feat: OpenAPI controller - Bootstrap UI (#1773) 2022-06-30 12:21:40 +00:00
tag-types-schema.test.ts refactor: remove bootstrap endpoint (#1900) 2022-08-09 15:58:27 +02:00
tag-types-schema.ts task: add open-api for tag-types (#1700) 2022-06-14 09:06:41 +02:00
tag-with-version-schema.ts task: add openapi for tags (#1724) 2022-06-21 08:23:30 +02:00
tags-bulk-add-schema.test.ts feat: bulk update tags (#3274) 2023-03-09 11:58:06 +02:00
tags-bulk-add-schema.ts chore: amend open api tags descriptions and examples (#3519) 2023-04-14 12:26:19 +02:00
tags-schema.ts chore: amend open api tags descriptions and examples (#3519) 2023-04-14 12:26:19 +02:00
toggle-maintenance-schema.ts feat: Maintenance openapi (#3478) 2023-04-10 09:55:29 +02:00
token-string-list-schema.ts docs: Added docs for edge endpoints (#3501) 2023-04-14 15:39:39 +02:00
token-user-schema.test.ts refactor: add missing tokenUserSchema fields (#1742) 2022-06-22 15:37:26 +02:00
token-user-schema.ts refactor: add missing tokenUserSchema fields (#1742) 2022-06-22 15:37:26 +02:00
ui-config-schema.test.ts fix: add missing environments field to uiConfigSchema (#1736) 2022-06-21 09:34:07 +02:00
ui-config-schema.ts feat: message banner (variants) (#3788) 2023-05-18 09:38:59 +01:00
update-api-token-schema.ts fix: avoid 400s for unknown request body fields (#1737) 2022-06-21 10:33:03 +02:00
update-feature-schema.ts refactor: add soft response schema validation (#1657) 2022-06-08 08:01:14 +02:00
update-feature-strategy-schema.ts Feat/enable disable strategies (#3566) 2023-04-21 12:09:07 +03:00
update-tag-type-schema.ts fix: avoid 400s for unknown request body fields (#1737) 2022-06-21 10:33:03 +02:00
update-tags-schema.test.ts feat: bulk update tags (#3274) 2023-03-09 11:58:06 +02:00
update-tags-schema.ts docs: improve open api (#3535) 2023-04-18 08:50:36 +02:00
update-user-schema.ts fix: Make additionalProperties true (#1861) 2022-07-27 09:02:02 +02:00
upsert-context-field-schema.ts fix: avoid 400s for unknown request body fields (#1737) 2022-06-21 10:33:03 +02:00
upsert-segment-schema.ts fix: segments schemas (#3525) 2023-04-17 10:51:48 +02:00
upsert-strategy-schema.ts refactor: add schemas to strategy controller (#1744) 2022-06-23 08:10:20 +02:00
user-schema.test.ts refactor: remove bootstrap endpoint (#1900) 2022-08-09 15:58:27 +02:00
user-schema.ts feat: adapt user logic to better adapt to SAs (#2917) 2023-01-18 12:12:44 +00:00
users-groups-base-schema.test.ts Grouping access endpoing (#1858) 2022-07-26 11:39:55 +00:00
users-groups-base-schema.ts Grouping access endpoing (#1858) 2022-07-26 11:39:55 +00:00
users-schema.test.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
users-schema.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
users-search-schema.test.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
users-search-schema.ts refactor: add schemas to user admin controller (#1692) 2022-06-22 14:55:43 +02:00
validate-password-schema.test.ts Task/open api reset password (#1740) 2022-06-22 14:31:41 +03:00
validate-password-schema.ts Task/open api reset password (#1740) 2022-06-22 14:31:41 +03:00
validate-tag-type-schema.ts fix: avoid 400s for unknown request body fields (#1737) 2022-06-21 10:33:03 +02:00
validated-edge-tokens-schema.ts docs: Added docs for edge endpoints (#3501) 2023-04-14 15:39:39 +02:00
variant-flag-schema.ts feat: message banner (variants) (#3788) 2023-05-18 09:38:59 +01:00
variant-schema.ts refactor: use the same variant schema for the admin and client APIs (#1882) 2022-08-08 16:21:57 +02:00
variants-schema.ts refactor: add soft response schema validation (#1657) 2022-06-08 08:01:14 +02:00
version-schema.ts refactor: add OpenAPI schema to UI config controller (#1681) 2022-06-08 14:57:39 +02:00