Frontend api openapi spec #4133
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ |
kwasniew
commented
Jul 3, 2023
| @@ -47,11 +46,7 @@ class IndexRouter extends Controller { | |||
|
|
|||
| this.use( | |||
| '/api/frontend', | |||
| conditionalMiddleware( | |||
There was a problem hiding this comment.
conditionalMiddleware is hiding openapi definitions so I moved the flag inside the 3 controller methods in the frontend API
kwasniew
commented
Jul 3, 2023
| @@ -146,6 +164,9 @@ export default class ProxyController extends Controller { | |||
| req: ApiUserRequest, | |||
| res: Response<ProxyFeaturesSchema>, | |||
| ) { | |||
| if (!this.config.flagResolver.isEnabled('embedProxy')) { | |||
There was a problem hiding this comment.
replaces conditional middleware
kwasniew
commented
Jul 3, 2023
| @@ -9,12 +9,19 @@ export const proxyFeatureSchema = { | |||
| properties: { | |||
| name: { | |||
| type: 'string', | |||
| example: 'disable-comments', | |||
| description: 'Unique feature name.', | |||
There was a problem hiding this comment.
syncing descriptions with the feature-schema
kwasniew
commented
Jul 3, 2023
| }, | ||
| enabled: { | ||
| type: 'boolean', | ||
| example: true, | ||
| description: 'Always set to `true`.', |
There was a problem hiding this comment.
FRONTEND api returns only enabled toggles for a given context
kwasniew
commented
Jul 3, 2023
| @@ -68,7 +70,12 @@ export default class ProxyController extends Controller { | |||
| operationId: 'getFrontendFeatures', | |||
| responses: { | |||
| 200: createResponseSchema('proxyFeaturesSchema'), | |||
| ...getStandardResponses(401, 404), | |||
There was a problem hiding this comment.
404 when the frontend api/embedProxy is disabled
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
About the changes
Improving openapi spec for the frontend api - details inline
Important files
Discussion points