Skip to content

Commit

Permalink
feat: Updated OpenAPI spec
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] authored and HavenDV committed Aug 2, 2024
1 parent f971a32 commit 817582a
Show file tree
Hide file tree
Showing 11 changed files with 69 additions and 35 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ partial void ProcessActivityListEventsForAuthenticatedUserResponseContent(

/// <summary>
/// List events for the authenticated user<br/>
/// If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
/// If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.<br/>
/// &gt; [!NOTE]<br/>
/// &gt; This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
/// </summary>
/// <param name="username"></param>
/// <param name="perPage">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,9 @@ partial void ProcessActivityListOrgEventsForAuthenticatedUserResponseContent(

/// <summary>
/// List organization events for the authenticated user<br/>
/// This is the user's organization dashboard. You must be authenticated as the user to view this.
/// This is the user's organization dashboard. You must be authenticated as the user to view this.<br/>
/// &gt; [!NOTE]<br/>
/// &gt; This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
/// </summary>
/// <param name="username"></param>
/// <param name="org"></param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ partial void ProcessActivityListPublicEventsResponseContent(

/// <summary>
/// List public events<br/>
/// We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.
/// &gt; [!NOTE]<br/>
/// &gt; This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
/// </summary>
/// <param name="perPage">
/// Default Value: 30
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ partial void ProcessActivityListPublicEventsForRepoNetworkResponseContent(
ref string content);

/// <summary>
/// List public events for a network of repositories
/// List public events for a network of repositories<br/>
/// &gt; [!NOTE]<br/>
/// &gt; This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
/// </summary>
/// <param name="owner"></param>
/// <param name="repo"></param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ partial void ProcessActivityListPublicEventsForUserResponseContent(
ref string content);

/// <summary>
/// List public events for a user
/// List public events for a user<br/>
/// &gt; [!NOTE]<br/>
/// &gt; This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
/// </summary>
/// <param name="username"></param>
/// <param name="perPage">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ partial void ProcessActivityListPublicOrgEventsResponseContent(
ref string content);

/// <summary>
/// List public organization events
/// List public organization events<br/>
/// &gt; [!NOTE]<br/>
/// &gt; This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
/// </summary>
/// <param name="org"></param>
/// <param name="perPage">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@ partial void ProcessActivityListReceivedEventsForUserResponseContent(

/// <summary>
/// List events received by the authenticated user<br/>
/// These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.
/// These are events that you've received by watching repositories and following users. If you are authenticated as the<br/>
/// given user, you will see private events. Otherwise, you'll only see public events.<br/>
/// &gt; [!NOTE]<br/>
/// &gt; This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
/// </summary>
/// <param name="username"></param>
/// <param name="perPage">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ partial void ProcessActivityListReceivedPublicEventsForUserResponseContent(
ref string content);

/// <summary>
/// List public events received by a user
/// List public events received by a user<br/>
/// &gt; [!NOTE]<br/>
/// &gt; This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
/// </summary>
/// <param name="username"></param>
/// <param name="perPage">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,6 @@ public sealed partial class CodeScanningAlertRuleSummary
[global::System.Text.Json.Serialization.JsonPropertyName("name")]
public string? Name { get; set; }

/// <summary>
/// A set of tags applicable for the rule.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("tags")]
public global::System.Collections.Generic.IList<string?>? Tags { get; set; }

/// <summary>
/// The severity of the alert.
/// </summary>
Expand All @@ -46,6 +40,12 @@ public sealed partial class CodeScanningAlertRuleSummary
[global::System.Text.Json.Serialization.JsonPropertyName("description")]
public string? Description { get; set; }

/// <summary>
/// A set of tags applicable for the rule.
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("tags")]
public global::System.Collections.Generic.IList<string?>? Tags { get; set; }

/// <summary>
/// Additional properties that are not explicitly defined in the schema
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ public sealed partial class PullRequestReview
/// </summary>
[global::System.Text.Json.Serialization.JsonPropertyName("id")]
[global::System.Text.Json.Serialization.JsonRequired]
public required int Id { get; set; }
public required long Id { get; set; }

/// <summary>
/// Example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
Expand Down
58 changes: 38 additions & 20 deletions src/libs/GitHub/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1671,9 +1671,9 @@ paths:
"/events":
get:
summary: List public events
description: We delay the public events feed by five minutes, which means the
most recent event returned by the public events API actually occurred at least
five minutes ago.
description: |-
> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-public-events
Expand Down Expand Up @@ -3352,7 +3352,9 @@ paths:
"/networks/{owner}/{repo}/events":
get:
summary: List public events for a network of repositories
description: ''
description: |-
> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-public-events-for-repo-network
Expand Down Expand Up @@ -8403,7 +8405,9 @@ paths:
"/orgs/{org}/events":
get:
summary: List public organization events
description: ''
description: |-
> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-public-org-events
Expand Down Expand Up @@ -45878,8 +45882,11 @@ paths:
"/users/{username}/events":
get:
summary: List events for the authenticated user
description: If you are authenticated as the given user, you will see your private
events. Otherwise, you'll only see public events.
description: |-
If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-events-for-authenticated-user
Expand Down Expand Up @@ -45910,8 +45917,11 @@ paths:
"/users/{username}/events/orgs/{org}":
get:
summary: List organization events for the authenticated user
description: This is the user's organization dashboard. You must be authenticated
as the user to view this.
description: |-
This is the user's organization dashboard. You must be authenticated as the user to view this.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-org-events-for-authenticated-user
Expand Down Expand Up @@ -45943,7 +45953,9 @@ paths:
"/users/{username}/events/public":
get:
summary: List public events for a user
description: ''
description: |-
> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-public-events-for-user
Expand Down Expand Up @@ -46655,9 +46667,12 @@ paths:
"/users/{username}/received_events":
get:
summary: List events received by the authenticated user
description: These are events that you've received by watching repositories
and following users. If you are authenticated as the given user, you will
see private events. Otherwise, you'll only see public events.
description: |-
These are events that you've received by watching repositories and following users. If you are authenticated as the
given user, you will see private events. Otherwise, you'll only see public events.

> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-received-events-for-user
Expand Down Expand Up @@ -46688,7 +46703,9 @@ paths:
"/users/{username}/received_events/public":
get:
summary: List public events received by a user
description: ''
description: |-
> [!NOTE]
> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
tags:
- activity
operationId: activity/list-received-public-events-for-user
Expand Down Expand Up @@ -70154,12 +70171,6 @@ components:
name:
type: string
description: The name of the rule used to detect the alert.
tags:
nullable: true
type: array
description: A set of tags applicable for the rule.
items:
type: string
severity:
nullable: true
type: string
Expand All @@ -70181,6 +70192,12 @@ components:
description:
type: string
description: A short description of the rule used to detect the alert.
tags:
nullable: true
type: array
description: A set of tags applicable for the rule.
items:
type: string
code-scanning-analysis-tool-version:
nullable: true
type: string
Expand Down Expand Up @@ -85661,6 +85678,7 @@ components:
description: Unique identifier of the review
example: 42
type: integer
format: int64
node_id:
type: string
example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
Expand Down

0 comments on commit 817582a

Please sign in to comment.