|
1 | 1 | /v3/feature_flags: |
2 | 2 | get: |
3 | 3 | summary: List feature flags |
4 | | - description: Retrieve all feature_flags. |
| 4 | + description: |- |
| 5 | + Retrieve all feature_flags. |
| 6 | +
|
| 7 | + **Permitted roles:** All Roles |
5 | 8 | operationId: listFeatureFlags |
6 | 9 | tags: |
7 | 10 | - Feature Flags |
8 | 11 | parameters: |
9 | 12 | - $ref: ../components/parameters/Page.yaml |
10 | 13 | - $ref: ../components/parameters/PerPage.yaml |
11 | | - - $ref: ../components/parameters/OrderBy.yaml |
12 | | - - name: updated_ats |
| 14 | + - name: order_by |
13 | 15 | in: query |
14 | 16 | required: false |
15 | 17 | schema: |
16 | 18 | type: string |
17 | | - description: | |
18 | | - Timestamp to filter by. When filtering on equality, several comma-delimited timestamps may be passed. |
| 19 | + description: Value to sort by. Defaults to `name` ascending; prepend with `-` to sort descending. Valid value is `name` |
| 20 | + - $ref: ../components/parameters/UpdatedAts.yaml |
19 | 21 | responses: |
20 | 22 | '200': |
21 | 23 | description: OK |
|
58 | 60 | $ref: ../components/responses/Unauthorized.yaml |
59 | 61 | '403': |
60 | 62 | $ref: ../components/responses/Forbidden.yaml |
61 | | - '409': |
62 | | - $ref: ../components/responses/Conflict.yaml |
63 | | - '422': |
64 | | - $ref: ../components/responses/UnprocessableEntity.yaml |
65 | 63 | '500': |
66 | 64 | $ref: ../components/responses/500.yaml |
67 | | - '502': |
68 | | - $ref: ../components/responses/BadGateway.yaml |
69 | 65 | '503': |
70 | 66 | $ref: ../components/responses/ServiceUnavailable.yaml |
71 | 67 | /v3/feature_flags/{name}: |
72 | 68 | get: |
73 | 69 | summary: Get a feature flag |
74 | | - description: Get a feature flag. |
| 70 | + description: |- |
| 71 | + Get a feature flag. |
| 72 | +
|
| 73 | + **Permitted roles:** All Roles |
75 | 74 | operationId: getFeatureFlag |
76 | 75 | tags: |
77 | 76 | - Feature Flags |
|
87 | 86 | - diego_docker |
88 | 87 | - diego_cnb |
89 | 88 | - env_var_visibility |
| 89 | + - hash_based_routing |
90 | 90 | - hide_marketplace_from_unauthenticated_users |
91 | 91 | - private_domain_creation |
92 | 92 | - resource_matching |
|
100 | 100 | - task_creation |
101 | 101 | - unset_roles_by_username |
102 | 102 | - user_org_creation |
103 | | - description: The name of the feature flag |
| 103 | + description: The name of the feature flag; must be one of the names in the [list of feature flags](#list-of-feature-flags) |
104 | 104 | responses: |
105 | 105 | '200': |
106 | 106 | description: Successfully retrieved feature flag |
|
127 | 127 | $ref: ../components/responses/NotFound.yaml |
128 | 128 | patch: |
129 | 129 | summary: Update a feature flag |
130 | | - description: Update a feature flag. |
| 130 | + description: |- |
| 131 | + Update a feature flag. |
| 132 | +
|
| 133 | + **Permitted roles:** Admin |
131 | 134 | operationId: updateFeatureFlag |
132 | 135 | tags: |
133 | 136 | - Feature Flags |
|
143 | 146 | - diego_docker |
144 | 147 | - diego_cnb |
145 | 148 | - env_var_visibility |
| 149 | + - hash_based_routing |
146 | 150 | - hide_marketplace_from_unauthenticated_users |
147 | 151 | - private_domain_creation |
148 | 152 | - resource_matching |
|
156 | 160 | - task_creation |
157 | 161 | - unset_roles_by_username |
158 | 162 | - user_org_creation |
159 | | - description: The name of the feature flag |
| 163 | + description: The name of the feature flag; must be one of the names in the [list of feature flags](#list-of-feature-flags) |
160 | 164 | requestBody: |
161 | 165 | description: Feature flag object that needs to be updated |
162 | 166 | required: true |
|
169 | 173 | type: boolean |
170 | 174 | description: Whether the feature flag is enabled |
171 | 175 | custom_error_message: |
172 | | - type: string |
| 176 | + type: [string, "null"] |
173 | 177 | description: The error string returned by the API when a client performs an action disabled by the feature flag |
174 | 178 | examples: |
175 | 179 | default: |
|
203 | 207 | $ref: ../components/responses/Forbidden.yaml |
204 | 208 | '404': |
205 | 209 | $ref: ../components/responses/NotFound.yaml |
206 | | - '409': |
207 | | - $ref: ../components/responses/Conflict.yaml |
208 | 210 | '422': |
209 | 211 | $ref: ../components/responses/UnprocessableEntity.yaml |
210 | 212 | '500': |
|
0 commit comments