diff --git a/data/nav.yml b/data/nav.yml index 0655d53365..e7e77dcc29 100644 --- a/data/nav.yml +++ b/data/nav.yml @@ -557,11 +557,17 @@ - name: "Members" path: "apis/rest-api/organizations/members" pill: "beta" - - name: "Packages" + - name: "Packages " + # Keep space at end to prevent "Packages" in global nav bar being + # highlighted when any child page of "API > REST > Packages" is selected. children: + - name: "Registries" + path: "apis/rest-api/packages/registries" - name: "Registry Tokens" path: "apis/rest-api/packages/registry-tokens" - - name: "Pipelines" + - name: "Pipelines " + # Keep space at end to prevent "Pipelines" in global nav bar being + # highlighted when any child page of "API > REST > Pipelines" is selected. children: - name: "Overview" path: "apis/rest-api/pipelines" diff --git a/pages/agent/v3/help/_annotate.md b/pages/agent/v3/help/_annotate.md index b33c649c19..908a776370 100644 --- a/pages/agent/v3/help/_annotate.md +++ b/pages/agent/v3/help/_annotate.md @@ -56,7 +56,7 @@ $ ./script/dynamic_annotation_generator | buildkite-agent annotate --style "succ --context value #

The context of the annotation used to differentiate this annotation from others
Environment variable: $BUILDKITE_ANNOTATION_CONTEXT

--style value #

The style of the annotation (`success`, `info`, `warning` or `error`)
Environment variable: $BUILDKITE_ANNOTATION_STYLE

--append #

Append to the body of an existing annotation
Environment variable: $BUILDKITE_ANNOTATION_APPEND

---priority value #

Priority of the annotation (1 to 10). By default annotations have a priority of 3. Annotations with a priority of 10 will be shown first, and annotations with a priority of 1 will be shown last. (default: 0)
Environment variable: $BUILDKITE_ANNOTATION_PRIORITY

+--priority value #

The priority of the annotation (`1` to `10`). Annotations with a priority of `10` are shown first, while annotations with a priority of `1` are shown last. (default: 3)
Environment variable: $BUILDKITE_ANNOTATION_PRIORITY

--job value #

Which job should the annotation come from
Environment variable: $BUILDKITE_JOB_ID

--agent-access-token value #

The access token used to identify the agent
Environment variable: $BUILDKITE_AGENT_ACCESS_TOKEN

--endpoint value #

The Agent API endpoint (default: "https://agent.buildkite.com/v3")
Environment variable: $BUILDKITE_AGENT_ENDPOINT

diff --git a/pages/agent/v3/help/_bootstrap.md b/pages/agent/v3/help/_bootstrap.md index 00687c18c8..00d415841f 100644 --- a/pages/agent/v3/help/_bootstrap.md +++ b/pages/agent/v3/help/_bootstrap.md @@ -103,6 +103,7 @@ $ buildkite-agent bootstrap --build-path builds --redacted-vars value #

Pattern of environment variable names containing sensitive values (default: "*_PASSWORD", "*_SECRET", "*_TOKEN", "*_PRIVATE_KEY", "*_ACCESS_KEY", "*_SECRET_KEY", "*_CONNECTION_STRING")
Environment variable: $BUILDKITE_REDACTED_VARS

--strict-single-hooks #

Enforces that only one checkout hook, and only one command hook, can be run
Environment variable: $BUILDKITE_STRICT_SINGLE_HOOKS

--kubernetes-exec #

This is intended to be used only by the Buildkite k8s stack (github.com/buildkite/agent-stack-k8s); it enables a Unix socket for transporting logs and exit statuses between containers in a pod
Environment variable: $BUILDKITE_KUBERNETES_EXEC

+--trace-context-encoding value #

Sets the inner encoding for BUILDKITE_TRACE_CONTEXT. Must be either json or gob (default: "gob")
Environment variable: $BUILDKITE_TRACE_CONTEXT_ENCODING

