CHAINSAW-234 Add environments to schema

[Tomboyo]

Overview

Adds the rhsm.environments field to the system profile schema, per CONTRIBUTING guidelines of inventory-schemas. See RedHatInsights/inventory-schemas#145. Let me know if I'm issing anything!

PR Checklist

• Keep PR title short, ideally under 72 characters
• Descriptive comments provided in complex code blocks
• Include raw query examples in the PR description, if adding/modifying SQL query
• Tests: validate optimal/expected output
• Tests: validate exceptions and failure scenarios
• Tests: edge cases
• Recovers or fails gracefully during potential resource outages (e.g. DB, Kafka)
• Uses type hinting, if convenient
• Documentation, if this PR changes the way other services interact with host inventory
• Links to related PRs

Secure Coding Practices Documentation Reference

You can find documentation on this checklist here.

Secure Coding Checklist

• Input Validation
• Output Encoding
• Authentication and Password Management
• Session Management
• Access Control
• Cryptographic Practices
• Error Handling and Logging
• Data Protection
• Communication Security
• System Configuration
• Database Security
• File Management
• Memory Management
• General Coding Practices

[kruai]

Let's discuss the changes on this PR instead. The process is that after the inventory-schemas PR is merged, we open an insights-host-inventory PR with the automated changes from make update_schema.

[Tomboyo]

Per Candlepin maintainer feedback, I've updated the environment ID schema to be an opaque string, and removed any reference to it being a UUID in favor of just calling it an ID. I've also renamed rhsm.environments to rhsm.environment_ids so it's clear that the field contains identifiers. The same is done in the https://github.com/RedHatInsights/inventory-schemas/pull/145/files PR, so per Kruai we can continue conversation over there if that's preferred. Thanks all.

[Tomboyo]

@kruai Locally I reset --hard this branch to the tip of master and ran make update-schema, but the redocly hook failed because "openapi.dev.json does not exist or is invalid." I am not familiar with this repo and the redocly setup in particular, but it looked like the redocly file was just pointing to the wrong relative path (missing ./swagger/ prefix), so I updated it to resolve the issue.

Update: Ah, and of course that change breaks the CI PR build step. :P I'll investigate further in the morning.

[Tomboyo]

Closing as obsoleted by bc61958, which already has the desired updates in it.