Skip to content

docs(cli): Clarify the service parameter of the API command #294

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

Merged
gtema merged 1 commit into from
Jun 26, 2024
Merged

docs(cli): Clarify the service parameter of the API command #294

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions doc/src/osc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -802,11 +802,11 @@ Example:

```console osc --os-cloud devstack api compute flavors/detail | jq ```

**Usage:** `osc api [OPTIONS] <SERVICE> <URL>`
**Usage:** `osc api [OPTIONS] <SERVICE_TYPE> <URL>`

###### **Arguments:**

* `<SERVICE>` — Service name
* `<SERVICE_TYPE>` — Service type as used in the service catalog
* `<URL>` — Rest URL (relative to the endpoint information from the service catalog). Do not start URL with the "/" to respect endpoint version information

###### **Options:**
Expand Down
10 changes: 5 additions & 5 deletions openstack_cli/src/api/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ impl From<Method> for http::Method {
/// ```
#[derive(Debug, Parser)]
pub struct ApiCommand {
/// Service name
/// Service type as used in the service catalog
#[arg()]
service: String,
service_type: String,

/// Rest URL (relative to the endpoint information
/// from the service catalog). Do not start URL with
Expand Down Expand Up @@ -119,11 +119,11 @@ impl ApiCommand {
let op = OutputProcessor::from_args(parsed_args);
op.validate_args(parsed_args)?;

let service = ServiceType::from(self.service.as_str());
let service_type = ServiceType::from(self.service_type.as_str());

client.discover_service_endpoint(&service).await?;
client.discover_service_endpoint(&service_type).await?;

let service_endpoint = client.get_service_endpoint(&service, None)?;
let service_endpoint = client.get_service_endpoint(&service_type, None)?;

let endpoint = service_endpoint.build_request_url(&self.url)?;

Expand Down