diff --git a/pages/agent/v3/help/_pipeline_upload.md b/pages/agent/v3/help/_pipeline_upload.md index 0066ebbc4d..930fef94bf 100644 --- a/pages/agent/v3/help/_pipeline_upload.md +++ b/pages/agent/v3/help/_pipeline_upload.md @@ -58,6 +58,7 @@ $ ./script/dynamic_step_generator | buildkite-agent pipeline upload --reject-secrets #

When true, fail the pipeline upload early if the pipeline contains secrets
Environment variable: $BUILDKITE_AGENT_PIPELINE_UPLOAD_REJECT_SECRETS

--jwks-file value #

Path to a file containing a JWKS. Passing this flag enables pipeline signing
Environment variable: $BUILDKITE_AGENT_JWKS_FILE

--jwks-key-id value #

The JWKS key ID to use when signing the pipeline. Required when using a JWKS
Environment variable: $BUILDKITE_AGENT_JWKS_KEY_ID

+--signing-aws-kms-key value #

The AWS KMS key identifier which is used to sign pipelines.
Environment variable: $BUILDKITE_AGENT_AWS_KMS_KEY

--debug-signing #

Enable debug logging for pipeline signing. This can potentially leak secrets to the logs as it prints each step in full before signing. Requires debug logging to be enabled
Environment variable: $BUILDKITE_AGENT_DEBUG_SIGNING

--agent-access-token value #

The access token used to identify the agent
Environment variable: $BUILDKITE_AGENT_ACCESS_TOKEN

--endpoint value #

The Agent API endpoint (default: "https://agent.buildkite.com/v3")
Environment variable: $BUILDKITE_AGENT_ENDPOINT

diff --git a/pages/agent/v3/help/_start.md b/pages/agent/v3/help/_start.md index 8acb63c1a5..00cfe3c249 100644 --- a/pages/agent/v3/help/_start.md +++ b/pages/agent/v3/help/_start.md @@ -103,6 +103,7 @@ $ buildkite-agent start --token xxx --verification-jwks-file value #

Path to a file containing a JSON Web Key Set (JWKS), used to verify job signatures.
Environment variable: $BUILDKITE_AGENT_VERIFICATION_JWKS_FILE

--signing-jwks-file value #

Path to a file containing a signing key. Passing this flag enables pipeline signing for all pipelines uploaded by this agent. For hmac-sha256, the raw file content is used as the shared key
Environment variable: $BUILDKITE_AGENT_SIGNING_JWKS_FILE

--signing-jwks-key-id value #

The JWKS key ID to use when signing the pipeline. If omitted, and the signing JWKS contains only one key, that key will be used.
Environment variable: $BUILDKITE_AGENT_SIGNING_JWKS_KEY_ID

+--signing-aws-kms-key value #

The KMS KMS key ID, or key alias used when signing and verifying the pipeline.
Environment variable: $BUILDKITE_AGENT_SIGNING_AWS_KMS_KEY

--debug-signing #

Enable debug logging for pipeline signing. This can potentially leak secrets to the logs as it prints each step in full before signing. Requires debug logging to be enabled
Environment variable: $BUILDKITE_AGENT_DEBUG_SIGNING

--verification-failure-behavior value #

The behavior when a job is received without a signature. One of: [block warn]. Defaults to block (default: "block")
Environment variable: $BUILDKITE_AGENT_JOB_VERIFICATION_NO_SIGNATURE_BEHAVIOR

--disable-warnings-for value #

A list of warning IDs to disable
Environment variable: $BUILDKITE_AGENT_DISABLE_WARNINGS_FOR

@@ -118,6 +119,7 @@ $ buildkite-agent start --token xxx --redacted-vars value #

Pattern of environment variable names containing sensitive values (default: "*_PASSWORD", "*_SECRET", "*_TOKEN", "*_PRIVATE_KEY", "*_ACCESS_KEY", "*_SECRET_KEY", "*_CONNECTION_STRING")
Environment variable: $BUILDKITE_REDACTED_VARS

--strict-single-hooks #

Enforces that only one checkout hook, and only one command hook, can be run
Environment variable: $BUILDKITE_STRICT_SINGLE_HOOKS

--kubernetes-exec #

This is intended to be used only by the Buildkite k8s stack (github.com/buildkite/agent-stack-k8s); it enables a Unix socket for transporting logs and exit statuses between containers in a pod
Environment variable: $BUILDKITE_KUBERNETES_EXEC

+--trace-context-encoding value #

Sets the inner encoding for BUILDKITE_TRACE_CONTEXT. Must be either json or gob (default: "gob")
Environment variable: $BUILDKITE_TRACE_CONTEXT_ENCODING

--tags-from-ec2 #

Include the host's EC2 meta-data as tags (instance-id, instance-type, and ami-id)
Environment variable: $BUILDKITE_AGENT_TAGS_FROM_EC2

--tags-from-gcp #

Include the host's Google Cloud instance meta-data as tags (instance-id, machine-type, preemptible, project-id, region, and zone)
Environment variable: $BUILDKITE_AGENT_TAGS_FROM_GCP

diff --git a/pages/agent/v3/help/_tool_sign.md b/pages/agent/v3/help/_tool_sign.md index a2b74b184d..91628e37d7 100644 --- a/pages/agent/v3/help/_tool_sign.md +++ b/pages/agent/v3/help/_tool_sign.md @@ -61,6 +61,7 @@ $ cat pipeline.yml | buildkite-agent tool sign \ --no-confirm #

Show confirmation prompts before updating the pipeline with the GraphQL API.
Environment variable: $BUILDKITE_TOOL_SIGN_NO_CONFIRM

--jwks-file value #

Path to a file containing a JWKS.
Environment variable: $BUILDKITE_AGENT_JWKS_FILE

--jwks-key-id value #

The JWKS key ID to use when signing the pipeline. If none is provided and the JWKS file contains only one key, that key will be used.
Environment variable: $BUILDKITE_AGENT_JWKS_KEY_ID

+--signing-aws-kms-key value #

The AWS KMS key identifier which is used to sign pipelines.
Environment variable: $BUILDKITE_AGENT_AWS_KMS_KEY

--debug-signing #

Enable debug logging for pipeline signing. This can potentially leak secrets to the logs as it prints each step in full before signing. Requires debug logging to be enabled
Environment variable: $BUILDKITE_AGENT_DEBUG_SIGNING

--organization-slug value #

The organization slug. Required to connect to the GraphQL API.
Environment variable: $BUILDKITE_ORGANIZATION_SLUG

--pipeline-slug value #

The pipeline slug. Required to connect to the GraphQL API.
Environment variable: $BUILDKITE_PIPELINE_SLUG

