Skip to content

Move /hardware/ under /system/ as per RFD-288#1677

Merged
just-be-dev merged 6 commits into
mainfrom
nest-hardware-system
Sep 9, 2022
Merged

Move /hardware/ under /system/ as per RFD-288#1677
just-be-dev merged 6 commits into
mainfrom
nest-hardware-system

Conversation

@just-be-dev

@just-be-dev just-be-dev commented Sep 6, 2022

Copy link
Copy Markdown
Contributor

Part of the work to #1675.

My current understanding as per my conversation with @karencfv last week is that system will be the root command in the CLI which these operator commands will be grouped under. As such, I've prepended system to the method name.

@just-be-dev just-be-dev requested a review from ahl September 6, 2022 20:24
@just-be-dev just-be-dev mentioned this pull request Sep 6, 2022
8 tasks
Comment thread nexus/src/external_api/http_entrypoints.rs Outdated
@ahl

ahl commented Sep 6, 2022

Copy link
Copy Markdown
Contributor

My current understanding as per my conversation with @karencfv last week is that system will be the root command in the CLI which these operator commands will be grouped under. As such, I've prepended system to the method name.

I think we should not prepend system_ to all these methods, but I don't feel that strongly. I also think we should put them all under a system tag (we have too many tags right now, again IMO).

With regard to the CLI, our intention is to generate a big chunk of it... and to manually intervene. For example, we might take the clap hierarchy and then hoist all the subtrees with the system tag under a system subcommand.

All this is to say: we have several different consumers for the operationId: the CLI, the API, and the SDKs. I think in this case it makes more sense to do some manual intervention in the CLI than it does to impose a prefix for the API and SDKs, but I'd love to have that discussion.

@just-be-dev

Copy link
Copy Markdown
Contributor Author

Sounds good! I'll remove it for this PR and update the tags.

@ahl

ahl commented Sep 6, 2022

Copy link
Copy Markdown
Contributor

thanks! there's tags review on my list. I should find a way to make these pending work items visible...

@karencfv

karencfv commented Sep 6, 2022

Copy link
Copy Markdown
Contributor

I agree! system_ does not have to be prepended. Having the endpoint path start with /system/ should be enough imo :)

This will also make it clear for the terraform provider resource schema which is not (and most likely never be) generated based on tags or operation IDs.

@karencfv

karencfv commented Sep 6, 2022

Copy link
Copy Markdown
Contributor

Thanks for working on this @zephraph btw!!!!

@just-be-dev just-be-dev marked this pull request as ready for review September 9, 2022 17:44
@just-be-dev just-be-dev merged commit 6e08b61 into main Sep 9, 2022
@just-be-dev just-be-dev deleted the nest-hardware-system branch September 9, 2022 18:17
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