diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-08-14 03:10:05 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-08-14 03:10:05 +0300 |
commit | d2608eb839100e794930c246ee357c62d0482714 (patch) | |
tree | a04c214e54132062650f625e3374a6e3c102d44c /doc/api | |
parent | 79ecd9a7489305e8357ca1df74ac7d7cc775b0d3 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/audit_events.md | 12 | ||||
-rw-r--r-- | doc/api/group_milestones.md | 8 | ||||
-rw-r--r-- | doc/api/projects.md | 4 |
3 files changed, 12 insertions, 12 deletions
diff --git a/doc/api/audit_events.md b/doc/api/audit_events.md index 8fbee89f9be..3ffcae04791 100644 --- a/doc/api/audit_events.md +++ b/doc/api/audit_events.md @@ -23,8 +23,8 @@ GET /audit_events | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `created_after` | string | no | Return audit events created on or after the given time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ | -| `created_before` | string | no | Return audit events created on or before the given time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ | +| `created_after` | string | no | Return audit events created on or after the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | +| `created_before` | string | no | Return audit events created on or before the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | | `entity_type` | string | no | Return audit events for the given entity type. Valid values are: `User`, `Group`, or `Project`. | | `entity_id` | integer | no | Return audit events for the given entity ID. Requires `entity_type` attribute to be present. | @@ -148,8 +148,8 @@ GET /groups/:id/audit_events | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) | -| `created_after` | string | no | Return group audit events created on or after the given time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ | -| `created_before` | string | no | Return group audit events created on or before the given time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ | +| `created_after` | string | no | Return group audit events created on or after the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ)` | +| `created_before` | string | no | Return group audit events created on or before the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | By default, `GET` requests return 20 results at a time because the API results are paginated. @@ -255,8 +255,8 @@ GET /projects/:id/audit_events | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) | -| `created_after` | string | no | Return project audit events created on or after the given time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ | -| `created_before` | string | no | Return project audit events created on or before the given time. Format: ISO 8601 YYYY-MM-DDTHH:MM:SSZ | +| `created_after` | string | no | Return project audit events created on or after the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | +| `created_before` | string | no | Return project audit events created on or before the given time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | By default, `GET` requests return 20 results at a time because the API results are paginated. diff --git a/doc/api/group_milestones.md b/doc/api/group_milestones.md index a21af94da40..d7de3272005 100644 --- a/doc/api/group_milestones.md +++ b/doc/api/group_milestones.md @@ -89,8 +89,8 @@ Parameters: | `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) owned by the authenticated user | | `title` | string | yes | The title of a milestone | | `description` | string | no | The description of the milestone | -| `due_date` | date | no | The due date of the milestone, in YYYY-MM-DD format (ISO 8601) | -| `start_date` | date | no | The start date of the milestone, in YYYY-MM-DD format (ISO 8601) | +| `due_date` | date | no | The due date of the milestone, in ISO 8601 format (`YYYY-MM-DD`) | +| `start_date` | date | no | The start date of the milestone, in ISO 8601 format (`YYYY-MM-DD`) | ## Edit milestone @@ -108,8 +108,8 @@ Parameters: | `milestone_id` | integer | yes | The ID of a group milestone | | `title` | string | no | The title of a milestone | | `description` | string | no | The description of a milestone | -| `due_date` | date | no | The due date of the milestone, in YYYY-MM-DD format (ISO 8601) | -| `start_date` | date | no | The start date of the milestone, in YYYY-MM-DD format (ISO 8601) | +| `due_date` | date | no | The due date of the milestone, in ISO 8601 format (`YYYY-MM-DD`) | +| `start_date` | date | no | The start date of the milestone, in ISO 8601 format (`YYYY-MM-DD`) | | `state_event` | string | no | The state event of the milestone _(`close` or `activate`)_ | ## Delete group milestone diff --git a/doc/api/projects.md b/doc/api/projects.md index ea20a310daa..a510f05df58 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -49,8 +49,8 @@ GET /projects | `archived` | boolean | **{dotted-circle}** No | Limit by archived status. | | `id_after` | integer | **{dotted-circle}** No | Limit results to projects with IDs greater than the specified ID. | | `id_before` | integer | **{dotted-circle}** No | Limit results to projects with IDs less than the specified ID. | -| `last_activity_after` | datetime | **{dotted-circle}** No | Limit results to projects with last_activity after specified time. Format: ISO 8601 `YYYY-MM-DDTHH:MM:SSZ` | -| `last_activity_before` | datetime | **{dotted-circle}** No | Limit results to projects with last_activity before specified time. Format: ISO 8601 `YYYY-MM-DDTHH:MM:SSZ` | +| `last_activity_after` | datetime | **{dotted-circle}** No | Limit results to projects with last_activity after specified time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | +| `last_activity_before` | datetime | **{dotted-circle}** No | Limit results to projects with last_activity before specified time. Format: ISO 8601 (`YYYY-MM-DDTHH:MM:SSZ`) | | `membership` | boolean | **{dotted-circle}** No | Limit by projects that the current user is a member of. | | `min_access_level` | integer | **{dotted-circle}** No | Limit by current user minimal [access level](members.md#valid-access-levels). | | `order_by` | string | **{dotted-circle}** No | Return projects ordered by `id`, `name`, `path`, `created_at`, `updated_at`, `last_activity_at`, or `similarity` fields. `repository_size`, `storage_size`, `packages_size` or `wiki_size` fields are only allowed for admins. `similarity` ([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/332890) in GitLab 14.1) is only available when searching and is limited to projects that the current user is a member of. Default is `created_at`. | |