diff --git a/pages/agent/v3/signed_pipelines.md b/pages/agent/v3/signed_pipelines.md index 689af656aa..013155a01f 100644 --- a/pages/agent/v3/signed_pipelines.md +++ b/pages/agent/v3/signed_pipelines.md @@ -102,6 +102,12 @@ verification-jwks-file= This ensures that whenever those agents upload steps to Buildkite, they'll generate signatures using the private key you generated earlier. It also ensures that those agents verify the signatures of any steps they run, using the public key. +```ini +verification-failure-behavior= +``` + +This setting determines the Buildkite agent's response when it receives a job without a proper signature, and also specifies how strictly the agent should enforce signature verification for incoming jobs. The agent will warn about missing or invalid signatures, but will still proceed to execute the job. If not explicitly specified, the default behavior is `block`, which prevents any job without a valid signature from running, ensuring a secure pipeline environment by default. + On instances that verify jobs, add: ```ini diff --git a/pages/apis/agent_api.md b/pages/apis/agent_api.md index 698a242a94..7595ef4f4d 100644 --- a/pages/apis/agent_api.md +++ b/pages/apis/agent_api.md @@ -1,12 +1,12 @@ # Agent REST API overview -The Agent REST API is used for agent registration, agent deregistration, starting jobs on agents, finishing jobs on agents, and agent metrics. +The agent REST API endpoint is used for agent registration, agent deregistration, starting jobs on agents, finishing jobs on agents, and agent metrics. The only publicly available endpoint is `/metrics`. The [Buildkite metrics agent](https://github.com/buildkite/buildkite-agent-metrics) uses the data returned by the metrics endpoint for agent autoscaling. -All other endpoints in the Agent API are intended only for use by the Buildkite Agent, therefore stability and backwards compatibility are not guaranteed, and changes won't be announced. +All other endpoints in the agent API are intended only for use by the Buildkite Agent, therefore stability and backwards compatibility are not guaranteed, and changes won't be announced. -The current version of the Agent API is v3. +The current version of the agent API is v3. ## Schema @@ -24,9 +24,9 @@ curl https://agent.buildkite.com ## Authentication -Unlike the [Buildkite REST API](/docs/apis/rest-api), which uses an [API access token](/docs/apis/rest-api#authentication), the Agent REST API uses an [Agent registration token](/docs/agent/v3/tokens) for authentication. +Unlike the [Buildkite REST API](/docs/apis/rest-api), which uses an [API access token](/docs/apis/rest-api#authentication), the agent REST API uses an [agent token](/docs/agent/v3/tokens) for authentication. -To authenticate using an Agent registration token, set the `Authorization` HTTP header to the word `Token`, followed by a space, followed by the access token. For example: +To authenticate using an agent token, set the `Authorization` HTTP header to the word `Token`, followed by a space, followed by the agent token. For example: ```bash curl -H "Authorization: Token $TOKEN" https://agent.buildkite.com/v3/metrics diff --git a/pages/apis/agent_api/metrics.md b/pages/apis/agent_api/metrics.md index 4135bb484a..27a964f641 100644 --- a/pages/apis/agent_api/metrics.md +++ b/pages/apis/agent_api/metrics.md @@ -4,7 +4,7 @@ toc: false # Metrics API -The Metrics API endpoint provides information on idle and busy agents, jobs, and queues for the [Agent registration token](/docs/agent/v3/tokens) supplied in the request `Authorization` header. +The metrics API endpoint provides information on idle and busy agents, jobs, and queues for the [Agent registration token](/docs/agent/v3/tokens) supplied in the request `Authorization` header. ## Get metrics diff --git a/pages/apis/rest_api/access_token.md b/pages/apis/rest_api/access_token.md index e528b98c3a..8c8ed89b62 100644 --- a/pages/apis/rest_api/access_token.md +++ b/pages/apis/rest_api/access_token.md @@ -1,8 +1,8 @@ # Access token API -The Access token API allows you to inspect and revoke an API access token. This can be useful if you find a token, can't identify its owner, and you want to revoke it. +The access token API endpoint allows you to inspect and revoke an API access token. This can be useful if you find a token, can't identify its owner, and you want to revoke it. ->📘 +> 📘 > All the endpoints expect the token to be provided using the Authorization HTTP header. diff --git a/pages/apis/rest_api/agents.md b/pages/apis/rest_api/agents.md index d371ce8786..e1508d9dba 100644 --- a/pages/apis/rest_api/agents.md +++ b/pages/apis/rest_api/agents.md @@ -1,6 +1,5 @@ # Agents API - ## List agents Returns a [paginated list](<%= paginated_resource_docs_url %>) of an organization's agents. The list only includes connected agents - agents in a disconnected state are not returned. diff --git a/pages/apis/rest_api/analytics/flaky_tests.md b/pages/apis/rest_api/analytics/flaky_tests.md index 99154ced6b..f5de36c0b7 100644 --- a/pages/apis/rest_api/analytics/flaky_tests.md +++ b/pages/apis/rest_api/analytics/flaky_tests.md @@ -1,6 +1,6 @@ # Flaky tests API -The Flaky test API endpoint provides information about tests detected as flaky in a test suite. +The flaky test API endpoint provides information about tests detected as flaky in a test suite. ## List all flaky tests diff --git a/pages/apis/rest_api/clusters.md b/pages/apis/rest_api/clusters.md index 33bb0f3905..27cffb89f0 100644 --- a/pages/apis/rest_api/clusters.md +++ b/pages/apis/rest_api/clusters.md @@ -1,6 +1,6 @@ # Clusters API -The clusters API lets you create and manage clusters in your organization. +The clusters API endpoint lets you create and manage clusters in your organization. ## Clusters diff --git a/pages/apis/rest_api/meta.md b/pages/apis/rest_api/meta.md index 0db9a8ff15..492f72bfdc 100644 --- a/pages/apis/rest_api/meta.md +++ b/pages/apis/rest_api/meta.md @@ -1,6 +1,6 @@ # Meta API -The Meta API provides information about Buildkite, including a list of Buildkite's IP addresses. +The meta API endpoint provides information about Buildkite, including a list of Buildkite's IP addresses. It does not require authentication. diff --git a/pages/apis/rest_api/organizations.md b/pages/apis/rest_api/organizations.md index e71dd7ef93..a74b16abfb 100644 --- a/pages/apis/rest_api/organizations.md +++ b/pages/apis/rest_api/organizations.md @@ -1,6 +1,6 @@ # Organizations API -The organizations API: +The organizations API endpoint: - allows you to list organizations and retrieve information about an organization diff --git a/pages/apis/rest_api/organizations/members.md b/pages/apis/rest_api/organizations/members.md index 9e5dfae107..f05b73f6d3 100644 --- a/pages/apis/rest_api/organizations/members.md +++ b/pages/apis/rest_api/organizations/members.md @@ -1,6 +1,6 @@ # Organization members API -The organization members API allows users to view all members of an organization. +The organization members API endpoint allows users to view all members of an organization. ## Organization member data model diff --git a/pages/apis/rest_api/packages/registries.md b/pages/apis/rest_api/packages/registries.md new file mode 100644 index 0000000000..9ddf27e487 --- /dev/null +++ b/pages/apis/rest_api/packages/registries.md @@ -0,0 +1,158 @@ +# Registries API + +The registries API endpoint lets you [create and manage registries](/docs/packages/manage-registries) in your organization. + +## Create a registry + +```bash +curl -H "Authorization: Bearer $TOKEN" \ + -X POST "https://api.buildkite.com/v2/packages/organizations/#{org.slug}/registries" \ + -H "Content-Type: application/json" \ + -d '{ + "name": "my registry", + "ecosystem": "ruby", + "description": "registry containing ruby gems" + }' +``` + +```json +{ + "id": "0191df84-85e4-77aa-83ba-6579084728eb", + "graphql_id": "UmVnaXN0cnktLS0wMTkxZGY4NC04NWU0LTc3YWEtODNiYS02NTc5MDg0NzI4ZWI=", + "slug": "my-registry", + "url": "https://api.buildkite.com/v2/packages/organizations/my-org/registries/my-registry", + "web_url": "https://buildkite.com/organizations/my-org/registries/my-registry", + "name": "my registry", + "ecosystem": "ruby", + "description": "registry containing ruby gems", + "emoji": null, + "color": null, + "public": false, + "oidc_policy": null +} +``` + +Required [request body properties](/docs/api#request-body-properties): + + + + + + +
nameName of the new registry.
Example: "my registry".
ecosystemRegistry ecosystem based on the package ecosystem for the new registry.
Example: "ruby".
+ +Optional [request body properties](/docs/api#request-body-properties): + + + + + +
descriptionDescription of the registry.
Default value: null.
+ +Required scope: `write_registries` + +Success response: `200 OK` + +## List all registries + +Returns a list of an organization's registries. + +```bash +curl -H "Authorization: Bearer $TOKEN" \ + -X GET "https://api.buildkite.com/v2/packages/organizations/#{org.slug}/registries" +``` + +```json +[ + { + "id": "0191df84-85e4-77aa-83ba-6579084728eb", + "graphql_id": "UmVnaXN0cnktLS0wMTkxZGY4NC04NWU0LTc3YWEtODNiYS02NTc5MDg0NzI4ZWI=", + "slug": "my-registry", + "url": "https://api.buildkite.com/v2/packages/organizations/my-org/registries/my-registry", + "web_url": "https://buildkite.com/organizations/my-org/packages/registries/my-registry", + "name": "my registry", + "ecosystem": "ruby", + "description": null, + "emoji": null, + "color": null, + "public": false, + "oidc_policy": null + } +] +``` + +Required scope: `read_registries` + +Success response: `200 OK` + +## Get a registry + +Returns the details for a single registry, looked up by its slug. + +```bash +curl -H "Authorization: Bearer $TOKEN" \ + -X GET "https://api.buildkite.com/v2/packages/organizations/#{org.slug}/registries/#{registry.slug}" +``` + +```json +{ + "id": "0191df84-85e4-77aa-83ba-6579084728eb", + "graphql_id": "UmVnaXN0cnktLS0wMTkxZGY4NC04NWU0LTc3YWEtODNiYS02NTc5MDg0NzI4ZWI=", + "slug": "my-registry", + "url": "https://api.buildkite.com/v2/packages/organizations/my-org/registries/my-registry", + "web_url": "https://buildkite.com/organizations/my-org/registries/my-registry", + "name": "my registry", + "ecosystem": "ruby", + "description": "registry containing ruby gems", + "emoji": null, + "color": null, + "public": false, + "oidc_policy": null +} +``` + +Required scope: `read_registries` + +Success response: `200 OK` + +## Update a registry + +```bash +curl -H "Authorization: Bearer $TOKEN" \ + -X POST "https://api.buildkite.com/v2/packages/organizations/#{org.slug}/registries/#{registry.slug}" \ + -H "Content-Type: application/json" \ + -d '{ + "name": "my registry", + "description": "registry containing ruby gems" + }' +``` + +```json +{ + "id": "0191df84-85e4-77aa-83ba-6579084728eb", + "graphql_id": "UmVnaXN0cnktLS0wMTkxZGY4NC04NWU0LTc3YWEtODNiYS02NTc5MDg0NzI4ZWI=", + "slug": "my-registry", + "url": "https://api.buildkite.com/v2/packages/organizations/my-org/registries/my-registry", + "web_url": "https://buildkite.com/organizations/my-org/registries/my-registry", + "name": "my registry", + "ecosystem": "ruby", + "description": "registry containing ruby gems", + "emoji": null, + "color": null, + "public": false, + "oidc_policy": null +} +``` + +Optional [request body properties](/docs/api#request-body-properties): + + + + + + +
nameName of the registry.
Example: my registry.
descriptionDescription of the registry.
Example: registry containing ruby gems.
+ +Required scope: `write_registries` + +Success response: `200 OK` diff --git a/pages/apis/rest_api/pipeline_templates.md b/pages/apis/rest_api/pipeline_templates.md index 052b055367..abf2cf1b19 100644 --- a/pages/apis/rest_api/pipeline_templates.md +++ b/pages/apis/rest_api/pipeline_templates.md @@ -3,7 +3,7 @@ > 📘 Enterprise feature > [Pipeline templates](https://buildkite.com/docs/pipelines/templates) are only available on an [Enterprise](https://buildkite.com/pricing) plan. -The pipeline templates API allows admins to create and manage pipeline templates for an organization. +The pipeline templates API endpoint allows admins to create and manage pipeline templates for an organization. Non-admins can only read or assign pipeline templates marked as `available` by organization admins. ## Pipeline template data model diff --git a/pages/apis/rest_api/pipelines.md b/pages/apis/rest_api/pipelines.md index 1a0c04024c..5bfa3f2303 100644 --- a/pages/apis/rest_api/pipelines.md +++ b/pages/apis/rest_api/pipelines.md @@ -1,6 +1,6 @@ # Pipelines API -The pipelines API consists of several endpoints that allow you to manage: +The pipelines API endpoint consists of several endpoints that allow you to manage: - pipelines, along with their [builds](/docs/apis/rest-api/builds) - a build's [annotations](/docs/apis/rest-api/annotations), [artifacts](/docs/apis/rest-api/artifacts), and [jobs](/docs/apis/rest-api/jobs) diff --git a/pages/apis/rest_api/rules.md b/pages/apis/rest_api/rules.md index c2eed2e7c3..1395469ff0 100644 --- a/pages/apis/rest_api/rules.md +++ b/pages/apis/rest_api/rules.md @@ -1,6 +1,6 @@ # Rules API -The rules API lets you create and manage rules in your organization. +The rules API endpoint lets you create and manage rules in your organization. ## Rules diff --git a/pages/apis/rest_api/teams.md b/pages/apis/rest_api/teams.md index 647501f212..ee2e5c961d 100644 --- a/pages/apis/rest_api/teams.md +++ b/pages/apis/rest_api/teams.md @@ -1,6 +1,6 @@ # Teams API -The teams API allows you to view and manage teams within an organization. +The teams API endpoint allows you to view and manage teams within an organization. ## Team data model diff --git a/pages/apis/rest_api/teams/members.md b/pages/apis/rest_api/teams/members.md index 13cd1cda02..c1cc514c9f 100644 --- a/pages/apis/rest_api/teams/members.md +++ b/pages/apis/rest_api/teams/members.md @@ -1,6 +1,6 @@ # Team members API -The team members API allows users to review, create, update, and delete members associated with a team in your organization. +The team members API endpoint allows users to review, create, update, and delete members associated with a team in your organization. ## Team member data model diff --git a/pages/apis/rest_api/teams/pipelines.md b/pages/apis/rest_api/teams/pipelines.md index 34634081c9..956cce4495 100644 --- a/pages/apis/rest_api/teams/pipelines.md +++ b/pages/apis/rest_api/teams/pipelines.md @@ -1,6 +1,6 @@ # Team pipelines API -The team pipelines API allows users to review, create, update, and delete pipelines associated with a team in your organization. +The team pipelines API endpoint allows users to review, create, update, and delete pipelines associated with a team in your organization. ## Team pipeline data model diff --git a/pages/apis/rest_api/teams/suites.md b/pages/apis/rest_api/teams/suites.md index 786d825ef4..f0e447cc23 100644 --- a/pages/apis/rest_api/teams/suites.md +++ b/pages/apis/rest_api/teams/suites.md @@ -1,6 +1,6 @@ # Team suites API -The team suites API allows users to review, create, update, and delete test suites associated with a team in your organization. +The team suites API endpoint allows users to review, create, update, and delete test suites associated with a team in your organization. ## Team suite data model diff --git a/pages/apis/rest_api/user.md b/pages/apis/rest_api/user.md index 9a34111aee..6c303e859c 100644 --- a/pages/apis/rest_api/user.md +++ b/pages/apis/rest_api/user.md @@ -1,6 +1,6 @@ # User API -The User API endpoint allows you to inspect details about the user account that owns the API token that is currently being used. +The user API endpoint allows you to inspect details about the user account that owns the API token that is currently being used. ## Get the current user