Skip to content

Commit

Permalink
Noting action name restrictions, and correcting those of auth methods…
Browse files Browse the repository at this point in the history
… and roles (#19905)
  • Loading branch information
philrenaud authored Feb 8, 2024
1 parent fc26e0c commit 41c783a
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 11 deletions.
6 changes: 3 additions & 3 deletions website/content/api-docs/acl/auth-methods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ The table below shows this endpoint's support for
### Parameters

- `Name` `(string: <required>)` - Name is the identifier of the ACL auth method.
The name can contain alphanumeric characters, dashes, and underscores. This
name must be unique and must not exceed 128 characters.
The name can contain alphanumeric characters and dashes. This name must be
unique and must not exceed 128 characters.

- `Type` `(string: <required>)` - ACL auth method type, supports `OIDC` and `JWT`.

Expand Down Expand Up @@ -219,7 +219,7 @@ queries](/nomad/api-docs#blocking-queries) and [required ACLs](/nomad/api-docs#a
### Parameters

- `Name` `(string: <required>)` - Names is the identifier of the ACL auth
method. The name can contain alphanumeric characters, dashes, and underscores.
method. The name can contain alphanumeric characters and dashes.
This name must be unique and must not exceed 128 characters.

- `Type` `(string: <required>)` - ACL auth role SSO identifier. Currently, the
Expand Down
4 changes: 2 additions & 2 deletions website/content/api-docs/acl/roles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The table below shows this endpoint's support for
### Parameters

- `Name` `(string: <required>)` - Specifies the human-readable name of the ACL
Role. The name can contain alphanumeric characters, dashes, and underscores.
Role. The name can contain alphanumeric characters and dashes.
This name must be unique and must not exceed 128 characters.

- `Description` `(string: <optional>)` - A free form human-readable description
Expand Down Expand Up @@ -102,7 +102,7 @@ The table below shows this endpoint's support for
updated. Must match payload body and request path.

- `Name` `(string: <required>)` - Specifies the human-readable name of the ACL
Role. The name can contain alphanumeric characters, dashes, and underscores.
Role. The name can contain alphanumeric characters and dashes.
This name must be unique a must not exceed 128 characters.

- `Description` `(string: <optional>)` - A free form human-readable description
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/commands/acl/auth-method/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ The `acl auth-method update` command requires an existing method's name.
## Update Options

- `-name`: Sets the human-readable name for the ACL Role. It is required and
can contain alphanumeric characters, dashes, and underscores. This name must
be unique and must not exceed 128 characters.
can contain alphanumeric characters and dashes. This name must be unique and
must not exceed 128 characters.

- `-description`: A free form text description of the role that must not exceed
256 characters.
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/commands/acl/role/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ via flags detailed below.
## Create Options

- `-name`: Sets the human-readable name for the ACL Role. It is required and
can contain alphanumeric characters, dashes, and underscores. This name must
be unique and must not exceed 128 characters.
can contain alphanumeric characters and dashes. This name must be unique and
must not exceed 128 characters.

- `-description`: A free form text description of the role that must not exceed
256 characters.
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/commands/acl/role/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ The `acl role update` command requires an existing role's ID.
## Update Options

- `-name`: Sets the human-readable name for the ACL Role. It is required and
can contain alphanumeric characters, dashes, and underscores. This name must
be unique and must not exceed 128 characters.
can contain alphanumeric characters and dashes. This name must be unique and
must not exceed 128 characters.

- `-description`: A free form text description of the role that must not exceed
256 characters.
Expand Down
3 changes: 3 additions & 0 deletions website/content/docs/job-specification/action.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ The `action` block allows job authors to define custom commands. These commands
can be executed by operators with the necessary permissions on a running
allocation, offering a controlled way to interact with tasks.

The name of the action can contain alphanumeric characters and dashes. This
name must be unique within its task and must not exceed 128 characters.

## `action` Parameters

- `command` `(string: <required>)` - Specifies the command to be executed.
Expand Down

0 comments on commit 41c783a

Please sign in to comment.