Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
39 changes: 37 additions & 2 deletions .github/workflows/validate_docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,35 @@ on:
pull_request:

permissions:
contents: read
contents: write
pull-requests: write

jobs:
validate_docs:
name: Validate CLI Docs
runs-on: ubuntu-latest
steps:
- name: Determine if PR is from Renovate
id: author_check
run: |
is_renovate=${{github.actor == 'ctreatma' && startsWith(github.head_ref, 'auto')}}
echo "is_renovate=$is_renovate" | tee $GITHUB_OUTPUT


- name: Debug step outputs
run: echo "${{ toJSON(steps.author_check) }}"

- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
if: steps.author_check.outputs.is_renovate != 'true'
with:
fetch-depth: 1

# If this is a Renovate PR, check out the PR head ref so we can commit and push
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
if: steps.author_check.outputs.is_renovate == 'true'
with:
ref: ${{ github.event.pull_request.head.ref }}

- name: Set up Go
uses: actions/setup-go@4dc6199c7b1a012772edbd06daecab0f50c9053c # v6.1.0
with:
Expand All @@ -26,8 +43,26 @@ jobs:
id: validate_docs
run: make docs-check

# Push docs changes to Renovate PRs since Renovate
# can't respond to comments
- if: |
always() &&
steps.author_check.outputs.is_renovate == 'true' &&
steps.validate_docs.outcome == 'failure'
run: |
git config --global user.name 'equinix-labs@auto-commit-workflow'
git config --global user.email 'bot@equinix.noreply.github.com'
git add docs
git commit -m "chore(docs): automated commit of updated documentation" || echo "No changes to commit"
git push

# Post a sticky comment on non-Renovate PRs to direct
# contributors to update docs when needed
- uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4
if: always() && (steps.validate_docs.outcome == 'failure')
if: |
always() &&
steps.author_check.outputs.is_renovate == 'false' &&
(steps.validate_docs.outcome == 'failure')
with:
header: pr-docs-error
message: |
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/validate_pr_title.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ on:
types:
- opened
- edited
- synchronize

permissions:
pull-requests: write
Expand Down
7 changes: 7 additions & 0 deletions docs/equinix_fabricv4.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,16 @@ providing access to all available API services.
### SEE ALSO

