Skip to content

feat: add feature_flags parameter to the getSite endpoint #466

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

Merged
merged 6 commits into from
Jun 9, 2023

Conversation

sarahetter
Copy link
Contributor

@sarahetter sarahetter commented Jun 6, 2023

Adds to the swagger documentation the ability to pass in a feature_flags parameter to the getSite api, which will return a list of feature flags and whether or not they are enabled.

Unsure about the values, but went off of this definition: https://github.com/netlify/bitballoon/pull/15495/files#diff-c7977f571d39c09cf8480243e53e44eb1c40acfc7fcb1d76446222e28de96478R100

Also unsure about how to mark as x-internal, as elsewhere in the swagger, only endpoints are set with tags: [x-internal], not parameters.

Depends on: https://github.com/netlify/bitballoon/pull/15495
Related: https://github.com/netlify/pod-dev-foundations/issues/519

@sarahetter sarahetter requested a review from eduardoboucas June 6, 2023 20:47
@sarahetter sarahetter requested review from a team as code owners June 6, 2023 20:47
@netlify
Copy link

netlify bot commented Jun 6, 2023

Deploy Preview for open-api ready!

Name Link
🔨 Latest commit 07300af
🔍 Latest deploy log https://app.netlify.com/sites/open-api/deploys/6482dc281c87c90008dd33e9
😎 Deploy Preview https://deploy-preview-466--open-api.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@sarahetter
Copy link
Contributor Author

@mraerino I've updated to the newer version of redoc cli (the version we were using was deprecated) - and now this allows for us to filter out properties & methods with x-internal:true as described here: https://redocly.com/docs/cli/guides/hide-apis/, while keeping the swagger.yml with all the correct info for the api.

I'm also seeing that the "Verify Go client" job is failing - I know nothing about Go - what do I need to do here to be able to run make all?

@erikw
Copy link
Contributor

erikw commented Jun 9, 2023

I'm also seeing that the "Verify Go client" job is failing

I ran make all and pushed the regenerated changed in 07300af and the action "Verify Go client" is now green.

what do I need to do here to be able to run make all?

I think it was something like this:

  • Install Go locally, same version used in this project
  • Enable fetch of private go modules in ~/.gitconfig with
     [url "ssh://[email protected]/"]
         insteadOf = https://github.com/

Copy link
Contributor

@erikw erikw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

x-internals are not visible in the deploy preview 👍

https://deploy-preview-466--open-api.netlify.app/#tag/site/operation/getSite

@sarahetter sarahetter merged commit 554c19c into master Jun 9, 2023
@sarahetter sarahetter deleted the se/feature-flags-get-site branch June 9, 2023 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants