oxidecomputer / oxidecomputer/omicron

`VpcFirewallRules` types in OpenAPI schema are divergent from typical patterns

Open
#1,814 1 comment 0 reactions 1 assignee View on GitHub

@plotnick is already working on this.

Since Oct 18, 2022.

api openapi
Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

I'm working through some updates to our mock server which we use for development and I've noticed that the firewall rule definitions in the OpenAPI spec are fairly inconsistent with the rest of the API.

The issues I've found thus far are:

  1. The list endpoint is misrepresented as a view endpoint. There is no view endpoint for firewall rules.
  2. The firewall rules updates is of type VpcFirewallRuleUpdateParams when it should be VpcFirewallRulesUpdate. Note that FirewallRules is plural which is slightly divergent to the rest of our API, but I think is more accurate because you can only update all the rules at once, not a single rule.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.