* [equinix](equinix.md) - Equinix CLI
* [equinix fabricv4 agent-templates](equinix_fabricv4_agent-templates.md) - Manage agent-templates resources
* [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources
* [equinix fabricv4 cloud-events](equinix_fabricv4_cloud-events.md) - Manage cloud-events resources
* [equinix fabricv4 cloud-routers](equinix_fabricv4_cloud-routers.md) - Manage cloud-routers resources
* [equinix fabricv4 company-profiles](equinix_fabricv4_company-profiles.md) - Manage company-profiles resources
* [equinix fabricv4 connections](equinix_fabricv4_connections.md) - Manage connections resources
* [equinix fabricv4 health](equinix_fabricv4_health.md) - Manage health resources
* [equinix fabricv4 internet-access-services](equinix_fabricv4_internet-access-services.md) - Manage internet-access-services resources
* [equinix fabricv4 ip-blocks](equinix_fabricv4_ip-blocks.md) - Manage ip-blocks resources
* [equinix fabricv4 logos](equinix_fabricv4_logos.md) - Manage logos resources
* [equinix fabricv4 marketplace-subscriptions](equinix_fabricv4_marketplace-subscriptions.md) - Manage marketplace-subscriptions resources
* [equinix fabricv4 metrics](equinix_fabricv4_metrics.md) - Manage metrics resources
* [equinix fabricv4 metros](equinix_fabricv4_metros.md) - Manage metros resources
Expand All @@ -49,4 +55,5 @@ providing access to all available API services.
* [equinix fabricv4 stream-alert-rules](equinix_fabricv4_stream-alert-rules.md) - Manage stream-alert-rules resources
* [equinix fabricv4 stream-subscriptions](equinix_fabricv4_stream-subscriptions.md) - Manage stream-subscriptions resources
* [equinix fabricv4 streams](equinix_fabricv4_streams.md) - Manage streams resources
* [equinix fabricv4 tags](equinix_fabricv4_tags.md) - Manage tags resources

28 changes: 28 additions & 0 deletions docs/equinix_fabricv4_agent-templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## equinix fabricv4 agent-templates

Manage agent-templates resources

### Synopsis

Commands for managing agent-templates resources in the API

### Options

```
-h, --help help for agent-templates
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/.config/equinix/equinix.yaml)
--debug Enable debug logging for HTTP requests
-f, --format string Format to use for output (json or yaml) (default "json")
```

### SEE ALSO

* [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources
* [equinix fabricv4 agent-templates get-agent-template-by-uuid](equinix_fabricv4_agent-templates_get-agent-template-by-uuid.md) - Execute get-agent-template-by-uuid operation
* [equinix fabricv4 agent-templates get-agent-templates](equinix_fabricv4_agent-templates_get-agent-templates.md) - Execute get-agent-templates operation

Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## equinix fabricv4 agent-templates get-agent-template-by-uuid

Execute get-agent-template-by-uuid operation

### Synopsis

Execute the get-agent-template-by-uuid operation on this service.

Use --request flag to provide a JSON payload for the request body.
Example: --request '{"field":"value"}'

The command accepts parameters based on the SDK method signature.

```
equinix fabricv4 agent-templates get-agent-template-by-uuid [flags]
```

### Options

```
-h, --help help for get-agent-template-by-uuid
--limit int limit field
--offset int offset field
--request string JSON payload for additional optional fields not exposed as flags
--uuid string uuid (required)
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/.config/equinix/equinix.yaml)
--debug Enable debug logging for HTTP requests
-f, --format string Format to use for output (json or yaml) (default "json")
```

### SEE ALSO

* [equinix fabricv4 agent-templates](equinix_fabricv4_agent-templates.md) - Manage agent-templates resources

38 changes: 38 additions & 0 deletions docs/equinix_fabricv4_agent-templates_get-agent-templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## equinix fabricv4 agent-templates get-agent-templates

Execute get-agent-templates operation

### Synopsis

Execute the get-agent-templates operation on this service.

Use --request flag to provide a JSON payload for the request body.
Example: --request '{"field":"value"}'

The command accepts parameters based on the SDK method signature.

```
equinix fabricv4 agent-templates get-agent-templates [flags]
```

### Options

```
-h, --help help for get-agent-templates
--limit int limit field
--offset int offset field
--request string JSON payload for additional optional fields not exposed as flags
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/.config/equinix/equinix.yaml)
--debug Enable debug logging for HTTP requests
-f, --format string Format to use for output (json or yaml) (default "json")
```

### SEE ALSO

* [equinix fabricv4 agent-templates](equinix_fabricv4_agent-templates.md) - Manage agent-templates resources

32 changes: 32 additions & 0 deletions docs/equinix_fabricv4_agents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## equinix fabricv4 agents

Manage agents resources

### Synopsis

Commands for managing agents resources in the API

### Options

```
-h, --help help for agents
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/.config/equinix/equinix.yaml)
--debug Enable debug logging for HTTP requests
-f, --format string Format to use for output (json or yaml) (default "json")
```

### SEE ALSO

* [equinix fabricv4](equinix_fabricv4.md) - Manage Equinix fauricv4 resources
* [equinix fabricv4 agents create-agent](equinix_fabricv4_agents_create-agent.md) - Execute create-agent operation
* [equinix fabricv4 agents delete-agent-by-uuid](equinix_fabricv4_agents_delete-agent-by-uuid.md) - Execute delete-agent-by-uuid operation
* [equinix fabricv4 agents get-agent-activities](equinix_fabricv4_agents_get-agent-activities.md) - Execute get-agent-activities operation
* [equinix fabricv4 agents get-agent-by-uuid](equinix_fabricv4_agents_get-agent-by-uuid.md) - Execute get-agent-by-uuid operation
* [equinix fabricv4 agents get-agents](equinix_fabricv4_agents_get-agents.md) - Execute get-agents operation
* [equinix fabricv4 agents patch-agent-by-uuid](equinix_fabricv4_agents_patch-agent-by-uuid.md) - Execute patch-agent-by-uuid operation

47 changes: 47 additions & 0 deletions docs/equinix_fabricv4_agents_create-agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## equinix fabricv4 agents create-agent

Execute create-agent operation

### Synopsis

Execute the create-agent operation on this service.

Use --request flag to provide a JSON payload for the request body.
Example: --request '{"field":"value"}'

The command accepts parameters based on the SDK method signature.

```
equinix fabricv4 agents create-agent [flags]
```

### Options

```
--agent-post-request-additional-properties string agent-post-request-additional-properties (JSON)
--agent-post-request-agent-template-additional-properties string agent-post-request-agent-template-additional-properties (JSON)
--agent-post-request-agent-template-uuid string agent-post-request-agent-template-uuid
--agent-post-request-configuration-additional-properties string agent-post-request-configuration-additional-properties (JSON)
--agent-post-request-configuration-prompt string agent-post-request-configuration-prompt
--agent-post-request-description string agent-post-request-description
--agent-post-request-enabled agent-post-request-enabled
--agent-post-request-name string agent-post-request-name
--agent-post-request-project-additional-properties string agent-post-request-project-additional-properties (JSON)
--agent-post-request-project-project-id string Subscriber-assigned project ID
--agent-post-request-type string agent-post-request-type
-h, --help help for create-agent
--request string JSON payload for additional optional fields not exposed as flags
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/.config/equinix/equinix.yaml)
--debug Enable debug logging for HTTP requests
-f, --format string Format to use for output (json or yaml) (default "json")
```

### SEE ALSO

* [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources

39 changes: 39 additions & 0 deletions docs/equinix_fabricv4_agents_delete-agent-by-uuid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## equinix fabricv4 agents delete-agent-by-uuid

Execute delete-agent-by-uuid operation

### Synopsis

Execute the delete-agent-by-uuid operation on this service.

Use --request flag to provide a JSON payload for the request body.
Example: --request '{"field":"value"}'

The command accepts parameters based on the SDK method signature.

```
equinix fabricv4 agents delete-agent-by-uuid [flags]
```

### Options

```
-h, --help help for delete-agent-by-uuid
--limit int limit field
--offset int offset field
--request string JSON payload for additional optional fields not exposed as flags
--uuid string uuid (required)
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/.config/equinix/equinix.yaml)
--debug Enable debug logging for HTTP requests
-f, --format string Format to use for output (json or yaml) (default "json")
```

### SEE ALSO

* [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources

39 changes: 39 additions & 0 deletions docs/equinix_fabricv4_agents_get-agent-activities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## equinix fabricv4 agents get-agent-activities

Execute get-agent-activities operation

### Synopsis

Execute the get-agent-activities operation on this service.

Use --request flag to provide a JSON payload for the request body.
Example: --request '{"field":"value"}'

The command accepts parameters based on the SDK method signature.

```
equinix fabricv4 agents get-agent-activities [flags]
```

### Options

```
-h, --help help for get-agent-activities
--limit int limit field
--offset int offset field
--param-1 string param-1 (required)
--request string JSON payload for additional optional fields not exposed as flags
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/.config/equinix/equinix.yaml)
--debug Enable debug logging for HTTP requests
-f, --format string Format to use for output (json or yaml) (default "json")
```

### SEE ALSO

* [equinix fabricv4 agents](equinix_fabricv4_agents.md) - Manage agents resources

Loading