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

Update openapi.yml #2983

Closed
wants to merge 1 commit into from
Closed

Conversation

dataprolet
Copy link

Describe your changes

Delete policy description from required.

Issue ticket number and link

netbirdio/docs#254

Checklist

  • Is it a bug fix
  • Is a typo/documentation fix
  • Is a feature enhancement
  • It is a refactor
  • Created tests that fail without the change (if possible)
  • Extended the README / documentation, if necessary

Policy description is not required.
@CLAassistant
Copy link

CLAassistant commented Dec 4, 2024

CLA assistant check
All committers have signed the CLA.

Copy link

sonarqubecloud bot commented Dec 4, 2024

@pascal-fischer
Copy link
Contributor

pascal-fischer commented Dec 6, 2024

Hi @dataprolet, you are correct the description is not required in the request body but in the response we want to have it mandatory so this will require some further adjustments in the code.

I have another PR pending which will include some changes to the policies API anyway. I can include this change there.

EDIT: Sorry this statement was not fully correct. It will work properly if we do the correct nil handling. The openapi.yml is used to generate our api proto in https://github.com/netbirdio/netbird/blob/main/management/server/http/api/types.gen.go with the generate.sh scrip. Afterwards, we need to add the nil handling as it will convert optional values to pointers and the description will now be a string pointer

@mlsmaycon
Copy link
Collaborator

This will be properly updated in ##2997

@mlsmaycon mlsmaycon closed this Dec 16, 2024
@mlsmaycon
Copy link
Collaborator

Thanks @dataprolet

@dataprolet dataprolet deleted the dataprolet-patch-1 branch December 16, 2024 09:12
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.

4 participants