Skip to content

Conversation

@sunshowers
Copy link
Contributor

The Nexus external API uses several types from oximeter, and in the interest of
keeping the upcoming nexus-external-api crate's graph small, it makes sense to
split it into three crates.

The crates are:

  • oximeter-types: Core type definitions (there are a lot of them).
  • oximeter-schema: Library for working with schemas.
  • oximeter-test-utils: Test utilities.

The names match the other services in omicron, e.g. sled-agent-types and
nexus-test-utils.

Created using spr 1.3.6-beta.1
@sunshowers sunshowers requested a review from bnaecker August 16, 2024 04:35
@sunshowers sunshowers marked this pull request as draft August 16, 2024 07:50
@sunshowers
Copy link
Contributor Author

Oh need to update doctests too.

Created using spr 1.3.6-beta.1
@sunshowers sunshowers marked this pull request as ready for review August 16, 2024 18:07
Copy link
Collaborator

@bnaecker bnaecker left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for cleaning it up with minimal fuss! I have a few questions, but they're really just informational, not blocking the PR. Thanks!

@sunshowers sunshowers enabled auto-merge (squash) August 17, 2024 01:45
Created using spr 1.3.6-beta.1
sunshowers added a commit to sunshowers/omicron that referenced this pull request Aug 17, 2024
The Nexus external API uses several types from oximeter, and in the interest of
keeping the upcoming nexus-external-api crate's graph small, it makes sense to
split it into three crates.

The crates are:

* **oximeter-types**: Core type definitions (there are a lot of them).
* **oximeter-schema**: Library for working with schemas.
* **oximeter-test-utils**: Test utilities.

The names match the other services in omicron, e.g. `sled-agent-types` and
`nexus-test-utils`.

Pull Request: oxidecomputer#6355
@sunshowers sunshowers changed the title [oximeter] split oximeter-impl into -types, -schema and -test-utils [1/6] [oximeter] split oximeter-impl into -types, -schema and -test-utils Aug 17, 2024
@sunshowers sunshowers merged commit fac7e27 into main Aug 17, 2024
@sunshowers sunshowers deleted the sunshowers/spr/oximeter-split-oximeter-impl-into-types-schema-and-test-utils branch August 17, 2024 03:05
sunshowers added a commit that referenced this pull request Aug 28, 2024
At long last, here's the last OpenAPI document converted into a trait: the
Nexus external API. This is a fairly large change, but with all the
prerequisites in place the conversion is overall pretty mechanical. I did need
to move some types around, but the bulk of the PR is just adding the very large
external API trait.

This PR also adds a `.git-blame-ignore-revs` entry corresponding to #6372, so that the indent doesn't ruin blame in the GitHub web view. (You can configure this locally as well with `git config blame.ignoreRevsFile .git-blame-ignore-revs`.)

In a subsequent PR I'll remove the old instructions.

Depends on:

* #6355
* #6364 
* #6369
* #6370
* #6372

Co-authored-by: David Crespo <david.crespo@oxidecomputer.com>
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.

3 participants