Skip to content

README update with swagger generation steps accounting for local properties #45

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README update with swagger generation steps accounting for local properties #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,20 @@ See the Makefile there.

To file an issue, please use our [community issue tracker](https://github.com/signadot/community/issues).


## Note
At this time, we have marked two properties related to Local with swaggerignore in Sandbox spec
so that these properties don't show up in the public API Reference.

```
Local []Local `json:"local,omitempty" swaggerignore:"true"`
LocalMachineID *string `json:"localMachineID,omitempty" validate:"optional" swaggerignore:"true"`
```

However, they are needed by the CLI. Hence, here's the step to get the swagger accounting for that.

```
1. remove the swaggerignore for the 2 local related properties mentioned above in the Signadot repo
2. generate swagger: `make swagger-control`
3. copy the generated swagger to the go-sdk swagger.json
4. run `make` in the generate directory in the go-sdk
```