From 76c4bcb7abcc5ec648e12ba934dad7fb892c208e Mon Sep 17 00:00:00 2001 From: HavenDV Date: Tue, 21 May 2024 07:33:57 +0400 Subject: [PATCH] fix: Fixed .json/url generation. --- src/libs/Directory.Build.props | 2 +- .../Generation/Sources.Methods.cs | 16 +- .../Generators/ModelGeneratorMethods.cs | 6 +- .../Models/PropertyData.cs | 6 +- .../Generators/ClientGenerator.cs | 55 - .../Generators/ModelGenerator.cs | 78 - src/libs/OpenApiGenerator/SdkGenerator.cs | 95 + .../OpenApiGenerator.SnapshotTests/Tests.cs | 49 +- .../Snapshots/Clients/GitHub/_.verified.txt | 3466 +++++++++++++++++ .../Snapshots/Clients/Ollama/_.verified.txt | 33 + .../Snapshots/Clients/OpenAi/_.verified.txt | 265 ++ .../Clients/Replicate/_.verified.txt | 66 + .../Snapshots/LangSmith/_.verified.txt | 129 + .../Snapshots/Ollama/_.verified.txt | 125 + .../Snapshots/OpenAi/_.verified.txt | 1241 ++++++ .../Snapshots/Replicate/_.verified.txt | 13 + 16 files changed, 5473 insertions(+), 172 deletions(-) delete mode 100644 src/libs/OpenApiGenerator/Generators/ClientGenerator.cs delete mode 100644 src/libs/OpenApiGenerator/Generators/ModelGenerator.cs create mode 100644 src/libs/OpenApiGenerator/SdkGenerator.cs diff --git a/src/libs/Directory.Build.props b/src/libs/Directory.Build.props index d91212cc8f..5545dfa381 100644 --- a/src/libs/Directory.Build.props +++ b/src/libs/Directory.Build.props @@ -39,7 +39,7 @@ - 0.6.6 + 0.6.7 0.1 v dev diff --git a/src/libs/OpenApiGenerator.Core/Generation/Sources.Methods.cs b/src/libs/OpenApiGenerator.Core/Generation/Sources.Methods.cs index 63071b657a..6dbd35e300 100644 --- a/src/libs/OpenApiGenerator.Core/Generation/Sources.Methods.cs +++ b/src/libs/OpenApiGenerator.Core/Generation/Sources.Methods.cs @@ -91,14 +91,14 @@ public static string GenerateMethod( /// {endPoint.Summary} /// {endPoint.Properties.Where(x => x.ParameterLocation != null).Select(x => $@" - /// ").Inject()} + /// ").Inject()} {(string.IsNullOrWhiteSpace(endPoint.RequestType) ? " " : @" /// ")} /// The token to cancel the operation with /// public async {taskType} {endPoint.MethodName}( {endPoint.Properties.Where(x => x.ParameterLocation != null).Select(x => $@" - {x.Type.CSharpType} {x.Name.ToParameterName()},").Inject()} + {x.Type.CSharpType} {x.ParameterName},").Inject()} {(string.IsNullOrWhiteSpace(endPoint.RequestType) ? " " : @$" {endPoint.RequestType} request,")} {cancellationTokenAttribute}global::System.Threading.CancellationToken cancellationToken = default) @@ -109,7 +109,7 @@ public static string GenerateMethod( {(endPoint.JsonSerializerType == JsonSerializerType.NewtonsoftJson ? endPoint.Properties .Where(x => x is { ParameterLocation: not null, Type.EnumValues.Length: > 0 }) .Select(x => $@" - var {x.ArgumentName} = {x.Name.ToParameterName()} switch + var {x.ArgumentName} = {x.ParameterName} switch {{ {x.Type.Properties.Zip(x.Type.EnumValues, (property, value) => (Property: property, Value: value)) .Select(y => $@" @@ -184,25 +184,25 @@ public static string GenerateExtensionMethod( /// {endPoint.Summary} /// {endPoint.Properties.Select(x => $@" - /// ").Inject()} + /// ").Inject()} /// The token to cancel the operation with /// public async {taskType} {endPoint.MethodName}( {endPoint.Properties.Where(static x => x.IsRequired).Select(x => $@" - {x.Type.CSharpType} {x.Name.ToParameterName()},").Inject()} + {x.Type.CSharpType} {x.ParameterName},").Inject()} {endPoint.Properties.Where(static x => !x.IsRequired).Select(x => $@" - {x.Type.CSharpType} {x.Name.ToParameterName()} = default,").Inject()} + {x.Type.CSharpType} {x.ParameterName} = default,").Inject()} {cancellationTokenAttribute}global::System.Threading.CancellationToken cancellationToken = default) {{ var request = new {endPoint.RequestType} {{ {endPoint.Properties.Where(x => x.ParameterLocation == null).Select(x => $@" - {x.Name} = {x.Name.ToParameterName()},").Inject()} + {x.Name} = {x.ParameterName},").Inject()} }}; {response}{endPoint.MethodName}( {endPoint.Properties.Where(x => x.ParameterLocation != null).Select(x => $@" - {x.Name.ToParameterName()}: {x.Name.ToParameterName()},").Inject()} + {x.ParameterName}: {x.ParameterName},").Inject()} request: request, cancellationToken: cancellationToken){configureAwaitResponse}; {(endPoint.Stream ? @" diff --git a/src/libs/OpenApiGenerator.Core/Generators/ModelGeneratorMethods.cs b/src/libs/OpenApiGenerator.Core/Generators/ModelGeneratorMethods.cs index 53e65ee89b..d093e0c77d 100644 --- a/src/libs/OpenApiGenerator.Core/Generators/ModelGeneratorMethods.cs +++ b/src/libs/OpenApiGenerator.Core/Generators/ModelGeneratorMethods.cs @@ -10,7 +10,7 @@ public static class ModelGeneratorMethods { #region Methods - public static ImmutableArray PrepareData( + public static EquatableArray PrepareData( (string text, Settings settings) tuple, CancellationToken cancellationToken = default) { @@ -75,11 +75,11 @@ public static ImmutableArray PrepareData( }) .ToImmutableArray(); - return [ + return ImmutableArray.Create([ ..components, ..objectParameters, ..enumParameters - ]; + ]); } public static FileWithName GetSourceCode( diff --git a/src/libs/OpenApiGenerator.Core/Models/PropertyData.cs b/src/libs/OpenApiGenerator.Core/Models/PropertyData.cs index 76badf6b28..f7e84fecb1 100644 --- a/src/libs/OpenApiGenerator.Core/Models/PropertyData.cs +++ b/src/libs/OpenApiGenerator.Core/Models/PropertyData.cs @@ -69,16 +69,18 @@ public static PropertyData FromSchema( Summary: schema.Value.GetSummary()); } + public string ParameterName => Name.Replace(".", string.Empty).ToParameterName(); + public string ArgumentName { get { if (Type.EnumValues.Length != 0 && JsonSerializerType == JsonSerializerType.NewtonsoftJson) { - return Name.ToParameterName() + "Value"; + return ParameterName + "Value"; } - return Name.ToParameterName(); + return ParameterName; } } } \ No newline at end of file diff --git a/src/libs/OpenApiGenerator/Generators/ClientGenerator.cs b/src/libs/OpenApiGenerator/Generators/ClientGenerator.cs deleted file mode 100644 index 2a1bbc33ea..0000000000 --- a/src/libs/OpenApiGenerator/Generators/ClientGenerator.cs +++ /dev/null @@ -1,55 +0,0 @@ -using H.Generators.Extensions; -using Microsoft.CodeAnalysis; -using OpenApiGenerator.Core.Generators; -using OpenApiGenerator.Core.Models; -using FileWithName = H.Generators.Extensions.FileWithName; - -namespace OpenApiGenerator.Generators; - -[Generator] -public class ClientGenerator : IIncrementalGenerator -{ - #region Constants - - private const string Id = "OACG"; - - #endregion - - #region Methods - - public void Initialize(IncrementalGeneratorInitializationContext context) - { - var settings = context.DetectSettings(); - - context.AdditionalTextsProvider - .Where(static text => text.Path.EndsWith(".yaml", StringComparison.InvariantCultureIgnoreCase)) - .Combine(settings) - .SelectAndReportExceptions(PrepareData, context, Id) - .SelectMany(static (x, _) => x) - .SelectAndReportExceptions(GetSourceCode, context, Id) - .AddSource(context); - } - - private static Core.Models.EquatableArray PrepareData( - (AdditionalText text, Settings settings) tuple, - CancellationToken cancellationToken = default) - { - var (text, settings) = tuple; - var yaml = text.GetText(cancellationToken)?.ToString() ?? string.Empty; - - return ClientGeneratorMethods.PrepareData((yaml, settings), cancellationToken); - } - - private static FileWithName GetSourceCode( - EndPoint endPoint, - CancellationToken cancellationToken = default) - { - var fileWithName = ClientGeneratorMethods.GetSourceCode(endPoint, cancellationToken); - - return new FileWithName( - Name: fileWithName.Name, - Text: fileWithName.Text); - } - - #endregion -} diff --git a/src/libs/OpenApiGenerator/Generators/ModelGenerator.cs b/src/libs/OpenApiGenerator/Generators/ModelGenerator.cs deleted file mode 100644 index 401c077ce4..0000000000 --- a/src/libs/OpenApiGenerator/Generators/ModelGenerator.cs +++ /dev/null @@ -1,78 +0,0 @@ -using H.Generators.Extensions; -using Microsoft.CodeAnalysis; -using OpenApiGenerator.Core.Generators; -using OpenApiGenerator.Core.Json; -using OpenApiGenerator.Core.Models; -using FileWithName = H.Generators.Extensions.FileWithName; - -namespace OpenApiGenerator.Generators; - -[Generator] -public class ModelGenerator : IIncrementalGenerator -{ - #region Constants - - private const string Id = "OAMG"; - - #endregion - - #region Methods - - public void Initialize(IncrementalGeneratorInitializationContext context) - { - var settings = context.DetectSettings(); - - var models = context.AdditionalTextsProvider - .Where(static text => text.Path.EndsWith(".yaml", StringComparison.InvariantCultureIgnoreCase)) - .Combine(settings) - .SelectAndReportExceptions(PrepareData, context, Id); - - models - .SelectMany(static (x, _) => x) - .SelectAndReportExceptions(GetSourceCode, context, Id) - .AddSource(context); - models - .Select(static (x, _) => x) - .SelectAndReportExceptions(GetSourceCodeForSuperType, context, Id) - .AddSource(context); - } - - private static Core.Models.EquatableArray PrepareData( - (AdditionalText text, Settings settings) tuple, - CancellationToken cancellationToken = default) - { - var (text, settings) = tuple; - var yaml = text.GetText(cancellationToken)?.ToString() ?? string.Empty; - - return ModelGeneratorMethods.PrepareData((yaml, settings), cancellationToken); - } - - private static FileWithName GetSourceCode( - ModelData model, - CancellationToken cancellationToken = default) - { - var fileWithName = ModelGeneratorMethods.GetSourceCode(model, cancellationToken); - - return new FileWithName( - Name: fileWithName.Name, - Text: fileWithName.Text); - } - - private static FileWithName GetSourceCodeForSuperType( - Core.Models.EquatableArray models, - CancellationToken cancellationToken = default) - { - if (models.IsEmpty) - { - return FileWithName.Empty; - } - - var fileWithName = ModelGeneratorMethods.GetSourceCodeForSuperClass(models, cancellationToken); - - return new FileWithName( - Name: fileWithName.Name, - Text: fileWithName.Text); - } - - #endregion -} diff --git a/src/libs/OpenApiGenerator/SdkGenerator.cs b/src/libs/OpenApiGenerator/SdkGenerator.cs new file mode 100644 index 0000000000..f053233f52 --- /dev/null +++ b/src/libs/OpenApiGenerator/SdkGenerator.cs @@ -0,0 +1,95 @@ +using H.Generators.Extensions; +using Microsoft.CodeAnalysis; +using OpenApiGenerator.Core.Generators; +using OpenApiGenerator.Core.Models; +using FileWithName = H.Generators.Extensions.FileWithName; + +namespace OpenApiGenerator; + +[Generator] +public class SdkGenerator : IIncrementalGenerator +{ + #region Constants + + private const string Id = "OAG"; + + #endregion + + #region Methods + + public void Initialize(IncrementalGeneratorInitializationContext context) + { + var settings = context.DetectSettings(); + + var filesAndSettings = context.AdditionalTextsProvider + .Where(static text => text.Path.EndsWith(".yaml", StringComparison.InvariantCultureIgnoreCase) || + text.Path.EndsWith(".json", StringComparison.InvariantCultureIgnoreCase)) + .Select(static (text, cancellationToken) => GetContent(text, cancellationToken)) + .Combine(settings); + + filesAndSettings + .SelectAndReportExceptions(ClientGeneratorMethods.PrepareData, context, Id) + .SelectMany(static (x, _) => x) + .SelectAndReportExceptions(GetMethodSourceCode, context, Id) + .AddSource(context); + + var models = filesAndSettings + .SelectAndReportExceptions(ModelGeneratorMethods.PrepareData, context, Id); + + models + .SelectMany(static (x, _) => x) + .SelectAndReportExceptions(GetModelSourceCode, context, Id) + .AddSource(context); + models + .Select(static (x, _) => x) + .SelectAndReportExceptions(GetSuperTypeSourceCode, context, Id) + .AddSource(context); + } + + private static string GetContent(AdditionalText additionalText, CancellationToken cancellationToken = default) + { + return additionalText.Path.StartsWith("http", StringComparison.OrdinalIgnoreCase) + ? Task.Run(() => new HttpClient().GetStringAsync(new Uri(additionalText.Path)), cancellationToken).Result + : additionalText.GetText(cancellationToken)?.ToString() ?? string.Empty;; + } + + private static FileWithName GetMethodSourceCode( + EndPoint endPoint, + CancellationToken cancellationToken = default) + { + var fileWithName = ClientGeneratorMethods.GetSourceCode(endPoint, cancellationToken); + + return new FileWithName( + Name: fileWithName.Name, + Text: fileWithName.Text); + } + + private static FileWithName GetModelSourceCode( + ModelData model, + CancellationToken cancellationToken = default) + { + var fileWithName = ModelGeneratorMethods.GetSourceCode(model, cancellationToken); + + return new FileWithName( + Name: fileWithName.Name, + Text: fileWithName.Text); + } + + private static FileWithName GetSuperTypeSourceCode( + Core.Models.EquatableArray models, + CancellationToken cancellationToken = default) + { + if (models.IsEmpty) + { + return FileWithName.Empty; + } + + var fileWithName = ModelGeneratorMethods.GetSourceCodeForSuperClass(models, cancellationToken); + + return new FileWithName( + Name: fileWithName.Name, + Text: fileWithName.Text); + } + + #endregion +} diff --git a/src/tests/OpenApiGenerator.SnapshotTests/Tests.cs b/src/tests/OpenApiGenerator.SnapshotTests/Tests.cs index 8165b8b770..910cdf73cc 100644 --- a/src/tests/OpenApiGenerator.SnapshotTests/Tests.cs +++ b/src/tests/OpenApiGenerator.SnapshotTests/Tests.cs @@ -2,7 +2,6 @@ using Microsoft.OpenApi.Extensions; using Microsoft.OpenApi.Models; using OpenApiGenerator.Core.Json; -using OpenApiGenerator.Generators; namespace OpenApiGenerator.SnapshotTests; @@ -46,11 +45,11 @@ public partial class Tests [DataRow(JsonSerializerType.NewtonsoftJson)] public Task Empty(JsonSerializerType jsonSerializerType) { - return CheckSourceAsync(jsonSerializerType, [], new Dictionary + return CheckSourceAsync(jsonSerializerType, [], new Dictionary { //["build_property.OpenApiGenerator_GenerateConstructors"] = "true", //["build_property.OpenApiGenerator_GenerateMethods"] = "true", - }, additionalGenerators: [new ClientGenerator()]); + }); } [DataTestMethod] @@ -58,7 +57,7 @@ public Task Empty(JsonSerializerType jsonSerializerType) [DataRow(JsonSerializerType.NewtonsoftJson)] public Task LangSmith(JsonSerializerType jsonSerializerType) { - return CheckSourceAsync(jsonSerializerType, [ + return CheckSourceAsync(jsonSerializerType, [ new CustomAdditionalText( path: H.Resources.langsmith_yaml.FileName, text: H.Resources.langsmith_yaml.AsString()) @@ -66,7 +65,7 @@ public Task LangSmith(JsonSerializerType jsonSerializerType) { //["build_property.OpenApiGenerator_JsonSerializerContext"] = "SourceGenerationContext", //["build_property.OpenApiGenerator_GenerateMethods"] = "true", - }, additionalGenerators: [new ClientGenerator()]); + }); } [DataTestMethod] @@ -74,7 +73,7 @@ public Task LangSmith(JsonSerializerType jsonSerializerType) [DataRow(JsonSerializerType.NewtonsoftJson)] public Task Ollama(JsonSerializerType jsonSerializerType) { - return CheckSourceAsync(jsonSerializerType, [ + return CheckSourceAsync(jsonSerializerType, [ new CustomAdditionalText( path: H.Resources.ollamacurated_yaml.FileName, text: H.Resources.ollamacurated_yaml.AsString()) @@ -106,7 +105,7 @@ public Task Replicate(JsonSerializerType jsonSerializerType) [DataRow(JsonSerializerType.NewtonsoftJson)] public Task OpenAi(JsonSerializerType jsonSerializerType) { - return CheckSourceAsync(jsonSerializerType, [ + return CheckSourceAsync(jsonSerializerType, [ new CustomAdditionalText( path: H.Resources.openai_yaml.FileName, text: H.Resources.openai_yaml.AsString()) @@ -116,7 +115,7 @@ public Task OpenAi(JsonSerializerType jsonSerializerType) //["build_property.OpenApiGenerator_GenerateMethods"] = "true", //["build_property.OpenApiGenerator_IncludeOperationIds"] = "ListModels", //["build_property.OpenApiGenerator_IncludeModels"] = "CreateEmbeddingRequest;CreateModerationResponse;Error;ErrorResponse;ListModelsResponse;Model;DeleteModelResponse;CreateCompletionRequest", - }, additionalGenerators: [new ClientGenerator()]); + }); } // // [DataTestMethod] @@ -144,7 +143,7 @@ public Task OpenAi(JsonSerializerType jsonSerializerType) [DataRow(JsonSerializerType.NewtonsoftJson)] public Task YamlWithLocalFile(JsonSerializerType jsonSerializerType) { - return CheckSourceAsync(jsonSerializerType, [ + return CheckSourceAsync(jsonSerializerType, [ new CustomAdditionalText( path: "openapi.yaml", text: H.Resources.ipinfo_yaml.AsString()), @@ -152,7 +151,7 @@ public Task YamlWithLocalFile(JsonSerializerType jsonSerializerType) { //["build_property.OpenApiGenerator_GenerateConstructors"] = "true", //["build_property.OpenApiGenerator_GenerateMethods"] = "true", - }, additionalGenerators: [new ClientGenerator()]); + }); } [DataTestMethod] @@ -162,26 +161,26 @@ public Task OpenApi3_0_Yaml(JsonSerializerType jsonSerializerType) { var yaml = PetStore.Serialize(OpenApiSpecVersion.OpenApi3_0, OpenApiFormat.Yaml); - return CheckSourceAsync(jsonSerializerType, [ + return CheckSourceAsync(jsonSerializerType, [ new CustomAdditionalText("openapi.yaml", yaml), ], new Dictionary { //["build_property.OpenApiGenerator_GenerateConstructors"] = "true", //["build_property.OpenApiGenerator_GenerateMethods"] = "true", - }, additionalGenerators: [new ClientGenerator()]); + }); } - [DataTestMethod] - [DataRow(JsonSerializerType.SystemTextJson)] - [DataRow(JsonSerializerType.NewtonsoftJson)] - public Task YamlWithUrl(JsonSerializerType jsonSerializerType) - { - return CheckSourceAsync(jsonSerializerType, [ - new CustomAdditionalText("https://dedoose-rest-api.onrender.com/swagger/v1/swagger.json", string.Empty), - ], new Dictionary - { - //["build_property.OpenApiGenerator_GenerateConstructors"] = "true", - //["build_property.OpenApiGenerator_GenerateMethods"] = "true", - }, additionalGenerators: [new ClientGenerator()]); - } + // [DataTestMethod] + // [DataRow(JsonSerializerType.SystemTextJson)] + // [DataRow(JsonSerializerType.NewtonsoftJson)] + // public Task YamlWithUrl(JsonSerializerType jsonSerializerType) + // { + // return CheckSourceAsync(jsonSerializerType, [ + // new CustomAdditionalText("https://dedoose-rest-api.onrender.com/swagger/v1/swagger.json", string.Empty), + // ], new Dictionary + // { + // //["build_property.OpenApiGenerator_GenerateConstructors"] = "true", + // //["build_property.OpenApiGenerator_GenerateMethods"] = "true", + // }); + // } } \ No newline at end of file diff --git a/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/GitHub/_.verified.txt b/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/GitHub/_.verified.txt index e55770450e..4d4ad71423 100644 --- a/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/GitHub/_.verified.txt +++ b/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/GitHub/_.verified.txt @@ -37,6 +37,7 @@ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: ghsaId, ArgumentName: ghsaId }, { @@ -64,6 +65,7 @@ DefaultValue: Type.Reviewed, Summary:
Default Value: reviewed, + ParameterName: type, ArgumentName: type }, { @@ -81,6 +83,7 @@ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: cveId, ArgumentName: cveId }, { @@ -126,6 +129,7 @@ ParameterStyle: Form, ParameterExplode: true, Summary: The package's language or package management ecosystem., + ParameterName: ecosystem, ArgumentName: ecosystem }, { @@ -155,6 +159,7 @@ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: severity, ArgumentName: severity }, { @@ -172,6 +177,7 @@ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: cwes, ArgumentName: cwes }, { @@ -189,6 +195,7 @@ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: isWithdrawn, ArgumentName: isWithdrawn }, { @@ -206,6 +213,7 @@ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: affects, ArgumentName: affects }, { @@ -223,6 +231,7 @@ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: published, ArgumentName: published }, { @@ -240,6 +249,7 @@ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: updated, ArgumentName: updated }, { @@ -257,6 +267,7 @@ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: modified, ArgumentName: modified }, { @@ -274,6 +285,7 @@ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -291,6 +303,7 @@ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -316,6 +329,7 @@ DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -335,6 +349,7 @@ DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -360,6 +375,7 @@ DefaultValue: Sort.Published, Summary:
Default Value: published, + ParameterName: sort, ArgumentName: sort } ], @@ -393,6 +409,7 @@ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ghsaId, ArgumentName: ghsaId } ], @@ -441,6 +458,7 @@ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: code, ArgumentName: code } ], @@ -489,6 +507,7 @@ Summary: The URL to which the payloads will be delivered.
Example: https://example.com/webhook, + ParameterName: url, ArgumentName: url }, { @@ -505,6 +524,7 @@ The URL to which the payloads will be delivered. Summary: The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
Example: "json", + ParameterName: contentType, ArgumentName: contentType }, { @@ -521,6 +541,7 @@ The media type used to serialize the payloads. Supported values include `json` a Summary: If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).
Example: "********", + ParameterName: secret, ArgumentName: secret }, { @@ -535,6 +556,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig }, IsRequired: false, Summary: , + ParameterName: insecureSsl, ArgumentName: insecureSsl } ], @@ -571,6 +593,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -588,6 +611,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: cursor, ArgumentName: cursor }, { @@ -605,6 +629,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: redelivery, ArgumentName: redelivery } ], @@ -638,6 +663,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deliveryId, ArgumentName: deliveryId } ], @@ -671,6 +697,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deliveryId, ArgumentName: deliveryId } ], @@ -707,6 +734,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -726,6 +754,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -761,6 +790,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -780,6 +810,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -797,6 +828,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -814,6 +846,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: outdated, ArgumentName: outdated } ], @@ -847,6 +880,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: installationId, ArgumentName: installationId } ], @@ -880,6 +914,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: installationId, ArgumentName: installationId } ], @@ -914,6 +949,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: installationId, ArgumentName: installationId }, { @@ -928,6 +964,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig }, IsRequired: false, Summary: List of repository names that the token should have access to, + ParameterName: repositories, ArgumentName: repositories }, { @@ -944,6 +981,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig Summary: List of repository IDs that the token should have access to
Example: [1], + ParameterName: repositoryIds, ArgumentName: repositoryIds }, { @@ -1009,6 +1047,7 @@ List of repository IDs that the token should have access to Summary: The permissions granted to the user access token.
Example: , + ParameterName: permissions, ArgumentName: permissions } ], @@ -1043,6 +1082,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: installationId, ArgumentName: installationId } ], @@ -1077,6 +1117,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: installationId, ArgumentName: installationId } ], @@ -1111,6 +1152,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: clientId, ArgumentName: clientId }, { @@ -1125,6 +1167,7 @@ The permissions granted to the user access token. }, IsRequired: true, Summary: The OAuth access token used to authenticate to the GitHub API., + ParameterName: accessToken, ArgumentName: accessToken } ], @@ -1159,6 +1202,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: clientId, ArgumentName: clientId }, { @@ -1173,6 +1217,7 @@ The permissions granted to the user access token. }, IsRequired: true, Summary: The access_token of the OAuth or GitHub application., + ParameterName: accessToken, ArgumentName: accessToken } ], @@ -1207,6 +1252,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: clientId, ArgumentName: clientId }, { @@ -1221,6 +1267,7 @@ The permissions granted to the user access token. }, IsRequired: true, Summary: The access_token of the OAuth or GitHub application., + ParameterName: accessToken, ArgumentName: accessToken } ], @@ -1255,6 +1302,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: clientId, ArgumentName: clientId }, { @@ -1269,6 +1317,7 @@ The permissions granted to the user access token. }, IsRequired: true, Summary: The OAuth access token used to authenticate to the GitHub API., + ParameterName: accessToken, ArgumentName: accessToken } ], @@ -1303,6 +1352,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: clientId, ArgumentName: clientId }, { @@ -1319,6 +1369,7 @@ The permissions granted to the user access token. Summary: The access token used to authenticate to the GitHub API.
Example: e72e16c7e42f292c6912e7710c838347ae178b4a, + ParameterName: accessToken, ArgumentName: accessToken }, { @@ -1335,6 +1386,7 @@ The access token used to authenticate to the GitHub API. Summary: The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified.
Example: octocat, + ParameterName: target, ArgumentName: target }, { @@ -1351,6 +1403,7 @@ The name of the user or organization to scope the user access token to. **Requir Summary: The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified.
Example: 1, + ParameterName: targetId, ArgumentName: targetId }, { @@ -1365,6 +1418,7 @@ The ID of the user or organization to scope the user access token to. **Required }, IsRequired: false, Summary: The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified., + ParameterName: repositories, ArgumentName: repositories }, { @@ -1381,6 +1435,7 @@ The ID of the user or organization to scope the user access token to. **Required Summary: The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified.
Example: [1], + ParameterName: repositoryIds, ArgumentName: repositoryIds }, { @@ -1446,6 +1501,7 @@ The list of repository IDs to scope the user access token to. `repository_ids` m Summary: The permissions granted to the user access token.
Example: , + ParameterName: permissions, ArgumentName: permissions } ], @@ -1480,6 +1536,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: appSlug, ArgumentName: appSlug } ], @@ -1513,6 +1570,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: assignmentId, ArgumentName: assignmentId } ], @@ -1546,6 +1604,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: assignmentId, ArgumentName: assignmentId }, { @@ -1565,6 +1624,7 @@ The permissions granted to the user access token. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -1584,6 +1644,7 @@ The permissions granted to the user access token. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -1617,6 +1678,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: assignmentId, ArgumentName: assignmentId } ], @@ -1652,6 +1714,7 @@ The permissions granted to the user access token. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -1671,6 +1734,7 @@ The permissions granted to the user access token. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -1704,6 +1768,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: classroomId, ArgumentName: classroomId } ], @@ -1737,6 +1802,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: classroomId, ArgumentName: classroomId }, { @@ -1756,6 +1822,7 @@ The permissions granted to the user access token. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -1775,6 +1842,7 @@ The permissions granted to the user access token. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -1823,6 +1891,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: key, ArgumentName: key } ], @@ -1871,6 +1940,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: enterprise, ArgumentName: enterprise }, { @@ -1888,6 +1958,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -1905,6 +1976,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: until, ArgumentName: until }, { @@ -1924,6 +1996,7 @@ The permissions granted to the user access token. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -1943,6 +2016,7 @@ The permissions granted to the user access token. DefaultValue: 28, Summary:
Default Value: 28, + ParameterName: perPage, ArgumentName: perPage } ], @@ -1976,6 +2050,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: enterprise, ArgumentName: enterprise }, { @@ -1993,6 +2068,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: state, ArgumentName: state }, { @@ -2010,6 +2086,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: severity, ArgumentName: severity }, { @@ -2027,6 +2104,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: ecosystem, ArgumentName: ecosystem }, { @@ -2044,6 +2122,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: package, ArgumentName: package }, { @@ -2067,6 +2146,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: scope, ArgumentName: scope }, { @@ -2092,6 +2172,7 @@ The permissions granted to the user access token. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -2117,6 +2198,7 @@ The permissions granted to the user access token. DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -2134,6 +2216,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -2151,6 +2234,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -2170,6 +2254,7 @@ The permissions granted to the user access token. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: first, ArgumentName: first }, { @@ -2187,6 +2272,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: last, ArgumentName: last }, { @@ -2206,6 +2292,7 @@ The permissions granted to the user access token. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -2239,6 +2326,7 @@ The permissions granted to the user access token. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: enterprise, ArgumentName: enterprise }, { @@ -2262,6 +2350,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: state, ArgumentName: state }, { @@ -2279,6 +2368,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: secretType, ArgumentName: secretType }, { @@ -2296,6 +2386,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: resolution, ArgumentName: resolution }, { @@ -2321,6 +2412,7 @@ The permissions granted to the user access token. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -2346,6 +2438,7 @@ The permissions granted to the user access token. DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -2365,6 +2458,7 @@ The permissions granted to the user access token. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -2382,6 +2476,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -2399,6 +2494,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -2416,6 +2512,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: validity, ArgumentName: validity } ], @@ -2451,6 +2548,7 @@ The permissions granted to the user access token. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -2470,6 +2568,7 @@ The permissions granted to the user access token. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -2518,6 +2617,7 @@ The permissions granted to the user access token. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -2537,6 +2637,7 @@ The permissions granted to the user access token. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -2556,6 +2657,7 @@ The permissions granted to the user access token. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -2588,6 +2690,7 @@ The permissions granted to the user access token. Summary: Description of the gist
Example: Example Ruby script, + ParameterName: description, ArgumentName: description }, { @@ -2604,6 +2707,7 @@ Description of the gist Summary: Names and content for the files that make up the gist
Example: , + ParameterName: files, ArgumentName: files }, { @@ -2619,6 +2723,7 @@ Names and content for the files that make up the gist IsRequired: false, DefaultValue: , Summary: , + ParameterName: public, ArgumentName: public } ], @@ -2653,6 +2758,7 @@ Names and content for the files that make up the gist ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -2672,6 +2778,7 @@ Names and content for the files that make up the gist DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -2691,6 +2798,7 @@ Names and content for the files that make up the gist DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -2724,6 +2832,7 @@ Names and content for the files that make up the gist ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -2743,6 +2852,7 @@ Names and content for the files that make up the gist DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -2762,6 +2872,7 @@ Names and content for the files that make up the gist DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -2795,6 +2906,7 @@ Names and content for the files that make up the gist ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId } ], @@ -2828,6 +2940,7 @@ Names and content for the files that make up the gist ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId }, { @@ -2844,6 +2957,7 @@ Names and content for the files that make up the gist Summary: The description of the gist.
Example: Example Ruby script, + ParameterName: description, ArgumentName: description }, { @@ -2864,6 +2978,7 @@ The gist files to be updated, renamed, or deleted. Each `key` must match the cur To delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be deleted if the specified object does not contain at least one of `content` or `filename`.
Example: , + ParameterName: files, ArgumentName: files } ], @@ -2898,6 +3013,7 @@ deleted if the specified object does not contain at least one of `content` or `f ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId } ], @@ -2932,6 +3048,7 @@ deleted if the specified object does not contain at least one of `content` or `f ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId }, { @@ -2951,6 +3068,7 @@ deleted if the specified object does not contain at least one of `content` or `f DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -2970,6 +3088,7 @@ deleted if the specified object does not contain at least one of `content` or `f DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -3003,6 +3122,7 @@ deleted if the specified object does not contain at least one of `content` or `f ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId }, { @@ -3019,6 +3139,7 @@ deleted if the specified object does not contain at least one of `content` or `f Summary: The comment text.
Example: Body of the attachment, + ParameterName: body, ArgumentName: body } ], @@ -3053,6 +3174,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId }, { @@ -3070,6 +3192,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId } ], @@ -3103,6 +3226,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId }, { @@ -3120,6 +3244,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -3136,6 +3261,7 @@ The comment text. Summary: The comment text.
Example: Body of the attachment, + ParameterName: body, ArgumentName: body } ], @@ -3170,6 +3296,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId }, { @@ -3187,6 +3314,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId } ], @@ -3221,6 +3349,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId }, { @@ -3240,6 +3369,7 @@ The comment text. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -3259,6 +3389,7 @@ The comment text. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -3292,6 +3423,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId }, { @@ -3311,6 +3443,7 @@ The comment text. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -3330,6 +3463,7 @@ The comment text. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -3363,6 +3497,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId } ], @@ -3397,6 +3532,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId } ], @@ -3430,6 +3566,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId } ], @@ -3464,6 +3601,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId } ], @@ -3498,6 +3636,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gistId, ArgumentName: gistId }, { @@ -3515,6 +3654,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: sha, ArgumentName: sha } ], @@ -3563,6 +3703,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -3598,6 +3739,7 @@ The comment text. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -3617,6 +3759,7 @@ The comment text. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -3682,6 +3825,7 @@ The comment text. DefaultValue: Filter.Assigned, Summary:
Default Value: assigned, + ParameterName: filter, ArgumentName: filter }, { @@ -3709,6 +3853,7 @@ The comment text. DefaultValue: State.Open, Summary:
Default Value: open, + ParameterName: state, ArgumentName: state }, { @@ -3726,6 +3871,7 @@ The comment text. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: labels, ArgumentName: labels }, { @@ -3753,6 +3899,7 @@ The comment text. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -3778,6 +3925,7 @@ The comment text. DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -3795,6 +3943,7 @@ The comment text. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -3812,6 +3961,7 @@ The comment text. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: collab, ArgumentName: collab }, { @@ -3829,6 +3979,7 @@ The comment text. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: orgs, ArgumentName: orgs }, { @@ -3846,6 +3997,7 @@ The comment text. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: owned, ArgumentName: owned }, { @@ -3863,6 +4015,7 @@ The comment text. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: pulls, ArgumentName: pulls }, { @@ -3882,6 +4035,7 @@ The comment text. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -3901,6 +4055,7 @@ The comment text. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -3934,6 +4089,7 @@ The comment text. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: featured, ArgumentName: featured }, { @@ -3953,6 +4109,7 @@ The comment text. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -3972,6 +4129,7 @@ The comment text. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -4005,6 +4163,7 @@ The comment text. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: license, ArgumentName: license } ], @@ -4035,6 +4194,7 @@ The comment text. }, IsRequired: true, Summary: The Markdown text to render in HTML., + ParameterName: text, ArgumentName: text }, { @@ -4059,6 +4219,7 @@ The comment text. The rendering mode.
Default Value: markdown
Example: markdown, + ParameterName: mode, ArgumentName: mode }, { @@ -4073,6 +4234,7 @@ The rendering mode. }, IsRequired: false, Summary: The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository., + ParameterName: context, ArgumentName: context } ], @@ -4123,6 +4285,7 @@ The rendering mode. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: accountId, ArgumentName: accountId } ], @@ -4158,6 +4321,7 @@ The rendering mode. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -4177,6 +4341,7 @@ The rendering mode. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -4210,6 +4375,7 @@ The rendering mode. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: planId, ArgumentName: planId }, { @@ -4235,6 +4401,7 @@ The rendering mode. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -4258,6 +4425,7 @@ The rendering mode. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: direction, ArgumentName: direction }, { @@ -4277,6 +4445,7 @@ The rendering mode. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -4296,6 +4465,7 @@ The rendering mode. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -4329,6 +4499,7 @@ The rendering mode. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: accountId, ArgumentName: accountId } ], @@ -4364,6 +4535,7 @@ The rendering mode. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -4383,6 +4555,7 @@ The rendering mode. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -4416,6 +4589,7 @@ The rendering mode. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: planId, ArgumentName: planId }, { @@ -4441,6 +4615,7 @@ The rendering mode. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -4464,6 +4639,7 @@ The rendering mode. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: direction, ArgumentName: direction }, { @@ -4483,6 +4659,7 @@ The rendering mode. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -4502,6 +4679,7 @@ The rendering mode. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -4550,6 +4728,7 @@ The rendering mode. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -4567,6 +4746,7 @@ The rendering mode. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -4586,6 +4766,7 @@ The rendering mode. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -4605,6 +4786,7 @@ The rendering mode. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -4640,6 +4822,7 @@ The rendering mode. DefaultValue: false, Summary:
Default Value: false, + ParameterName: all, ArgumentName: all }, { @@ -4659,6 +4842,7 @@ The rendering mode. DefaultValue: false, Summary:
Default Value: false, + ParameterName: participating, ArgumentName: participating }, { @@ -4676,6 +4860,7 @@ The rendering mode. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -4693,6 +4878,7 @@ The rendering mode. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -4712,6 +4898,7 @@ The rendering mode. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -4731,6 +4918,7 @@ The rendering mode. DefaultValue: 50, Summary:
Default Value: 50, + ParameterName: perPage, ArgumentName: perPage } ], @@ -4761,6 +4949,7 @@ The rendering mode. }, IsRequired: false, Summary: Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp., + ParameterName: lastReadAt, ArgumentName: lastReadAt }, { @@ -4775,6 +4964,7 @@ The rendering mode. }, IsRequired: false, Summary: Whether the notification has been read., + ParameterName: read, ArgumentName: read } ], @@ -4809,6 +4999,7 @@ The rendering mode. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId } ], @@ -4842,6 +5033,7 @@ The rendering mode. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId } ], @@ -4876,6 +5068,7 @@ The rendering mode. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId } ], @@ -4910,6 +5103,7 @@ The rendering mode. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId } ], @@ -4943,6 +5137,7 @@ The rendering mode. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -4960,6 +5155,7 @@ The rendering mode. Summary: Whether to block all notifications from a thread.
Default Value: false, + ParameterName: ignored, ArgumentName: ignored } ], @@ -4994,6 +5190,7 @@ Whether to block all notifications from a thread. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId } ], @@ -5028,6 +5225,7 @@ Whether to block all notifications from a thread. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: s, ArgumentName: s } ], @@ -5061,6 +5259,7 @@ Whether to block all notifications from a thread. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -5080,6 +5279,7 @@ Whether to block all notifications from a thread. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -5113,6 +5313,7 @@ Whether to block all notifications from a thread. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -5146,6 +5347,7 @@ Whether to block all notifications from a thread. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -5160,6 +5362,7 @@ Whether to block all notifications from a thread. }, IsRequired: false, Summary: Billing email address. This address is not publicized., + ParameterName: billingEmail, ArgumentName: billingEmail }, { @@ -5174,6 +5377,7 @@ Whether to block all notifications from a thread. }, IsRequired: false, Summary: The company name., + ParameterName: company, ArgumentName: company }, { @@ -5188,6 +5392,7 @@ Whether to block all notifications from a thread. }, IsRequired: false, Summary: The publicly visible email address., + ParameterName: email, ArgumentName: email }, { @@ -5202,6 +5407,7 @@ Whether to block all notifications from a thread. }, IsRequired: false, Summary: The Twitter username of the company., + ParameterName: twitterUsername, ArgumentName: twitterUsername }, { @@ -5216,6 +5422,7 @@ Whether to block all notifications from a thread. }, IsRequired: false, Summary: The location., + ParameterName: location, ArgumentName: location }, { @@ -5230,6 +5437,7 @@ Whether to block all notifications from a thread. }, IsRequired: false, Summary: The shorthand name of the company., + ParameterName: name, ArgumentName: name }, { @@ -5244,6 +5452,7 @@ Whether to block all notifications from a thread. }, IsRequired: false, Summary: The description of the company. The maximum size is 160 characters., + ParameterName: description, ArgumentName: description }, { @@ -5258,6 +5467,7 @@ Whether to block all notifications from a thread. }, IsRequired: false, Summary: Whether an organization can use organization projects., + ParameterName: hasOrganizationProjects, ArgumentName: hasOrganizationProjects }, { @@ -5272,6 +5482,7 @@ Whether to block all notifications from a thread. }, IsRequired: false, Summary: Whether repositories that belong to the organization can use repository projects., + ParameterName: hasRepositoryProjects, ArgumentName: hasRepositoryProjects }, { @@ -5299,6 +5510,7 @@ Whether to block all notifications from a thread. Summary: Default permission level members have for organization repositories.
Default Value: read, + ParameterName: defaultRepositoryPermission, ArgumentName: defaultRepositoryPermission }, { @@ -5316,6 +5528,7 @@ Default permission level members have for organization repositories. Summary: Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.
Default Value: true, + ParameterName: membersCanCreateRepositories, ArgumentName: membersCanCreateRepositories }, { @@ -5330,6 +5543,7 @@ Whether of non-admin organization members can create repositories. **Note:** A p }, IsRequired: false, Summary: Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation., + ParameterName: membersCanCreateInternalRepositories, ArgumentName: membersCanCreateInternalRepositories }, { @@ -5344,6 +5558,7 @@ Whether of non-admin organization members can create repositories. **Note:** A p }, IsRequired: false, Summary: Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation., + ParameterName: membersCanCreatePrivateRepositories, ArgumentName: membersCanCreatePrivateRepositories }, { @@ -5358,6 +5573,7 @@ Whether of non-admin organization members can create repositories. **Note:** A p }, IsRequired: false, Summary: Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation., + ParameterName: membersCanCreatePublicRepositories, ArgumentName: membersCanCreatePublicRepositories }, { @@ -5382,6 +5598,7 @@ Whether of non-admin organization members can create repositories. **Note:** A p Summary: Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud. **Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details., + ParameterName: membersAllowedRepositoryCreationType, ArgumentName: membersAllowedRepositoryCreationType }, { @@ -5399,6 +5616,7 @@ Specifies which types of repositories non-admin organization members can create. Summary: Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.
Default Value: true, + ParameterName: membersCanCreatePages, ArgumentName: membersCanCreatePages }, { @@ -5416,6 +5634,7 @@ Whether organization members can create GitHub Pages sites. Existing published s Summary: Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.
Default Value: true, + ParameterName: membersCanCreatePublicPages, ArgumentName: membersCanCreatePublicPages }, { @@ -5433,6 +5652,7 @@ Whether organization members can create public GitHub Pages sites. Existing publ Summary: Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.
Default Value: true, + ParameterName: membersCanCreatePrivatePages, ArgumentName: membersCanCreatePrivatePages }, { @@ -5450,6 +5670,7 @@ Whether organization members can create private GitHub Pages sites. Existing pub Summary: Whether organization members can fork private organization repositories.
Default Value: false, + ParameterName: membersCanForkPrivateRepositories, ArgumentName: membersCanForkPrivateRepositories }, { @@ -5467,6 +5688,7 @@ Whether organization members can fork private organization repositories. Summary: Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.
Default Value: false, + ParameterName: webCommitSignoffRequired, ArgumentName: webCommitSignoffRequired }, { @@ -5482,6 +5704,7 @@ Whether contributors to organization repositories are required to sign off on co IsRequired: false, Summary:
Example: "http://github.blog", + ParameterName: blog, ArgumentName: blog }, { @@ -5501,6 +5724,7 @@ Whether GitHub Advanced Security is automatically enabled for new repositories. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request., + ParameterName: advancedSecurityEnabledForNewRepositories, ArgumentName: advancedSecurityEnabledForNewRepositories }, { @@ -5520,6 +5744,7 @@ Whether Dependabot alerts is automatically enabled for new repositories. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request., + ParameterName: dependabotAlertsEnabledForNewRepositories, ArgumentName: dependabotAlertsEnabledForNewRepositories }, { @@ -5539,6 +5764,7 @@ Whether Dependabot security updates is automatically enabled for new repositorie To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request., + ParameterName: dependabotSecurityUpdatesEnabledForNewRepositories, ArgumentName: dependabotSecurityUpdatesEnabledForNewRepositories }, { @@ -5558,6 +5784,7 @@ Whether dependency graph is automatically enabled for new repositories. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request., + ParameterName: dependencyGraphEnabledForNewRepositories, ArgumentName: dependencyGraphEnabledForNewRepositories }, { @@ -5577,6 +5804,7 @@ Whether secret scanning is automatically enabled for new repositories. To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request., + ParameterName: secretScanningEnabledForNewRepositories, ArgumentName: secretScanningEnabledForNewRepositories }, { @@ -5596,6 +5824,7 @@ Whether secret scanning push protection is automatically enabled for new reposit To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request., + ParameterName: secretScanningPushProtectionEnabledForNewRepositories, ArgumentName: secretScanningPushProtectionEnabledForNewRepositories }, { @@ -5610,6 +5839,7 @@ You can check which security and analysis features are currently enabled by usin }, IsRequired: false, Summary: Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection., + ParameterName: secretScanningPushProtectionCustomLinkEnabled, ArgumentName: secretScanningPushProtectionCustomLinkEnabled }, { @@ -5624,6 +5854,7 @@ You can check which security and analysis features are currently enabled by usin }, IsRequired: false, Summary: If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret., + ParameterName: secretScanningPushProtectionCustomLink, ArgumentName: secretScanningPushProtectionCustomLink } ], @@ -5658,6 +5889,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -5692,6 +5924,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -5725,6 +5958,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -5744,6 +5978,7 @@ You can check which security and analysis features are currently enabled by usin DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -5763,6 +5998,7 @@ You can check which security and analysis features are currently enabled by usin DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -5796,6 +6032,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -5829,6 +6066,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -5843,6 +6081,7 @@ You can check which security and analysis features are currently enabled by usin }, IsRequired: true, Summary: Array of unique strings. Each claim key can only contain alphanumeric characters and underscores., + ParameterName: includeClaimKeys, ArgumentName: includeClaimKeys } ], @@ -5877,6 +6116,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -5910,6 +6150,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -5932,6 +6173,7 @@ You can check which security and analysis features are currently enabled by usin }, IsRequired: true, Summary: The policy that controls the repositories in the organization that are allowed to run GitHub Actions., + ParameterName: enabledRepositories, ArgumentName: enabledRepositories }, { @@ -5954,6 +6196,7 @@ You can check which security and analysis features are currently enabled by usin }, IsRequired: false, Summary: The permissions policy that controls the actions and reusable workflows that are allowed to run., + ParameterName: allowedActions, ArgumentName: allowedActions } ], @@ -5988,6 +6231,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6007,6 +6251,7 @@ You can check which security and analysis features are currently enabled by usin DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -6026,6 +6271,7 @@ You can check which security and analysis features are currently enabled by usin DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -6059,6 +6305,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6073,6 +6320,7 @@ You can check which security and analysis features are currently enabled by usin }, IsRequired: true, Summary: List of repository IDs to enable for GitHub Actions., + ParameterName: selectedRepositoryIds, ArgumentName: selectedRepositoryIds } ], @@ -6107,6 +6355,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6124,6 +6373,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -6158,6 +6408,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6175,6 +6426,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -6209,6 +6461,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -6242,6 +6495,7 @@ You can check which security and analysis features are currently enabled by usin ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6256,6 +6510,7 @@ You can check which security and analysis features are currently enabled by usin }, IsRequired: false, Summary: Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization., + ParameterName: githubOwnedAllowed, ArgumentName: githubOwnedAllowed }, { @@ -6270,6 +6525,7 @@ You can check which security and analysis features are currently enabled by usin }, IsRequired: false, Summary: Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators., + ParameterName: verifiedAllowed, ArgumentName: verifiedAllowed }, { @@ -6287,6 +6543,7 @@ You can check which security and analysis features are currently enabled by usin Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. **Note**: The `patterns_allowed` setting only applies to public repositories., + ParameterName: patternsAllowed, ArgumentName: patternsAllowed } ], @@ -6321,6 +6578,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -6354,6 +6612,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6374,6 +6633,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu }, IsRequired: false, Summary: The default workflow permissions granted to the GITHUB_TOKEN when running workflows., + ParameterName: defaultWorkflowPermissions, ArgumentName: defaultWorkflowPermissions }, { @@ -6388,6 +6648,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu }, IsRequired: false, Summary: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk., + ParameterName: canApprovePullRequestReviews, ArgumentName: canApprovePullRequestReviews } ], @@ -6422,6 +6683,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -6439,6 +6701,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6458,6 +6721,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -6477,6 +6741,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -6510,6 +6775,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -6543,6 +6809,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6557,6 +6824,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu }, IsRequired: true, Summary: The name of the new runner., + ParameterName: name, ArgumentName: name }, { @@ -6571,6 +6839,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu }, IsRequired: true, Summary: The ID of the runner group to register the runner to., + ParameterName: runnerGroupId, ArgumentName: runnerGroupId }, { @@ -6585,6 +6854,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu }, IsRequired: true, Summary: The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100., + ParameterName: labels, ArgumentName: labels }, { @@ -6602,6 +6872,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu Summary: The working directory to be used for job execution, relative to the runner install directory.
Default Value: _work, + ParameterName: workFolder, ArgumentName: workFolder } ], @@ -6636,6 +6907,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -6670,6 +6942,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -6704,6 +6977,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6721,6 +6995,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId } ], @@ -6754,6 +7029,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6771,6 +7047,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId } ], @@ -6805,6 +7082,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6822,6 +7100,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId } ], @@ -6855,6 +7134,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6872,6 +7152,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId }, { @@ -6886,6 +7167,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The names of the custom labels to add to the runner., + ParameterName: labels, ArgumentName: labels } ], @@ -6920,6 +7202,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -6937,6 +7220,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId }, { @@ -6951,6 +7235,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels., + ParameterName: labels, ArgumentName: labels } ], @@ -6985,6 +7270,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7002,6 +7288,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId } ], @@ -7036,6 +7323,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7053,6 +7341,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId }, { @@ -7070,6 +7359,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -7104,6 +7394,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7123,6 +7414,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -7142,6 +7434,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -7175,6 +7468,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -7208,6 +7502,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7225,6 +7520,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -7258,6 +7554,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7275,6 +7572,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -7289,6 +7587,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint., + ParameterName: encryptedValue, ArgumentName: encryptedValue }, { @@ -7303,6 +7602,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: ID of the key you used to encrypt the secret., + ParameterName: keyId, ArgumentName: keyId }, { @@ -7325,6 +7625,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret., + ParameterName: visibility, ArgumentName: visibility }, { @@ -7339,6 +7640,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints., + ParameterName: selectedRepositoryIds, ArgumentName: selectedRepositoryIds } ], @@ -7373,6 +7675,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7390,6 +7693,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -7424,6 +7728,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7441,6 +7746,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -7460,6 +7766,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -7479,6 +7786,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -7512,6 +7820,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7529,6 +7838,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -7543,6 +7853,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints., + ParameterName: selectedRepositoryIds, ArgumentName: selectedRepositoryIds } ], @@ -7577,6 +7888,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7594,6 +7906,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -7611,6 +7924,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -7645,6 +7959,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7662,6 +7977,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -7679,6 +7995,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -7713,6 +8030,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7732,6 +8050,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 10, Summary:
Default Value: 10, + ParameterName: perPage, ArgumentName: perPage }, { @@ -7751,6 +8070,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -7784,6 +8104,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7798,6 +8119,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The name of the variable., + ParameterName: name, ArgumentName: name }, { @@ -7812,6 +8134,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The value of the variable., + ParameterName: value, ArgumentName: value }, { @@ -7834,6 +8157,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable., + ParameterName: visibility, ArgumentName: visibility }, { @@ -7848,6 +8172,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`., + ParameterName: selectedRepositoryIds, ArgumentName: selectedRepositoryIds } ], @@ -7882,6 +8207,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7899,6 +8225,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -7932,6 +8259,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -7949,6 +8277,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -7963,6 +8292,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: The name of the variable., + ParameterName: name, ArgumentName: name }, { @@ -7977,6 +8307,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: The value of the variable., + ParameterName: value, ArgumentName: value }, { @@ -7999,6 +8330,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable., + ParameterName: visibility, ArgumentName: visibility }, { @@ -8013,6 +8345,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`., + ParameterName: selectedRepositoryIds, ArgumentName: selectedRepositoryIds } ], @@ -8047,6 +8380,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -8064,6 +8398,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -8098,6 +8433,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -8115,6 +8451,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -8134,6 +8471,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -8153,6 +8491,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -8186,6 +8525,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -8203,6 +8543,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -8217,6 +8558,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The IDs of the repositories that can access the organization variable., + ParameterName: selectedRepositoryIds, ArgumentName: selectedRepositoryIds } ], @@ -8251,6 +8593,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -8268,6 +8611,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -8285,6 +8629,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -8319,6 +8664,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -8336,6 +8682,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -8353,6 +8700,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -8387,6 +8735,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -8406,6 +8755,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -8425,6 +8775,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -8458,6 +8809,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -8475,6 +8827,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -8508,6 +8861,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -8525,6 +8879,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -8559,6 +8914,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -8576,6 +8932,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -8610,6 +8967,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -8627,6 +8985,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: The name of the tool used to generate the code scanning analysis., + ParameterName: toolName, ArgumentName: toolName }, { @@ -8644,6 +9003,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data., + ParameterName: toolGuid, ArgumentName: toolGuid }, { @@ -8661,6 +9021,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -8678,6 +9039,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -8697,6 +9059,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -8716,6 +9079,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -8741,6 +9105,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -8768,6 +9133,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: State of a code scanning alert., + ParameterName: state, ArgumentName: state }, { @@ -8793,6 +9159,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -8826,6 +9193,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: Severity of a code scanning alert., + ParameterName: severity, ArgumentName: severity } ], @@ -8861,6 +9229,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -8880,6 +9249,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -8897,6 +9267,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -8930,6 +9301,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -8954,6 +9326,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization., + ParameterName: visibility, ArgumentName: visibility }, { @@ -8968,6 +9341,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value., + ParameterName: selectedUsernames, ArgumentName: selectedUsernames } ], @@ -9002,6 +9376,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9016,6 +9391,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The usernames of the organization members whose codespaces be billed to the organization., + ParameterName: selectedUsernames, ArgumentName: selectedUsernames } ], @@ -9050,6 +9426,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9064,6 +9441,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The usernames of the organization members whose codespaces should not be billed to the organization., + ParameterName: selectedUsernames, ArgumentName: selectedUsernames } ], @@ -9098,6 +9476,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9117,6 +9496,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -9136,6 +9516,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -9169,6 +9550,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -9202,6 +9584,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9219,6 +9602,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -9252,6 +9636,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9269,6 +9654,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -9283,6 +9669,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint., + ParameterName: encryptedValue, ArgumentName: encryptedValue }, { @@ -9297,6 +9684,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: The ID of the key you used to encrypt the secret., + ParameterName: keyId, ArgumentName: keyId }, { @@ -9319,6 +9707,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret., + ParameterName: visibility, ArgumentName: visibility }, { @@ -9333,6 +9722,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints., + ParameterName: selectedRepositoryIds, ArgumentName: selectedRepositoryIds } ], @@ -9367,6 +9757,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9384,6 +9775,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -9418,6 +9810,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9435,6 +9828,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -9454,6 +9848,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -9473,6 +9868,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -9506,6 +9902,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9523,6 +9920,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -9537,6 +9935,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints., + ParameterName: selectedRepositoryIds, ArgumentName: selectedRepositoryIds } ], @@ -9571,6 +9970,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9588,6 +9988,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -9605,6 +10006,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -9639,6 +10041,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9656,6 +10059,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -9673,6 +10077,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -9707,6 +10112,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -9740,6 +10146,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9759,6 +10166,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -9778,6 +10186,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 50, Summary:
Default Value: 50, + ParameterName: perPage, ArgumentName: perPage } ], @@ -9811,6 +10220,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9825,6 +10235,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: List of team names within the organization to which to grant access to GitHub Copilot., + ParameterName: selectedTeams, ArgumentName: selectedTeams } ], @@ -9859,6 +10270,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9873,6 +10285,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The names of teams from which to revoke access to GitHub Copilot., + ParameterName: selectedTeams, ArgumentName: selectedTeams } ], @@ -9907,6 +10320,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9921,6 +10335,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The usernames of the organization members to be granted access to GitHub Copilot., + ParameterName: selectedUsernames, ArgumentName: selectedUsernames } ], @@ -9955,6 +10370,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -9969,6 +10385,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The usernames of the organization members for which to revoke access to GitHub Copilot., + ParameterName: selectedUsernames, ArgumentName: selectedUsernames } ], @@ -10003,6 +10420,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -10020,6 +10438,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -10037,6 +10456,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: until, ArgumentName: until }, { @@ -10056,6 +10476,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -10075,6 +10496,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 28, Summary:
Default Value: 28, + ParameterName: perPage, ArgumentName: perPage } ], @@ -10108,6 +10530,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -10125,6 +10548,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: state, ArgumentName: state }, { @@ -10142,6 +10566,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: severity, ArgumentName: severity }, { @@ -10159,6 +10584,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: ecosystem, ArgumentName: ecosystem }, { @@ -10176,6 +10602,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: package, ArgumentName: package }, { @@ -10199,6 +10626,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: scope, ArgumentName: scope }, { @@ -10224,6 +10652,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -10249,6 +10678,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -10266,6 +10696,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -10283,6 +10714,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -10302,6 +10734,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: first, ArgumentName: first }, { @@ -10319,6 +10752,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: last, ArgumentName: last }, { @@ -10338,6 +10772,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -10371,6 +10806,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -10390,6 +10826,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -10409,6 +10846,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -10442,6 +10880,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -10475,6 +10914,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -10492,6 +10932,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -10525,6 +10966,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -10542,6 +10984,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -10556,6 +10999,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint., + ParameterName: encryptedValue, ArgumentName: encryptedValue }, { @@ -10570,6 +11014,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: ID of the key you used to encrypt the secret., + ParameterName: keyId, ArgumentName: keyId }, { @@ -10592,6 +11037,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret., + ParameterName: visibility, ArgumentName: visibility }, { @@ -10606,6 +11052,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: false, Summary: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints., + ParameterName: selectedRepositoryIds, ArgumentName: selectedRepositoryIds } ], @@ -10640,6 +11087,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -10657,6 +11105,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -10691,6 +11140,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -10708,6 +11158,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -10727,6 +11178,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -10746,6 +11198,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -10779,6 +11232,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -10796,6 +11250,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -10810,6 +11265,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints., + ParameterName: selectedRepositoryIds, ArgumentName: selectedRepositoryIds } ], @@ -10844,6 +11300,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -10861,6 +11318,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -10878,6 +11336,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -10912,6 +11371,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -10929,6 +11389,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -10946,6 +11407,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -10980,6 +11442,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -11013,6 +11476,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11032,6 +11496,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -11051,6 +11516,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -11084,6 +11550,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11103,6 +11570,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -11122,6 +11590,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -11155,6 +11624,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11174,6 +11644,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -11193,6 +11664,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -11226,6 +11698,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11240,6 +11713,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: Must be passed as "web"., + ParameterName: name, ArgumentName: name }, { @@ -11254,6 +11728,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: Key/value pairs to provide settings for this webhook., + ParameterName: config, ArgumentName: config }, { @@ -11271,6 +11746,7 @@ The working directory to be used for job execution, relative to the runner insta Summary: Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events.
Default Value: [push], + ParameterName: events, ArgumentName: events }, { @@ -11288,6 +11764,7 @@ Determines what [events](https://docs.github.com/webhooks/event-payloads) the ho Summary: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
Default Value: true, + ParameterName: active, ArgumentName: active } ], @@ -11322,6 +11799,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11339,6 +11817,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId } ], @@ -11372,6 +11851,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11389,6 +11869,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId }, { @@ -11403,6 +11884,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true }, IsRequired: false, Summary: Key/value pairs to provide settings for this webhook., + ParameterName: config, ArgumentName: config }, { @@ -11420,6 +11902,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true Summary: Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.
Default Value: [push], + ParameterName: events, ArgumentName: events }, { @@ -11437,6 +11920,7 @@ Determines what [events](https://docs.github.com/webhooks/event-payloads) the ho Summary: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
Default Value: true, + ParameterName: active, ArgumentName: active }, { @@ -11452,6 +11936,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true IsRequired: false, Summary:
Example: "web", + ParameterName: name, ArgumentName: name } ], @@ -11486,6 +11971,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11503,6 +11989,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId } ], @@ -11537,6 +12024,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11554,6 +12042,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId } ], @@ -11587,6 +12076,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11604,6 +12094,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId }, { @@ -11620,6 +12111,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true Summary: The URL to which the payloads will be delivered.
Example: https://example.com/webhook, + ParameterName: url, ArgumentName: url }, { @@ -11636,6 +12128,7 @@ The URL to which the payloads will be delivered. Summary: The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
Example: "json", + ParameterName: contentType, ArgumentName: contentType }, { @@ -11652,6 +12145,7 @@ The media type used to serialize the payloads. Supported values include `json` a Summary: If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).
Example: "********", + ParameterName: secret, ArgumentName: secret }, { @@ -11666,6 +12160,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig }, IsRequired: false, Summary: , + ParameterName: insecureSsl, ArgumentName: insecureSsl } ], @@ -11700,6 +12195,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11717,6 +12213,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId }, { @@ -11736,6 +12233,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -11753,6 +12251,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: cursor, ArgumentName: cursor }, { @@ -11770,6 +12269,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: redelivery, ArgumentName: redelivery } ], @@ -11803,6 +12303,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11820,6 +12321,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId }, { @@ -11837,6 +12339,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deliveryId, ArgumentName: deliveryId } ], @@ -11870,6 +12373,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11887,6 +12391,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId }, { @@ -11904,6 +12409,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deliveryId, ArgumentName: deliveryId } ], @@ -11938,6 +12444,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -11955,6 +12462,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId } ], @@ -11989,6 +12497,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -12022,6 +12531,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -12041,6 +12551,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -12060,6 +12571,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -12093,6 +12605,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -12126,6 +12639,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -12150,6 +12664,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig Summary: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.
Example: collaborators_only, + ParameterName: limit, ArgumentName: limit }, { @@ -12178,6 +12693,7 @@ The type of GitHub user that can comment, open issues, or create pull requests w Summary: The duration of the interaction restriction. Default: `one_day`.
Example: one_month, + ParameterName: expiry, ArgumentName: expiry } ], @@ -12212,6 +12728,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -12246,6 +12763,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -12265,6 +12783,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -12284,6 +12803,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -12315,6 +12835,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: Role.All, Summary:
Default Value: all, + ParameterName: role, ArgumentName: role }, { @@ -12342,6 +12863,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: InvitationSource.All, Summary:
Default Value: all, + ParameterName: invitationSource, ArgumentName: invitationSource } ], @@ -12375,6 +12897,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -12389,6 +12912,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: false, Summary: **Required unless you provide `email`**. GitHub user ID for the person you are inviting., + ParameterName: inviteeId, ArgumentName: inviteeId }, { @@ -12403,6 +12927,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: false, Summary: **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user., + ParameterName: email, ArgumentName: email }, { @@ -12434,6 +12959,7 @@ The role for the new member. * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization.
Default Value: direct_member, + ParameterName: role, ArgumentName: role }, { @@ -12448,6 +12974,7 @@ The role for the new member. }, IsRequired: false, Summary: Specify IDs for the teams you want to invite new members to., + ParameterName: teamIds, ArgumentName: teamIds } ], @@ -12482,6 +13009,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -12499,6 +13027,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: invitationId, ArgumentName: invitationId } ], @@ -12533,6 +13062,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -12550,6 +13080,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: invitationId, ArgumentName: invitationId }, { @@ -12569,6 +13100,7 @@ The role for the new member. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -12588,6 +13120,7 @@ The role for the new member. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -12621,6 +13154,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -12654,6 +13188,7 @@ The role for the new member. DefaultValue: Filter.Assigned, Summary:
Default Value: assigned, + ParameterName: filter, ArgumentName: filter }, { @@ -12681,6 +13216,7 @@ The role for the new member. DefaultValue: State.Open, Summary:
Default Value: open, + ParameterName: state, ArgumentName: state }, { @@ -12698,6 +13234,7 @@ The role for the new member. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: labels, ArgumentName: labels }, { @@ -12725,6 +13262,7 @@ The role for the new member. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -12750,6 +13288,7 @@ The role for the new member. DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -12767,6 +13306,7 @@ The role for the new member. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -12786,6 +13326,7 @@ The role for the new member. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -12805,6 +13346,7 @@ The role for the new member. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -12838,6 +13380,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -12863,6 +13406,7 @@ The role for the new member. DefaultValue: Filter.All, Summary:
Default Value: all, + ParameterName: filter, ArgumentName: filter }, { @@ -12890,6 +13434,7 @@ The role for the new member. DefaultValue: Role.All, Summary:
Default Value: all, + ParameterName: role, ArgumentName: role }, { @@ -12909,6 +13454,7 @@ The role for the new member. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -12928,6 +13474,7 @@ The role for the new member. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -12961,6 +13508,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -12978,6 +13526,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -13011,6 +13560,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13028,6 +13578,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -13064,6 +13615,7 @@ The role for the new member. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -13083,6 +13635,7 @@ The role for the new member. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -13100,6 +13653,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13117,6 +13671,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -13150,6 +13705,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13167,6 +13723,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -13184,6 +13741,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codespaceName, ArgumentName: codespaceName } ], @@ -13218,6 +13776,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13235,6 +13794,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -13252,6 +13812,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codespaceName, ArgumentName: codespaceName } ], @@ -13286,6 +13847,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13303,6 +13865,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -13336,6 +13899,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13353,6 +13917,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -13386,6 +13951,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13403,6 +13969,7 @@ The role for the new member. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -13428,6 +13995,7 @@ The role to give the user in the organization. Can be one of: * `admin` - The user will become an owner of the organization. * `member` - The user will become a non-owner member of the organization.
Default Value: member, + ParameterName: role, ArgumentName: role } ], @@ -13462,6 +14030,7 @@ The role to give the user in the organization. Can be one of: ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13479,6 +14048,7 @@ The role to give the user in the organization. Can be one of: ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -13513,6 +14083,7 @@ The role to give the user in the organization. Can be one of: ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13532,6 +14103,7 @@ The role to give the user in the organization. Can be one of: DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -13551,6 +14123,7 @@ The role to give the user in the organization. Can be one of: DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -13568,6 +14141,7 @@ The role to give the user in the organization. Can be one of: ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: exclude, ArgumentName: exclude } ], @@ -13601,6 +14175,7 @@ The role to give the user in the organization. Can be one of: ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13615,6 +14190,7 @@ The role to give the user in the organization. Can be one of: }, IsRequired: true, Summary: A list of arrays indicating which repositories should be migrated., + ParameterName: repositories, ArgumentName: repositories }, { @@ -13633,6 +14209,7 @@ The role to give the user in the organization. Can be one of: Indicates whether repositories should be locked (to prevent manipulation) while migrating data.
Default Value: false
Example: true, + ParameterName: lockRepositories, ArgumentName: lockRepositories }, { @@ -13650,6 +14227,7 @@ Indicates whether repositories should be locked (to prevent manipulation) while Summary: Indicates whether metadata should be excluded and only git source should be included for the migration.
Default Value: false, + ParameterName: excludeMetadata, ArgumentName: excludeMetadata }, { @@ -13667,6 +14245,7 @@ Indicates whether metadata should be excluded and only git source should be incl Summary: Indicates whether the repository git data should be excluded from the migration.
Default Value: false, + ParameterName: excludeGitData, ArgumentName: excludeGitData }, { @@ -13685,6 +14264,7 @@ Indicates whether the repository git data should be excluded from the migration. Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).
Default Value: false
Example: true, + ParameterName: excludeAttachments, ArgumentName: excludeAttachments }, { @@ -13703,6 +14283,7 @@ Indicates whether attachments should be excluded from the migration (to reduce m Indicates whether releases should be excluded from the migration (to reduce migration archive file size).
Default Value: false
Example: true, + ParameterName: excludeReleases, ArgumentName: excludeReleases }, { @@ -13721,6 +14302,7 @@ Indicates whether releases should be excluded from the migration (to reduce migr Indicates whether projects owned by the organization or users should be excluded. from the migration.
Default Value: false
Example: true, + ParameterName: excludeOwnerProjects, ArgumentName: excludeOwnerProjects }, { @@ -13739,6 +14321,7 @@ Indicates whether projects owned by the organization or users should be excluded Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).
Default Value: false
Example: true, + ParameterName: orgMetadataOnly, ArgumentName: orgMetadataOnly }, { @@ -13753,6 +14336,7 @@ Indicates whether this should only include organization metadata (repositories a }, IsRequired: false, Summary: Exclude related items from being returned in the response in order to improve performance of the request., + ParameterName: exclude, ArgumentName: exclude } ], @@ -13787,6 +14371,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13804,6 +14389,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: migrationId, ArgumentName: migrationId }, { @@ -13821,6 +14407,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: exclude, ArgumentName: exclude } ], @@ -13854,6 +14441,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13871,6 +14459,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: migrationId, ArgumentName: migrationId } ], @@ -13904,6 +14493,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13921,6 +14511,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: migrationId, ArgumentName: migrationId } ], @@ -13955,6 +14546,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -13972,6 +14564,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: migrationId, ArgumentName: migrationId }, { @@ -13989,6 +14582,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repoName, ArgumentName: repoName } ], @@ -14023,6 +14617,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14040,6 +14635,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: migrationId, ArgumentName: migrationId }, { @@ -14059,6 +14655,7 @@ Indicates whether this should only include organization metadata (repositories a DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -14078,6 +14675,7 @@ Indicates whether this should only include organization metadata (repositories a DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -14111,6 +14709,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -14144,6 +14743,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -14177,6 +14777,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14191,6 +14792,7 @@ Indicates whether this should only include organization metadata (repositories a }, IsRequired: true, Summary: The name of the custom role., + ParameterName: name, ArgumentName: name }, { @@ -14205,6 +14807,7 @@ Indicates whether this should only include organization metadata (repositories a }, IsRequired: false, Summary: A short description about the intended usage of this role or what permissions it grants., + ParameterName: description, ArgumentName: description }, { @@ -14219,6 +14822,7 @@ Indicates whether this should only include organization metadata (repositories a }, IsRequired: true, Summary: A list of additional permissions included in this role., + ParameterName: permissions, ArgumentName: permissions } ], @@ -14253,6 +14857,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14270,6 +14875,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug } ], @@ -14304,6 +14910,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14321,6 +14928,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -14338,6 +14946,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: roleId, ArgumentName: roleId } ], @@ -14372,6 +14981,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14389,6 +14999,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -14406,6 +15017,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: roleId, ArgumentName: roleId } ], @@ -14440,6 +15052,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14457,6 +15070,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -14491,6 +15105,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14508,6 +15123,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -14525,6 +15141,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: roleId, ArgumentName: roleId } ], @@ -14559,6 +15176,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14576,6 +15194,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -14593,6 +15212,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: roleId, ArgumentName: roleId } ], @@ -14627,6 +15247,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14644,6 +15265,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: roleId, ArgumentName: roleId } ], @@ -14677,6 +15299,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14694,6 +15317,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: roleId, ArgumentName: roleId }, { @@ -14708,6 +15332,7 @@ Indicates whether this should only include organization metadata (repositories a }, IsRequired: false, Summary: The name of the custom role., + ParameterName: name, ArgumentName: name }, { @@ -14722,6 +15347,7 @@ Indicates whether this should only include organization metadata (repositories a }, IsRequired: false, Summary: A short description about the intended usage of this role or what permissions it grants., + ParameterName: description, ArgumentName: description }, { @@ -14736,6 +15362,7 @@ Indicates whether this should only include organization metadata (repositories a }, IsRequired: false, Summary: A list of additional permissions included in this role., + ParameterName: permissions, ArgumentName: permissions } ], @@ -14770,6 +15397,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14787,6 +15415,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: roleId, ArgumentName: roleId } ], @@ -14821,6 +15450,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14838,6 +15468,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: roleId, ArgumentName: roleId }, { @@ -14857,6 +15488,7 @@ Indicates whether this should only include organization metadata (repositories a DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -14876,6 +15508,7 @@ Indicates whether this should only include organization metadata (repositories a DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -14909,6 +15542,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -14926,6 +15560,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: roleId, ArgumentName: roleId }, { @@ -14945,6 +15580,7 @@ Indicates whether this should only include organization metadata (repositories a DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -14964,6 +15600,7 @@ Indicates whether this should only include organization metadata (repositories a DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -14997,6 +15634,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -15022,6 +15660,7 @@ Indicates whether this should only include organization metadata (repositories a DefaultValue: Filter.All, Summary:
Default Value: all, + ParameterName: filter, ArgumentName: filter }, { @@ -15041,6 +15680,7 @@ Indicates whether this should only include organization metadata (repositories a DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -15060,6 +15700,7 @@ Indicates whether this should only include organization metadata (repositories a DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -15093,6 +15734,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -15110,6 +15752,7 @@ Indicates whether this should only include organization metadata (repositories a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -15127,6 +15770,7 @@ Indicates whether this should only include organization metadata (repositories a Summary: When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.
Default Value: false, + ParameterName: async, ArgumentName: async } ], @@ -15161,6 +15805,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -15178,6 +15823,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -15226,6 +15872,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -15243,6 +15890,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -15268,6 +15916,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: visibility, ArgumentName: visibility }, { @@ -15287,6 +15936,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -15306,6 +15956,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -15353,6 +16004,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -15370,6 +16022,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -15387,6 +16040,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -15434,6 +16088,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -15451,6 +16106,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -15468,6 +16124,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -15516,6 +16173,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -15533,6 +16191,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -15550,6 +16209,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -15567,6 +16227,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: token, ArgumentName: token } ], @@ -15615,6 +16276,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -15632,6 +16294,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -15649,6 +16312,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -15668,6 +16332,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -15687,6 +16352,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -15712,6 +16378,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: State.Active, Summary:
Default Value: active, + ParameterName: state, ArgumentName: state } ], @@ -15759,6 +16426,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -15776,6 +16444,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -15793,6 +16462,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -15810,6 +16480,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageVersionId, ArgumentName: packageVersionId } ], @@ -15857,6 +16528,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -15874,6 +16546,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -15891,6 +16564,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -15908,6 +16582,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageVersionId, ArgumentName: packageVersionId } ], @@ -15956,6 +16631,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -15973,6 +16649,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -15990,6 +16667,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -16007,6 +16685,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageVersionId, ArgumentName: packageVersionId } ], @@ -16041,6 +16720,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -16060,6 +16740,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -16079,6 +16760,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -16102,6 +16784,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: Sort.CreatedAt, Summary:
Default Value: created_at, + ParameterName: sort, ArgumentName: sort }, { @@ -16127,6 +16810,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -16145,6 +16829,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterExplode: true, Summary:
Example: owner[]=octocat1,owner[]=octocat2, + ParameterName: owner, ArgumentName: owner }, { @@ -16163,6 +16848,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterExplode: true, Summary:
Example: Hello-World, + ParameterName: repository, ArgumentName: repository }, { @@ -16181,6 +16867,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterExplode: true, Summary:
Example: issues_read, + ParameterName: permission, ArgumentName: permission }, { @@ -16198,6 +16885,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: lastUsedBefore, ArgumentName: lastUsedBefore }, { @@ -16215,6 +16903,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: lastUsedAfter, ArgumentName: lastUsedAfter } ], @@ -16248,6 +16937,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -16262,6 +16952,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 }, IsRequired: false, Summary: Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values., + ParameterName: patRequestIds, ArgumentName: patRequestIds }, { @@ -16282,6 +16973,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 }, IsRequired: true, Summary: Action to apply to the requests., + ParameterName: action, ArgumentName: action }, { @@ -16296,6 +16988,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 }, IsRequired: false, Summary: Reason for approving or denying the requests. Max 1024 characters., + ParameterName: reason, ArgumentName: reason } ], @@ -16330,6 +17023,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -16347,6 +17041,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: patRequestId, ArgumentName: patRequestId }, { @@ -16367,6 +17062,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 }, IsRequired: true, Summary: Action to apply to the request., + ParameterName: action, ArgumentName: action }, { @@ -16381,6 +17077,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 }, IsRequired: false, Summary: Reason for approving or denying the request. Max 1024 characters., + ParameterName: reason, ArgumentName: reason } ], @@ -16415,6 +17112,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -16432,6 +17130,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: patRequestId, ArgumentName: patRequestId }, { @@ -16451,6 +17150,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -16470,6 +17170,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -16503,6 +17204,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -16522,6 +17224,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -16541,6 +17244,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -16564,6 +17268,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: Sort.CreatedAt, Summary:
Default Value: created_at, + ParameterName: sort, ArgumentName: sort }, { @@ -16589,6 +17294,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -16607,6 +17313,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterExplode: true, Summary:
Example: owner[]=octocat1,owner[]=octocat2, + ParameterName: owner, ArgumentName: owner }, { @@ -16625,6 +17332,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterExplode: true, Summary:
Example: Hello-World, + ParameterName: repository, ArgumentName: repository }, { @@ -16643,6 +17351,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterExplode: true, Summary:
Example: issues_read, + ParameterName: permission, ArgumentName: permission }, { @@ -16660,6 +17369,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: lastUsedBefore, ArgumentName: lastUsedBefore }, { @@ -16677,6 +17387,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: lastUsedAfter, ArgumentName: lastUsedAfter } ], @@ -16710,6 +17421,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -16728,6 +17440,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 }, IsRequired: true, Summary: Action to apply to the fine-grained personal access token., + ParameterName: action, ArgumentName: action }, { @@ -16742,6 +17455,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 }, IsRequired: true, Summary: The IDs of the fine-grained personal access tokens., + ParameterName: patIds, ArgumentName: patIds } ], @@ -16776,6 +17490,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -16793,6 +17508,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: patId, ArgumentName: patId }, { @@ -16811,6 +17527,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 }, IsRequired: true, Summary: Action to apply to the fine-grained personal access token., + ParameterName: action, ArgumentName: action } ], @@ -16845,6 +17562,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -16862,6 +17580,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: patId, ArgumentName: patId }, { @@ -16881,6 +17600,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -16900,6 +17620,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -16933,6 +17654,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -16960,6 +17682,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: State.Open, Summary:
Default Value: open, + ParameterName: state, ArgumentName: state }, { @@ -16979,6 +17702,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -16998,6 +17722,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -17031,6 +17756,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17045,6 +17771,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 }, IsRequired: true, Summary: The name of the project., + ParameterName: name, ArgumentName: name }, { @@ -17059,6 +17786,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 }, IsRequired: false, Summary: The description of the project., + ParameterName: body, ArgumentName: body } ], @@ -17093,6 +17821,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -17126,6 +17855,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17140,6 +17870,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 }, IsRequired: true, Summary: The array of custom properties to create or update., + ParameterName: properties, ArgumentName: properties } ], @@ -17174,6 +17905,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17191,6 +17923,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: customPropertyName, ArgumentName: customPropertyName } ], @@ -17224,6 +17957,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17241,6 +17975,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: customPropertyName, ArgumentName: customPropertyName }, { @@ -17263,6 +17998,7 @@ When set to `true`, the request will be performed asynchronously. Returns a 202 Summary: The type of the value for the property
Example: single_select, + ParameterName: valueType, ArgumentName: valueType }, { @@ -17277,6 +18013,7 @@ The type of the value for the property }, IsRequired: false, Summary: Whether the property is required., + ParameterName: required, ArgumentName: required }, { @@ -17292,6 +18029,7 @@ The type of the value for the property IsRequired: false, DefaultValue: , Summary: Default value of the property, + ParameterName: defaultValue, ArgumentName: defaultValue }, { @@ -17306,6 +18044,7 @@ The type of the value for the property }, IsRequired: false, Summary: Short description of the property, + ParameterName: description, ArgumentName: description }, { @@ -17322,6 +18061,7 @@ The type of the value for the property Summary: An ordered list of the allowed values of the property. The property can have up to 200 allowed values., + ParameterName: allowedValues, ArgumentName: allowedValues } ], @@ -17356,6 +18096,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17373,6 +18114,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: customPropertyName, ArgumentName: customPropertyName } ], @@ -17407,6 +18149,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17426,6 +18169,7 @@ The property can have up to 200 allowed values., DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -17445,6 +18189,7 @@ The property can have up to 200 allowed values., DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -17462,6 +18207,7 @@ The property can have up to 200 allowed values., ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: repositoryQuery, ArgumentName: repositoryQuery } ], @@ -17495,6 +18241,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17509,6 +18256,7 @@ The property can have up to 200 allowed values., }, IsRequired: true, Summary: The names of repositories that the custom property values will be applied to., + ParameterName: repositoryNames, ArgumentName: repositoryNames }, { @@ -17523,6 +18271,7 @@ The property can have up to 200 allowed values., }, IsRequired: true, Summary: List of custom property names and associated values to apply to the repositories., + ParameterName: properties, ArgumentName: properties } ], @@ -17557,6 +18306,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17576,6 +18326,7 @@ The property can have up to 200 allowed values., DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -17595,6 +18346,7 @@ The property can have up to 200 allowed values., DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -17628,6 +18380,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17645,6 +18398,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -17678,6 +18432,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17695,6 +18450,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -17729,6 +18485,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17746,6 +18503,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -17780,6 +18538,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17813,6 +18572,7 @@ The property can have up to 200 allowed values., DefaultValue: Type.All, Summary:
Default Value: all, + ParameterName: type, ArgumentName: type }, { @@ -17842,6 +18602,7 @@ The property can have up to 200 allowed values., DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -17865,6 +18626,7 @@ The property can have up to 200 allowed values., ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: direction, ArgumentName: direction }, { @@ -17884,6 +18646,7 @@ The property can have up to 200 allowed values., DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -17903,6 +18666,7 @@ The property can have up to 200 allowed values., DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -17936,6 +18700,7 @@ The property can have up to 200 allowed values., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -17950,6 +18715,7 @@ The property can have up to 200 allowed values., }, IsRequired: true, Summary: The name of the repository., + ParameterName: name, ArgumentName: name }, { @@ -17964,6 +18730,7 @@ The property can have up to 200 allowed values., }, IsRequired: false, Summary: A short description of the repository., + ParameterName: description, ArgumentName: description }, { @@ -17978,6 +18745,7 @@ The property can have up to 200 allowed values., }, IsRequired: false, Summary: A URL with more information about the repository., + ParameterName: homepage, ArgumentName: homepage }, { @@ -17995,6 +18763,7 @@ The property can have up to 200 allowed values., Summary: Whether the repository is private.
Default Value: false, + ParameterName: private, ArgumentName: private }, { @@ -18015,6 +18784,7 @@ Whether the repository is private. }, IsRequired: false, Summary: The visibility of the repository., + ParameterName: visibility, ArgumentName: visibility }, { @@ -18032,6 +18802,7 @@ Whether the repository is private. Summary: Either `true` to enable issues for this repository or `false` to disable them.
Default Value: true, + ParameterName: hasIssues, ArgumentName: hasIssues }, { @@ -18049,6 +18820,7 @@ Either `true` to enable issues for this repository or `false` to disable them. Summary: Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.
Default Value: true, + ParameterName: hasProjects, ArgumentName: hasProjects }, { @@ -18066,6 +18838,7 @@ Either `true` to enable projects for this repository or `false` to disable them. Summary: Either `true` to enable the wiki for this repository or `false` to disable it.
Default Value: true, + ParameterName: hasWiki, ArgumentName: hasWiki }, { @@ -18084,6 +18857,7 @@ Either `true` to enable the wiki for this repository or `false` to disable it. Whether downloads are enabled.
Default Value: true
Example: true, + ParameterName: hasDownloads, ArgumentName: hasDownloads }, { @@ -18101,6 +18875,7 @@ Whether downloads are enabled. Summary: Either `true` to make this repo available as a template repository or `false` to prevent it.
Default Value: false, + ParameterName: isTemplate, ArgumentName: isTemplate }, { @@ -18115,6 +18890,7 @@ Either `true` to make this repo available as a template repository or `false` to }, IsRequired: false, Summary: The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization., + ParameterName: teamId, ArgumentName: teamId }, { @@ -18132,6 +18908,7 @@ Either `true` to make this repo available as a template repository or `false` to Summary: Pass `true` to create an initial commit with empty README.
Default Value: false, + ParameterName: autoInit, ArgumentName: autoInit }, { @@ -18146,6 +18923,7 @@ Pass `true` to create an initial commit with empty README. }, IsRequired: false, Summary: Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell"., + ParameterName: gitignoreTemplate, ArgumentName: gitignoreTemplate }, { @@ -18160,6 +18938,7 @@ Pass `true` to create an initial commit with empty README. }, IsRequired: false, Summary: Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0"., + ParameterName: licenseTemplate, ArgumentName: licenseTemplate }, { @@ -18177,6 +18956,7 @@ Pass `true` to create an initial commit with empty README. Summary: Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.
Default Value: true, + ParameterName: allowSquashMerge, ArgumentName: allowSquashMerge }, { @@ -18194,6 +18974,7 @@ Either `true` to allow squash-merging pull requests, or `false` to prevent squas Summary: Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.
Default Value: true, + ParameterName: allowMergeCommit, ArgumentName: allowMergeCommit }, { @@ -18211,6 +18992,7 @@ Either `true` to allow merging pull requests with a merge commit, or `false` to Summary: Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.
Default Value: true, + ParameterName: allowRebaseMerge, ArgumentName: allowRebaseMerge }, { @@ -18228,6 +19010,7 @@ Either `true` to allow rebase-merging pull requests, or `false` to prevent rebas Summary: Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.
Default Value: false, + ParameterName: allowAutoMerge, ArgumentName: allowAutoMerge }, { @@ -18245,6 +19028,7 @@ Either `true` to allow auto-merge on pull requests, or `false` to disallow auto- Summary: Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.**
Default Value: false, + ParameterName: deleteBranchOnMerge, ArgumentName: deleteBranchOnMerge }, { @@ -18262,6 +19046,7 @@ Either `true` to allow automatically deleting head branches when pull requests a Summary: Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
Default Value: false, + ParameterName: useSquashPrTitleAsDefault, ArgumentName: useSquashPrTitleAsDefault }, { @@ -18286,6 +19071,7 @@ The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)., + ParameterName: squashMergeCommitTitle, ArgumentName: squashMergeCommitTitle }, { @@ -18313,6 +19099,7 @@ The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message., + ParameterName: squashMergeCommitMessage, ArgumentName: squashMergeCommitMessage }, { @@ -18337,6 +19124,7 @@ The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)., + ParameterName: mergeCommitTitle, ArgumentName: mergeCommitTitle }, { @@ -18364,6 +19152,7 @@ The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message., + ParameterName: mergeCommitMessage, ArgumentName: mergeCommitMessage }, { @@ -18378,6 +19167,7 @@ The default value for a merge commit message. }, IsRequired: false, Summary: The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values., + ParameterName: customProperties, ArgumentName: customProperties } ], @@ -18412,6 +19202,7 @@ The default value for a merge commit message. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -18431,6 +19222,7 @@ The default value for a merge commit message. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -18450,6 +19242,7 @@ The default value for a merge commit message. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -18483,6 +19276,7 @@ The default value for a merge commit message. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -18497,6 +19291,7 @@ The default value for a merge commit message. }, IsRequired: true, Summary: The name of the ruleset., + ParameterName: name, ArgumentName: name }, { @@ -18522,6 +19317,7 @@ The default value for a merge commit message. The target of the ruleset **Note**: The `push` target is in beta and is subject to change., + ParameterName: target, ArgumentName: target }, { @@ -18544,6 +19340,7 @@ The target of the ruleset }, IsRequired: true, Summary: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise)., + ParameterName: enforcement, ArgumentName: enforcement }, { @@ -18558,6 +19355,7 @@ The target of the ruleset }, IsRequired: false, Summary: The actors that can bypass the rules in this ruleset, + ParameterName: bypassActors, ArgumentName: bypassActors }, { @@ -18574,6 +19372,7 @@ The target of the ruleset Summary: Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. , + ParameterName: conditions, ArgumentName: conditions }, { @@ -18588,6 +19387,7 @@ Conditions for an organization ruleset. The conditions object should contain bot }, IsRequired: false, Summary: An array of rules within the ruleset., + ParameterName: rules, ArgumentName: rules } ], @@ -18622,6 +19422,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -18639,6 +19440,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: repositoryName, ArgumentName: repositoryName }, { @@ -18668,6 +19470,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: TimePeriod.Day, Summary:
Default Value: day, + ParameterName: timePeriod, ArgumentName: timePeriod }, { @@ -18685,6 +19488,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: actorName, ArgumentName: actorName }, { @@ -18714,6 +19518,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: RuleSuiteResult.All, Summary:
Default Value: all, + ParameterName: ruleSuiteResult, ArgumentName: ruleSuiteResult }, { @@ -18733,6 +19538,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -18752,6 +19558,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -18785,6 +19592,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -18802,6 +19610,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ruleSuiteId, ArgumentName: ruleSuiteId } ], @@ -18835,6 +19644,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -18852,6 +19662,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: rulesetId, ArgumentName: rulesetId } ], @@ -18885,6 +19696,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -18902,6 +19714,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: rulesetId, ArgumentName: rulesetId }, { @@ -18916,6 +19729,7 @@ Conditions for an organization ruleset. The conditions object should contain bot }, IsRequired: false, Summary: The name of the ruleset., + ParameterName: name, ArgumentName: name }, { @@ -18941,6 +19755,7 @@ Conditions for an organization ruleset. The conditions object should contain bot The target of the ruleset **Note**: The `push` target is in beta and is subject to change., + ParameterName: target, ArgumentName: target }, { @@ -18963,6 +19778,7 @@ The target of the ruleset }, IsRequired: false, Summary: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise)., + ParameterName: enforcement, ArgumentName: enforcement }, { @@ -18977,6 +19793,7 @@ The target of the ruleset }, IsRequired: false, Summary: The actors that can bypass the rules in this ruleset, + ParameterName: bypassActors, ArgumentName: bypassActors }, { @@ -18993,6 +19810,7 @@ The target of the ruleset Summary: Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. , + ParameterName: conditions, ArgumentName: conditions }, { @@ -19007,6 +19825,7 @@ Conditions for an organization ruleset. The conditions object should contain bot }, IsRequired: false, Summary: An array of rules within the ruleset., + ParameterName: rules, ArgumentName: rules } ], @@ -19041,6 +19860,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -19058,6 +19878,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: rulesetId, ArgumentName: rulesetId } ], @@ -19092,6 +19913,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -19115,6 +19937,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: state, ArgumentName: state }, { @@ -19132,6 +19955,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: secretType, ArgumentName: secretType }, { @@ -19149,6 +19973,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: resolution, ArgumentName: resolution }, { @@ -19174,6 +19999,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -19199,6 +20025,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -19218,6 +20045,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -19237,6 +20065,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -19254,6 +20083,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -19271,6 +20101,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -19288,6 +20119,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: validity, ArgumentName: validity } ], @@ -19321,6 +20153,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -19346,6 +20179,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -19373,6 +20207,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -19390,6 +20225,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -19407,6 +20243,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -19426,6 +20263,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -19453,6 +20291,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: state, ArgumentName: state } ], @@ -19486,6 +20325,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -19519,6 +20359,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -19536,6 +20377,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug } ], @@ -19570,6 +20412,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -19587,6 +20430,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug } ], @@ -19621,6 +20465,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -19654,6 +20499,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -19687,6 +20533,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -19720,6 +20567,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -19739,6 +20587,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -19758,6 +20607,7 @@ Conditions for an organization ruleset. The conditions object should contain bot DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -19791,6 +20641,7 @@ Conditions for an organization ruleset. The conditions object should contain bot ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -19805,6 +20656,7 @@ Conditions for an organization ruleset. The conditions object should contain bot }, IsRequired: true, Summary: The name of the team., + ParameterName: name, ArgumentName: name }, { @@ -19819,6 +20671,7 @@ Conditions for an organization ruleset. The conditions object should contain bot }, IsRequired: false, Summary: The description of the team., + ParameterName: description, ArgumentName: description }, { @@ -19833,6 +20686,7 @@ Conditions for an organization ruleset. The conditions object should contain bot }, IsRequired: false, Summary: List GitHub IDs for organization members who will become team maintainers., + ParameterName: maintainers, ArgumentName: maintainers }, { @@ -19847,6 +20701,7 @@ Conditions for an organization ruleset. The conditions object should contain bot }, IsRequired: false, Summary: The full name (e.g., "organization-name/repository-name") of repositories to add the team to., + ParameterName: repoNames, ArgumentName: repoNames }, { @@ -19875,6 +20730,7 @@ Default: `secret` **For a parent or child team:** * `closed` - visible to all members of this organization. Default for child team: `closed`, + ParameterName: privacy, ArgumentName: privacy }, { @@ -19899,6 +20755,7 @@ The notification setting the team has chosen. The options are: * `notifications_enabled` - team members receive notifications when the team is @mentioned. * `notifications_disabled` - no one receives notifications. Default: `notifications_enabled`, + ParameterName: notificationSetting, ArgumentName: notificationSetting }, { @@ -19922,6 +20779,7 @@ Default: `notifications_enabled`, Summary: **Deprecated**. The permission that new repositories will be added to the team with when none is specified.
Default Value: pull, + ParameterName: permission, ArgumentName: permission }, { @@ -19936,6 +20794,7 @@ Default: `notifications_enabled`, }, IsRequired: false, Summary: The ID of a team to set as the parent team., + ParameterName: parentTeamId, ArgumentName: parentTeamId } ], @@ -19970,6 +20829,7 @@ Default: `notifications_enabled`, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -19987,6 +20847,7 @@ Default: `notifications_enabled`, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug } ], @@ -20020,6 +20881,7 @@ Default: `notifications_enabled`, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -20037,6 +20899,7 @@ Default: `notifications_enabled`, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -20051,6 +20914,7 @@ Default: `notifications_enabled`, }, IsRequired: false, Summary: The name of the team., + ParameterName: name, ArgumentName: name }, { @@ -20065,6 +20929,7 @@ Default: `notifications_enabled`, }, IsRequired: false, Summary: The description of the team., + ParameterName: description, ArgumentName: description }, { @@ -20091,6 +20956,7 @@ The level of privacy this team should have. Editing teams without specifying thi * `closed` - visible to all members of this organization. **For a parent or child team:** * `closed` - visible to all members of this organization., + ParameterName: privacy, ArgumentName: privacy }, { @@ -20114,6 +20980,7 @@ The level of privacy this team should have. Editing teams without specifying thi The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: * `notifications_enabled` - team members receive notifications when the team is @mentioned. * `notifications_disabled` - no one receives notifications., + ParameterName: notificationSetting, ArgumentName: notificationSetting }, { @@ -20139,6 +21006,7 @@ The notification setting the team has chosen. Editing teams without specifying t Summary: **Deprecated**. The permission that new repositories will be added to the team with when none is specified.
Default Value: pull, + ParameterName: permission, ArgumentName: permission }, { @@ -20153,6 +21021,7 @@ The notification setting the team has chosen. Editing teams without specifying t }, IsRequired: false, Summary: The ID of a team to set as the parent team., + ParameterName: parentTeamId, ArgumentName: parentTeamId } ], @@ -20187,6 +21056,7 @@ The notification setting the team has chosen. Editing teams without specifying t ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -20204,6 +21074,7 @@ The notification setting the team has chosen. Editing teams without specifying t ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug } ], @@ -20238,6 +21109,7 @@ The notification setting the team has chosen. Editing teams without specifying t ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -20255,6 +21127,7 @@ The notification setting the team has chosen. Editing teams without specifying t ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -20280,6 +21153,7 @@ The notification setting the team has chosen. Editing teams without specifying t DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -20299,6 +21173,7 @@ The notification setting the team has chosen. Editing teams without specifying t DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -20318,6 +21193,7 @@ The notification setting the team has chosen. Editing teams without specifying t DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -20335,6 +21211,7 @@ The notification setting the team has chosen. Editing teams without specifying t ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: pinned, ArgumentName: pinned } ], @@ -20368,6 +21245,7 @@ The notification setting the team has chosen. Editing teams without specifying t ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -20385,6 +21263,7 @@ The notification setting the team has chosen. Editing teams without specifying t ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -20399,6 +21278,7 @@ The notification setting the team has chosen. Editing teams without specifying t }, IsRequired: true, Summary: The discussion post's title., + ParameterName: title, ArgumentName: title }, { @@ -20413,6 +21293,7 @@ The notification setting the team has chosen. Editing teams without specifying t }, IsRequired: true, Summary: The discussion post's body text., + ParameterName: body, ArgumentName: body }, { @@ -20430,6 +21311,7 @@ The notification setting the team has chosen. Editing teams without specifying t Summary: Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.
Default Value: false, + ParameterName: private, ArgumentName: private } ], @@ -20464,6 +21346,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -20481,6 +21364,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -20498,6 +21382,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber } ], @@ -20531,6 +21416,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -20548,6 +21434,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -20565,6 +21452,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -20579,6 +21467,7 @@ Private posts are only visible to team members, organization owners, and team ma }, IsRequired: false, Summary: The discussion post's title., + ParameterName: title, ArgumentName: title }, { @@ -20593,6 +21482,7 @@ Private posts are only visible to team members, organization owners, and team ma }, IsRequired: false, Summary: The discussion post's body text., + ParameterName: body, ArgumentName: body } ], @@ -20627,6 +21517,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -20644,6 +21535,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -20661,6 +21553,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber } ], @@ -20695,6 +21588,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -20712,6 +21606,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -20729,6 +21624,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -20754,6 +21650,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -20773,6 +21670,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -20792,6 +21690,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -20825,6 +21724,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -20842,6 +21742,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -20859,6 +21760,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -20873,6 +21775,7 @@ Private posts are only visible to team members, organization owners, and team ma }, IsRequired: true, Summary: The discussion comment's body text., + ParameterName: body, ArgumentName: body } ], @@ -20907,6 +21810,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -20924,6 +21828,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -20941,6 +21846,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -20958,6 +21864,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentNumber, ArgumentName: commentNumber } ], @@ -20991,6 +21898,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -21008,6 +21916,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -21025,6 +21934,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -21042,6 +21952,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentNumber, ArgumentName: commentNumber }, { @@ -21056,6 +21967,7 @@ Private posts are only visible to team members, organization owners, and team ma }, IsRequired: true, Summary: The discussion comment's body text., + ParameterName: body, ArgumentName: body } ], @@ -21090,6 +22002,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -21107,6 +22020,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -21124,6 +22038,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -21141,6 +22056,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentNumber, ArgumentName: commentNumber } ], @@ -21175,6 +22091,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -21192,6 +22109,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -21209,6 +22127,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -21226,6 +22145,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentNumber, ArgumentName: commentNumber }, { @@ -21261,6 +22181,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -21280,6 +22201,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -21299,6 +22221,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -21332,6 +22255,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -21349,6 +22273,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -21366,6 +22291,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -21383,6 +22309,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentNumber, ArgumentName: commentNumber }, { @@ -21415,6 +22342,7 @@ Private posts are only visible to team members, organization owners, and team ma }, IsRequired: true, Summary: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment., + ParameterName: content, ArgumentName: content } ], @@ -21449,6 +22377,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -21466,6 +22395,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -21483,6 +22413,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -21500,6 +22431,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentNumber, ArgumentName: commentNumber }, { @@ -21517,6 +22449,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reactionId, ArgumentName: reactionId } ], @@ -21551,6 +22484,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -21568,6 +22502,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -21585,6 +22520,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -21620,6 +22556,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -21639,6 +22576,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -21658,6 +22596,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -21691,6 +22630,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -21708,6 +22648,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -21725,6 +22666,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -21757,6 +22699,7 @@ Private posts are only visible to team members, organization owners, and team ma }, IsRequired: true, Summary: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion., + ParameterName: content, ArgumentName: content } ], @@ -21791,6 +22734,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -21808,6 +22752,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -21825,6 +22770,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -21842,6 +22788,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reactionId, ArgumentName: reactionId } ], @@ -21876,6 +22823,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -21893,6 +22841,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -21912,6 +22861,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -21931,6 +22881,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -21964,6 +22915,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -21981,6 +22933,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -22008,6 +22961,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: Role.All, Summary:
Default Value: all, + ParameterName: role, ArgumentName: role }, { @@ -22027,6 +22981,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -22046,6 +23001,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -22079,6 +23035,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -22096,6 +23053,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -22113,6 +23071,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -22146,6 +23105,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -22163,6 +23123,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -22180,6 +23141,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -22203,6 +23165,7 @@ Private posts are only visible to team members, organization owners, and team ma Summary: The role that this user should have in the team.
Default Value: member, + ParameterName: role, ArgumentName: role } ], @@ -22237,6 +23200,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -22254,6 +23218,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -22271,6 +23236,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -22305,6 +23271,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -22322,6 +23289,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -22341,6 +23309,7 @@ The role that this user should have in the team. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -22360,6 +23329,7 @@ The role that this user should have in the team. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -22393,6 +23363,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -22410,6 +23381,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -22427,6 +23399,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId } ], @@ -22460,6 +23433,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -22477,6 +23451,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -22494,6 +23469,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId }, { @@ -22516,6 +23492,7 @@ The role that this user should have in the team. }, IsRequired: false, Summary: The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).", + ParameterName: permission, ArgumentName: permission } ], @@ -22550,6 +23527,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -22567,6 +23545,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -22584,6 +23563,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId } ], @@ -22618,6 +23598,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -22635,6 +23616,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -22654,6 +23636,7 @@ The role that this user should have in the team. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -22673,6 +23656,7 @@ The role that this user should have in the team. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -22706,6 +23690,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -22723,6 +23708,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -22740,6 +23726,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -22757,6 +23744,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -22790,6 +23778,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -22807,6 +23796,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -22824,6 +23814,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -22841,6 +23832,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -22858,6 +23850,7 @@ The role that this user should have in the team. Summary: The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.
Default Value: push, + ParameterName: permission, ArgumentName: permission } ], @@ -22892,6 +23885,7 @@ The permission to grant the team on this repository. We accept the following per ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -22909,6 +23903,7 @@ The permission to grant the team on this repository. We accept the following per ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -22926,6 +23921,7 @@ The permission to grant the team on this repository. We accept the following per ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -22943,6 +23939,7 @@ The permission to grant the team on this repository. We accept the following per ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -22977,6 +23974,7 @@ The permission to grant the team on this repository. We accept the following per ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -22994,6 +23992,7 @@ The permission to grant the team on this repository. We accept the following per ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamSlug, ArgumentName: teamSlug }, { @@ -23013,6 +24012,7 @@ The permission to grant the team on this repository. We accept the following per DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -23032,6 +24032,7 @@ The permission to grant the team on this repository. We accept the following per DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -23065,6 +24066,7 @@ The permission to grant the team on this repository. We accept the following per ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -23098,6 +24100,7 @@ The permission to grant the team on this repository. We accept the following per ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: securityProduct, ArgumentName: securityProduct }, { @@ -23121,6 +24124,7 @@ The permission to grant the team on this repository. We accept the following per ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: enablement, ArgumentName: enablement }, { @@ -23143,6 +24147,7 @@ The permission to grant the team on this repository. We accept the following per Summary: CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured. If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied., + ParameterName: querySuite, ArgumentName: querySuite } ], @@ -23177,6 +24182,7 @@ If you don't specify any `query_suite` in your request, the preferred query suit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: cardId, ArgumentName: cardId } ], @@ -23210,6 +24216,7 @@ If you don't specify any `query_suite` in your request, the preferred query suit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: cardId, ArgumentName: cardId }, { @@ -23226,6 +24233,7 @@ If you don't specify any `query_suite` in your request, the preferred query suit Summary: The project card's note
Example: Update all gems, + ParameterName: note, ArgumentName: note }, { @@ -23242,6 +24250,7 @@ The project card's note Summary: Whether or not the card is archived
Example: false, + ParameterName: archived, ArgumentName: archived } ], @@ -23276,6 +24285,7 @@ Whether or not the card is archived ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: cardId, ArgumentName: cardId } ], @@ -23310,6 +24320,7 @@ Whether or not the card is archived ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: cardId, ArgumentName: cardId }, { @@ -23326,6 +24337,7 @@ Whether or not the card is archived Summary: The position of the card in a column. Can be one of: `top`, `bottom`, or `after:<card_id>` to place after the specified card.
Example: bottom, + ParameterName: position, ArgumentName: position }, { @@ -23342,6 +24354,7 @@ The position of the card in a column. Can be one of: `top`, `bottom`, or `after: Summary: The unique identifier of the column the card should be moved to
Example: 42, + ParameterName: columnId, ArgumentName: columnId } ], @@ -23376,6 +24389,7 @@ The unique identifier of the column the card should be moved to ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: columnId, ArgumentName: columnId } ], @@ -23409,6 +24423,7 @@ The unique identifier of the column the card should be moved to ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: columnId, ArgumentName: columnId }, { @@ -23425,6 +24440,7 @@ The unique identifier of the column the card should be moved to Summary: Name of the project column
Example: Remaining tasks, + ParameterName: name, ArgumentName: name } ], @@ -23459,6 +24475,7 @@ Name of the project column ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: columnId, ArgumentName: columnId } ], @@ -23493,6 +24510,7 @@ Name of the project column ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: columnId, ArgumentName: columnId }, { @@ -23520,6 +24538,7 @@ Name of the project column DefaultValue: ArchivedState.NotArchived, Summary:
Default Value: not_archived, + ParameterName: archivedState, ArgumentName: archivedState }, { @@ -23539,6 +24558,7 @@ Name of the project column DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -23558,6 +24578,7 @@ Name of the project column DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -23591,6 +24612,7 @@ Name of the project column ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: columnId, ArgumentName: columnId } ], @@ -23625,6 +24647,7 @@ Name of the project column ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: columnId, ArgumentName: columnId }, { @@ -23641,6 +24664,7 @@ Name of the project column Summary: The position of the column in a project. Can be one of: `first`, `last`, or `after:<column_id>` to place after the specified column.
Example: last, + ParameterName: position, ArgumentName: position } ], @@ -23675,6 +24699,7 @@ The position of the column in a project. Can be one of: `first`, `last`, or `aft ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId } ], @@ -23708,6 +24733,7 @@ The position of the column in a project. Can be one of: `first`, `last`, or `aft ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId }, { @@ -23724,6 +24750,7 @@ The position of the column in a project. Can be one of: `first`, `last`, or `aft Summary: Name of the project
Example: Week One Sprint, + ParameterName: name, ArgumentName: name }, { @@ -23740,6 +24767,7 @@ Name of the project Summary: Body of the project
Example: This project represents the sprint of the first week in January, + ParameterName: body, ArgumentName: body }, { @@ -23756,6 +24784,7 @@ Body of the project Summary: State of the project; either 'open' or 'closed'
Example: open, + ParameterName: state, ArgumentName: state }, { @@ -23780,6 +24809,7 @@ State of the project; either 'open' or 'closed' }, IsRequired: false, Summary: The baseline permission that all organization members have on this project, + ParameterName: organizationPermission, ArgumentName: organizationPermission }, { @@ -23794,6 +24824,7 @@ State of the project; either 'open' or 'closed' }, IsRequired: false, Summary: Whether or not this project can be seen by everyone., + ParameterName: private, ArgumentName: private } ], @@ -23828,6 +24859,7 @@ State of the project; either 'open' or 'closed' ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId } ], @@ -23862,6 +24894,7 @@ State of the project; either 'open' or 'closed' ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId }, { @@ -23889,6 +24922,7 @@ State of the project; either 'open' or 'closed' DefaultValue: Affiliation.All, Summary:
Default Value: all, + ParameterName: affiliation, ArgumentName: affiliation }, { @@ -23908,6 +24942,7 @@ State of the project; either 'open' or 'closed' DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -23927,6 +24962,7 @@ State of the project; either 'open' or 'closed' DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -23960,6 +24996,7 @@ State of the project; either 'open' or 'closed' ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId }, { @@ -23977,6 +25014,7 @@ State of the project; either 'open' or 'closed' ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -24003,6 +25041,7 @@ State of the project; either 'open' or 'closed' The permission to grant the collaborator.
Default Value: write
Example: write, + ParameterName: permission, ArgumentName: permission } ], @@ -24037,6 +25076,7 @@ The permission to grant the collaborator. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId }, { @@ -24054,6 +25094,7 @@ The permission to grant the collaborator. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -24088,6 +25129,7 @@ The permission to grant the collaborator. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId }, { @@ -24105,6 +25147,7 @@ The permission to grant the collaborator. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -24138,6 +25181,7 @@ The permission to grant the collaborator. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId }, { @@ -24157,6 +25201,7 @@ The permission to grant the collaborator. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -24176,6 +25221,7 @@ The permission to grant the collaborator. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -24209,6 +25255,7 @@ The permission to grant the collaborator. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId }, { @@ -24225,6 +25272,7 @@ The permission to grant the collaborator. Summary: Name of the project column
Example: Remaining tasks, + ParameterName: name, ArgumentName: name } ], @@ -24274,6 +25322,7 @@ Name of the project column ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -24291,6 +25340,7 @@ Name of the project column ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -24324,6 +25374,7 @@ Name of the project column ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -24341,6 +25392,7 @@ Name of the project column ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -24355,6 +25407,7 @@ Name of the project column }, IsRequired: false, Summary: The name of the repository., + ParameterName: name, ArgumentName: name }, { @@ -24369,6 +25422,7 @@ Name of the project column }, IsRequired: false, Summary: A short description of the repository., + ParameterName: description, ArgumentName: description }, { @@ -24383,6 +25437,7 @@ Name of the project column }, IsRequired: false, Summary: A URL with more information about the repository., + ParameterName: homepage, ArgumentName: homepage }, { @@ -24401,6 +25456,7 @@ Name of the project column Either `true` to make the repository private or `false` to make it public. Default: `false`. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.
Default Value: false, + ParameterName: private, ArgumentName: private }, { @@ -24421,6 +25477,7 @@ Either `true` to make the repository private or `false` to make it public. Defau }, IsRequired: false, Summary: The visibility of the repository., + ParameterName: visibility, ArgumentName: visibility }, { @@ -24443,6 +25500,7 @@ For example, to enable GitHub Advanced Security, use this data in the body of th `{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`. You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request., + ParameterName: securityAndAnalysis, ArgumentName: securityAndAnalysis }, { @@ -24460,6 +25518,7 @@ You can check which security and analysis features are currently enabled by usin Summary: Either `true` to enable issues for this repository or `false` to disable them.
Default Value: true, + ParameterName: hasIssues, ArgumentName: hasIssues }, { @@ -24477,6 +25536,7 @@ Either `true` to enable issues for this repository or `false` to disable them. Summary: Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.
Default Value: true, + ParameterName: hasProjects, ArgumentName: hasProjects }, { @@ -24494,6 +25554,7 @@ Either `true` to enable projects for this repository or `false` to disable them. Summary: Either `true` to enable the wiki for this repository or `false` to disable it.
Default Value: true, + ParameterName: hasWiki, ArgumentName: hasWiki }, { @@ -24511,6 +25572,7 @@ Either `true` to enable the wiki for this repository or `false` to disable it. Summary: Either `true` to make this repo available as a template repository or `false` to prevent it.
Default Value: false, + ParameterName: isTemplate, ArgumentName: isTemplate }, { @@ -24525,6 +25587,7 @@ Either `true` to make this repo available as a template repository or `false` to }, IsRequired: false, Summary: Updates the default branch for this repository., + ParameterName: defaultBranch, ArgumentName: defaultBranch }, { @@ -24542,6 +25605,7 @@ Either `true` to make this repo available as a template repository or `false` to Summary: Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.
Default Value: true, + ParameterName: allowSquashMerge, ArgumentName: allowSquashMerge }, { @@ -24559,6 +25623,7 @@ Either `true` to allow squash-merging pull requests, or `false` to prevent squas Summary: Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.
Default Value: true, + ParameterName: allowMergeCommit, ArgumentName: allowMergeCommit }, { @@ -24576,6 +25641,7 @@ Either `true` to allow merging pull requests with a merge commit, or `false` to Summary: Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.
Default Value: true, + ParameterName: allowRebaseMerge, ArgumentName: allowRebaseMerge }, { @@ -24593,6 +25659,7 @@ Either `true` to allow rebase-merging pull requests, or `false` to prevent rebas Summary: Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.
Default Value: false, + ParameterName: allowAutoMerge, ArgumentName: allowAutoMerge }, { @@ -24610,6 +25677,7 @@ Either `true` to allow auto-merge on pull requests, or `false` to disallow auto- Summary: Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.
Default Value: false, + ParameterName: deleteBranchOnMerge, ArgumentName: deleteBranchOnMerge }, { @@ -24627,6 +25695,7 @@ Either `true` to allow automatically deleting head branches when pull requests a Summary: Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.
Default Value: false, + ParameterName: allowUpdateBranch, ArgumentName: allowUpdateBranch }, { @@ -24644,6 +25713,7 @@ Either `true` to always allow a pull request head branch that is behind its base Summary: Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
Default Value: false, + ParameterName: useSquashPrTitleAsDefault, ArgumentName: useSquashPrTitleAsDefault }, { @@ -24668,6 +25738,7 @@ The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)., + ParameterName: squashMergeCommitTitle, ArgumentName: squashMergeCommitTitle }, { @@ -24695,6 +25766,7 @@ The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message., + ParameterName: squashMergeCommitMessage, ArgumentName: squashMergeCommitMessage }, { @@ -24719,6 +25791,7 @@ The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)., + ParameterName: mergeCommitTitle, ArgumentName: mergeCommitTitle }, { @@ -24746,6 +25819,7 @@ The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message., + ParameterName: mergeCommitMessage, ArgumentName: mergeCommitMessage }, { @@ -24763,6 +25837,7 @@ The default value for a merge commit message. Summary: Whether to archive this repository. `false` will unarchive a previously archived repository.
Default Value: false, + ParameterName: archived, ArgumentName: archived }, { @@ -24780,6 +25855,7 @@ Whether to archive this repository. `false` will unarchive a previously archived Summary: Either `true` to allow private forks, or `false` to prevent private forks.
Default Value: false, + ParameterName: allowForking, ArgumentName: allowForking }, { @@ -24797,6 +25873,7 @@ Either `true` to allow private forks, or `false` to prevent private forks. Summary: Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.
Default Value: false, + ParameterName: webCommitSignoffRequired, ArgumentName: webCommitSignoffRequired } ], @@ -24831,6 +25908,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -24848,6 +25926,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -24882,6 +25961,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -24899,6 +25979,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -24918,6 +25999,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -24937,6 +26019,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -24954,6 +26037,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -24987,6 +26071,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25004,6 +26089,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -25021,6 +26107,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: artifactId, ArgumentName: artifactId } ], @@ -25054,6 +26141,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25071,6 +26159,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -25088,6 +26177,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: artifactId, ArgumentName: artifactId } ], @@ -25122,6 +26212,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25139,6 +26230,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -25156,6 +26248,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: artifactId, ArgumentName: artifactId }, { @@ -25173,6 +26266,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: archiveFormat, ArgumentName: archiveFormat } ], @@ -25206,6 +26300,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25223,6 +26318,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -25256,6 +26352,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25273,6 +26370,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -25292,6 +26390,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -25311,6 +26410,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -25328,6 +26428,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: ref, ArgumentName: ref }, { @@ -25345,6 +26446,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: key, ArgumentName: key }, { @@ -25372,6 +26474,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals DefaultValue: Sort.LastAccessedAt, Summary:
Default Value: last_accessed_at, + ParameterName: sort, ArgumentName: sort }, { @@ -25397,6 +26500,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction } ], @@ -25430,6 +26534,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25447,6 +26552,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -25464,6 +26570,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: key, ArgumentName: key }, { @@ -25481,6 +26588,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: ref, ArgumentName: ref } ], @@ -25515,6 +26623,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25532,6 +26641,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -25549,6 +26659,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: cacheId, ArgumentName: cacheId } ], @@ -25583,6 +26694,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25600,6 +26712,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -25617,6 +26730,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: jobId, ArgumentName: jobId } ], @@ -25650,6 +26764,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25667,6 +26782,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -25684,6 +26800,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: jobId, ArgumentName: jobId } ], @@ -25717,6 +26834,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25734,6 +26852,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -25751,6 +26870,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: jobId, ArgumentName: jobId }, { @@ -25768,6 +26888,7 @@ Either `true` to require contributors to sign off on web-based commits, or `fals Summary: Whether to enable debug logging for the re-run.
Default Value: false, + ParameterName: enableDebugLogging, ArgumentName: enableDebugLogging } ], @@ -25802,6 +26923,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25819,6 +26941,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -25852,6 +26975,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25869,6 +26993,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -25883,6 +27008,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: true, Summary: Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored., + ParameterName: useDefault, ArgumentName: useDefault }, { @@ -25897,6 +27023,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: false, Summary: Array of unique strings. Each claim key can only contain alphanumeric characters and underscores., + ParameterName: includeClaimKeys, ArgumentName: includeClaimKeys } ], @@ -25931,6 +27058,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -25948,6 +27076,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -25967,6 +27096,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -25986,6 +27116,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -26019,6 +27150,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26036,6 +27168,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -26055,6 +27188,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 10, Summary:
Default Value: 10, + ParameterName: perPage, ArgumentName: perPage }, { @@ -26074,6 +27208,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -26107,6 +27242,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26124,6 +27260,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -26157,6 +27294,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26174,6 +27312,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -26188,6 +27327,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: true, Summary: Whether GitHub Actions is enabled on the repository., + ParameterName: enabled, ArgumentName: enabled }, { @@ -26210,6 +27350,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: false, Summary: The permissions policy that controls the actions and reusable workflows that are allowed to run., + ParameterName: allowedActions, ArgumentName: allowedActions } ], @@ -26244,6 +27385,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26261,6 +27403,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -26294,6 +27437,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26311,6 +27455,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -26337,6 +27482,7 @@ Defines the level of access that workflows outside of the repository have to act repository. `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization., + ParameterName: accessLevel, ArgumentName: accessLevel } ], @@ -26371,6 +27517,7 @@ repository. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26388,6 +27535,7 @@ repository. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -26421,6 +27569,7 @@ repository. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26438,6 +27587,7 @@ repository. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -26452,6 +27602,7 @@ repository. }, IsRequired: false, Summary: Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization., + ParameterName: githubOwnedAllowed, ArgumentName: githubOwnedAllowed }, { @@ -26466,6 +27617,7 @@ repository. }, IsRequired: false, Summary: Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators., + ParameterName: verifiedAllowed, ArgumentName: verifiedAllowed }, { @@ -26483,6 +27635,7 @@ repository. Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. **Note**: The `patterns_allowed` setting only applies to public repositories., + ParameterName: patternsAllowed, ArgumentName: patternsAllowed } ], @@ -26517,6 +27670,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26534,6 +27688,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -26567,6 +27722,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26584,6 +27740,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -26604,6 +27761,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu }, IsRequired: false, Summary: The default workflow permissions granted to the GITHUB_TOKEN when running workflows., + ParameterName: defaultWorkflowPermissions, ArgumentName: defaultWorkflowPermissions }, { @@ -26618,6 +27776,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu }, IsRequired: false, Summary: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk., + ParameterName: canApprovePullRequestReviews, ArgumentName: canApprovePullRequestReviews } ], @@ -26652,6 +27811,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -26669,6 +27829,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26686,6 +27847,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -26705,6 +27867,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -26724,6 +27887,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -26757,6 +27921,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26774,6 +27939,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -26807,6 +27973,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26824,6 +27991,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -26838,6 +28006,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu }, IsRequired: true, Summary: The name of the new runner., + ParameterName: name, ArgumentName: name }, { @@ -26852,6 +28021,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu }, IsRequired: true, Summary: The ID of the runner group to register the runner to., + ParameterName: runnerGroupId, ArgumentName: runnerGroupId }, { @@ -26866,6 +28036,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu }, IsRequired: true, Summary: The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100., + ParameterName: labels, ArgumentName: labels }, { @@ -26883,6 +28054,7 @@ Specifies a list of string-matching patterns to allow specific action(s) and reu Summary: The working directory to be used for job execution, relative to the runner install directory.
Default Value: _work, + ParameterName: workFolder, ArgumentName: workFolder } ], @@ -26917,6 +28089,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26934,6 +28107,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -26968,6 +28142,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -26985,6 +28160,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -27019,6 +28195,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -27036,6 +28213,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -27053,6 +28231,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId } ], @@ -27086,6 +28265,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -27103,6 +28283,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -27120,6 +28301,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId } ], @@ -27154,6 +28336,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -27171,6 +28354,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -27188,6 +28372,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId } ], @@ -27221,6 +28406,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -27238,6 +28424,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -27255,6 +28442,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId }, { @@ -27269,6 +28457,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The names of the custom labels to add to the runner., + ParameterName: labels, ArgumentName: labels } ], @@ -27303,6 +28492,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -27320,6 +28510,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -27337,6 +28528,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId }, { @@ -27351,6 +28543,7 @@ The working directory to be used for job execution, relative to the runner insta }, IsRequired: true, Summary: The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels., + ParameterName: labels, ArgumentName: labels } ], @@ -27385,6 +28578,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -27402,6 +28596,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -27419,6 +28614,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId } ], @@ -27453,6 +28649,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -27470,6 +28667,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -27487,6 +28685,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runnerId, ArgumentName: runnerId }, { @@ -27504,6 +28703,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -27538,6 +28738,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -27555,6 +28756,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -27572,6 +28774,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: actor, ArgumentName: actor }, { @@ -27589,6 +28792,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: branch, ArgumentName: branch }, { @@ -27606,6 +28810,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: @event, ArgumentName: @event }, { @@ -27653,6 +28858,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: status, ArgumentName: status }, { @@ -27672,6 +28878,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -27691,6 +28898,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -27708,6 +28916,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: created, ArgumentName: created }, { @@ -27727,6 +28936,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: false, Summary:
Default Value: false, + ParameterName: excludePullRequests, ArgumentName: excludePullRequests }, { @@ -27744,6 +28954,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: checkSuiteId, ArgumentName: checkSuiteId }, { @@ -27761,6 +28972,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: headSha, ArgumentName: headSha } ], @@ -27794,6 +29006,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -27811,6 +29024,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -27828,6 +29042,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -27847,6 +29062,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: false, Summary:
Default Value: false, + ParameterName: excludePullRequests, ArgumentName: excludePullRequests } ], @@ -27880,6 +29096,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -27897,6 +29114,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -27914,6 +29132,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -27948,6 +29167,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -27965,6 +29185,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -27982,6 +29203,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -28015,6 +29237,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -28032,6 +29255,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -28049,6 +29273,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -28083,6 +29308,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -28100,6 +29326,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -28117,6 +29344,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -28136,6 +29364,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -28155,6 +29384,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -28172,6 +29402,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -28205,6 +29436,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -28222,6 +29454,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -28239,6 +29472,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -28256,6 +29490,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: attemptNumber, ArgumentName: attemptNumber }, { @@ -28275,6 +29510,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: false, Summary:
Default Value: false, + ParameterName: excludePullRequests, ArgumentName: excludePullRequests } ], @@ -28308,6 +29544,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -28325,6 +29562,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -28342,6 +29580,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -28359,6 +29598,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: attemptNumber, ArgumentName: attemptNumber }, { @@ -28378,6 +29618,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -28397,6 +29638,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -28430,6 +29672,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -28447,6 +29690,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -28464,6 +29708,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -28481,6 +29726,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: attemptNumber, ArgumentName: attemptNumber } ], @@ -28514,6 +29760,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -28531,6 +29778,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -28548,6 +29796,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -28582,6 +29831,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -28599,6 +29849,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -28616,6 +29867,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -28650,6 +29902,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -28667,6 +29920,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -28684,6 +29938,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -28718,6 +29973,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -28735,6 +29991,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -28752,6 +30009,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -28777,6 +30035,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: Filter.Latest, Summary:
Default Value: latest, + ParameterName: filter, ArgumentName: filter }, { @@ -28796,6 +30055,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -28815,6 +30075,7 @@ The working directory to be used for job execution, relative to the runner insta DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -28848,6 +30109,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -28865,6 +30127,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -28882,6 +30145,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -28915,6 +30179,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -28932,6 +30197,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -28949,6 +30215,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -28983,6 +30250,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29000,6 +30268,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -29017,6 +30286,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -29050,6 +30320,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29067,6 +30338,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -29084,6 +30356,7 @@ The working directory to be used for job execution, relative to the runner insta ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -29100,6 +30373,7 @@ The working directory to be used for job execution, relative to the runner insta Summary: The list of environment ids to approve or reject
Example: [161171787, 161171795], + ParameterName: environmentIds, ArgumentName: environmentIds }, { @@ -29122,6 +30396,7 @@ The list of environment ids to approve or reject Summary: Whether to approve or reject deployment to the specified environments.
Example: approved, + ParameterName: state, ArgumentName: state }, { @@ -29138,6 +30413,7 @@ Whether to approve or reject deployment to the specified environments. Summary: A comment to accompany the deployment review
Example: Ship it!, + ParameterName: comment, ArgumentName: comment } ], @@ -29172,6 +30448,7 @@ A comment to accompany the deployment review ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29189,6 +30466,7 @@ A comment to accompany the deployment review ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -29206,6 +30484,7 @@ A comment to accompany the deployment review ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -29223,6 +30502,7 @@ A comment to accompany the deployment review Summary: Whether to enable debug logging for the re-run.
Default Value: false, + ParameterName: enableDebugLogging, ArgumentName: enableDebugLogging } ], @@ -29257,6 +30537,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29274,6 +30555,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -29291,6 +30573,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -29308,6 +30591,7 @@ Whether to enable debug logging for the re-run. Summary: Whether to enable debug logging for the re-run.
Default Value: false, + ParameterName: enableDebugLogging, ArgumentName: enableDebugLogging } ], @@ -29342,6 +30626,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29359,6 +30644,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -29376,6 +30662,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -29409,6 +30696,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29426,6 +30714,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -29445,6 +30734,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -29464,6 +30754,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -29497,6 +30788,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29514,6 +30806,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -29547,6 +30840,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29564,6 +30858,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -29581,6 +30876,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -29614,6 +30910,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29631,6 +30928,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -29648,6 +30946,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -29662,6 +30961,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: false, Summary: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint., + ParameterName: encryptedValue, ArgumentName: encryptedValue }, { @@ -29676,6 +30976,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: false, Summary: ID of the key you used to encrypt the secret., + ParameterName: keyId, ArgumentName: keyId } ], @@ -29710,6 +31011,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29727,6 +31029,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -29744,6 +31047,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -29778,6 +31082,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29795,6 +31100,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -29814,6 +31120,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 10, Summary:
Default Value: 10, + ParameterName: perPage, ArgumentName: perPage }, { @@ -29833,6 +31140,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -29866,6 +31174,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29883,6 +31192,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -29897,6 +31207,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: true, Summary: The name of the variable., + ParameterName: name, ArgumentName: name }, { @@ -29911,6 +31222,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: true, Summary: The value of the variable., + ParameterName: value, ArgumentName: value } ], @@ -29945,6 +31257,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -29962,6 +31275,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -29979,6 +31293,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -30012,6 +31327,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -30029,6 +31345,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -30046,6 +31363,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -30060,6 +31378,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: false, Summary: The name of the variable., + ParameterName: name, ArgumentName: name }, { @@ -30074,6 +31393,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: false, Summary: The value of the variable., + ParameterName: value, ArgumentName: value } ], @@ -30108,6 +31428,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -30125,6 +31446,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -30142,6 +31464,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -30176,6 +31499,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -30193,6 +31517,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -30212,6 +31537,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -30231,6 +31557,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -30264,6 +31591,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -30281,6 +31609,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -30298,6 +31627,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: workflowId, ArgumentName: workflowId } ], @@ -30331,6 +31661,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -30348,6 +31679,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -30365,6 +31697,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: workflowId, ArgumentName: workflowId } ], @@ -30399,6 +31732,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -30416,6 +31750,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -30433,6 +31768,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: workflowId, ArgumentName: workflowId }, { @@ -30447,6 +31783,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: true, Summary: The git reference for the workflow. The reference can be a branch or tag name., + ParameterName: ref, ArgumentName: ref }, { @@ -30461,6 +31798,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: false, Summary: Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted., + ParameterName: inputs, ArgumentName: inputs } ], @@ -30495,6 +31833,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -30512,6 +31851,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -30529,6 +31869,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: workflowId, ArgumentName: workflowId } ], @@ -30563,6 +31904,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -30580,6 +31922,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -30597,6 +31940,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: workflowId, ArgumentName: workflowId }, { @@ -30614,6 +31958,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: actor, ArgumentName: actor }, { @@ -30631,6 +31976,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: branch, ArgumentName: branch }, { @@ -30648,6 +31994,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: @event, ArgumentName: @event }, { @@ -30695,6 +32042,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: status, ArgumentName: status }, { @@ -30714,6 +32062,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -30733,6 +32082,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -30750,6 +32100,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: created, ArgumentName: created }, { @@ -30769,6 +32120,7 @@ Whether to enable debug logging for the re-run. DefaultValue: false, Summary:
Default Value: false, + ParameterName: excludePullRequests, ArgumentName: excludePullRequests }, { @@ -30786,6 +32138,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: checkSuiteId, ArgumentName: checkSuiteId }, { @@ -30803,6 +32156,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: headSha, ArgumentName: headSha } ], @@ -30836,6 +32190,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -30853,6 +32208,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -30870,6 +32226,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: workflowId, ArgumentName: workflowId } ], @@ -30903,6 +32260,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -30920,6 +32278,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -30945,6 +32304,7 @@ Whether to enable debug logging for the re-run. DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -30964,6 +32324,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -30981,6 +32342,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -30998,6 +32360,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -31015,6 +32378,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: ref, ArgumentName: ref }, { @@ -31032,6 +32396,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: actor, ArgumentName: actor }, { @@ -31061,6 +32426,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: timePeriod, ArgumentName: timePeriod }, { @@ -31092,6 +32458,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: activityType, ArgumentName: activityType } ], @@ -31125,6 +32492,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31142,6 +32510,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -31161,6 +32530,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -31180,6 +32550,7 @@ Whether to enable debug logging for the re-run. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -31213,6 +32584,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31230,6 +32602,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -31247,6 +32620,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: assignee, ArgumentName: assignee } ], @@ -31280,6 +32654,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31297,6 +32672,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -31330,6 +32706,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31347,6 +32724,7 @@ Whether to enable debug logging for the re-run. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -31361,6 +32739,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: true, Summary: This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit., + ParameterName: keyPrefix, ArgumentName: keyPrefix }, { @@ -31375,6 +32754,7 @@ Whether to enable debug logging for the re-run. }, IsRequired: true, Summary: The URL must contain `<num>` for the reference number. `<num>` matches different characters depending on the value of `is_alphanumeric`., + ParameterName: urlTemplate, ArgumentName: urlTemplate }, { @@ -31392,6 +32772,7 @@ Whether to enable debug logging for the re-run. Summary: Whether this autolink reference matches alphanumeric characters. If true, the `<num>` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters.
Default Value: true, + ParameterName: isAlphanumeric, ArgumentName: isAlphanumeric } ], @@ -31426,6 +32807,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31443,6 +32825,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -31460,6 +32843,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: autolinkId, ArgumentName: autolinkId } ], @@ -31493,6 +32877,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31510,6 +32895,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -31527,6 +32913,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: autolinkId, ArgumentName: autolinkId } ], @@ -31561,6 +32948,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31578,6 +32966,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -31611,6 +33000,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31628,6 +33018,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -31662,6 +33053,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31679,6 +33071,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -31713,6 +33106,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31730,6 +33124,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -31747,6 +33142,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: protected, ArgumentName: protected }, { @@ -31766,6 +33162,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -31785,6 +33182,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -31818,6 +33216,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31835,6 +33234,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -31852,6 +33252,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -31885,6 +33286,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31902,6 +33304,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -31919,6 +33322,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -31952,6 +33356,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -31969,6 +33374,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -31986,6 +33392,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch }, { @@ -32000,6 +33407,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& }, IsRequired: true, Summary: Require status checks to pass before merging. Set to `null` to disable., + ParameterName: requiredStatusChecks, ArgumentName: requiredStatusChecks }, { @@ -32014,6 +33422,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& }, IsRequired: true, Summary: Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable., + ParameterName: enforceAdmins, ArgumentName: enforceAdmins }, { @@ -32028,6 +33437,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& }, IsRequired: true, Summary: Require at least one approving review on a pull request, before merging. Set to `null` to disable., + ParameterName: requiredPullRequestReviews, ArgumentName: requiredPullRequestReviews }, { @@ -32042,6 +33452,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& }, IsRequired: true, Summary: Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable., + ParameterName: restrictions, ArgumentName: restrictions }, { @@ -32056,6 +33467,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& }, IsRequired: false, Summary: Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation., + ParameterName: requiredLinearHistory, ArgumentName: requiredLinearHistory }, { @@ -32070,6 +33482,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& }, IsRequired: false, Summary: Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation.", + ParameterName: allowForcePushes, ArgumentName: allowForcePushes }, { @@ -32084,6 +33497,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& }, IsRequired: false, Summary: Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation., + ParameterName: allowDeletions, ArgumentName: allowDeletions }, { @@ -32098,6 +33512,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& }, IsRequired: false, Summary: If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`., + ParameterName: blockCreations, ArgumentName: blockCreations }, { @@ -32112,6 +33527,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& }, IsRequired: false, Summary: Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`., + ParameterName: requiredConversationResolution, ArgumentName: requiredConversationResolution }, { @@ -32129,6 +33545,7 @@ Whether this autolink reference matches alphanumeric characters. If true, the `& Summary: Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: `false`.
Default Value: false, + ParameterName: lockBranch, ArgumentName: lockBranch }, { @@ -32146,6 +33563,7 @@ Whether to set the branch as read-only. If this is true, users will not be able Summary: Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Default: `false`.
Default Value: false, + ParameterName: allowForkSyncing, ArgumentName: allowForkSyncing } ], @@ -32180,6 +33598,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -32197,6 +33616,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -32214,6 +33634,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -32248,6 +33669,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -32265,6 +33687,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -32282,6 +33705,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -32315,6 +33739,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -32332,6 +33757,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -32349,6 +33775,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -32383,6 +33810,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -32400,6 +33828,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -32417,6 +33846,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -32451,6 +33881,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -32468,6 +33899,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -32485,6 +33917,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -32518,6 +33951,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -32535,6 +33969,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -32552,6 +33987,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch }, { @@ -32566,6 +34002,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` }, IsRequired: false, Summary: Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories., + ParameterName: dismissalRestrictions, ArgumentName: dismissalRestrictions }, { @@ -32580,6 +34017,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` }, IsRequired: false, Summary: Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit., + ParameterName: dismissStaleReviews, ArgumentName: dismissStaleReviews }, { @@ -32594,6 +34032,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` }, IsRequired: false, Summary: Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed., + ParameterName: requireCodeOwnerReviews, ArgumentName: requireCodeOwnerReviews }, { @@ -32608,6 +34047,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` }, IsRequired: false, Summary: Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers., + ParameterName: requiredApprovingReviewCount, ArgumentName: requiredApprovingReviewCount }, { @@ -32625,6 +34065,7 @@ Whether users can pull changes from upstream when the branch is locked. Set to ` Summary: Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`
Default Value: false, + ParameterName: requireLastPushApproval, ArgumentName: requireLastPushApproval }, { @@ -32639,6 +34080,7 @@ Whether the most recent push must be approved by someone other than the person w }, IsRequired: false, Summary: Allow specific users, teams, or apps to bypass pull request requirements., + ParameterName: bypassPullRequestAllowances, ArgumentName: bypassPullRequestAllowances } ], @@ -32673,6 +34115,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -32690,6 +34133,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -32707,6 +34151,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -32741,6 +34186,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -32758,6 +34204,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -32775,6 +34222,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -32808,6 +34256,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -32825,6 +34274,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -32842,6 +34292,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -32876,6 +34327,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -32893,6 +34345,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -32910,6 +34363,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -32944,6 +34398,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -32961,6 +34416,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -32978,6 +34434,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33011,6 +34468,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33028,6 +34486,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33045,6 +34504,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch }, { @@ -33059,6 +34519,7 @@ Whether the most recent push must be approved by someone other than the person w }, IsRequired: false, Summary: Require branches to be up to date before merging., + ParameterName: strict, ArgumentName: strict }, { @@ -33075,6 +34536,7 @@ Whether the most recent push must be approved by someone other than the person w Summary: **Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control. , + ParameterName: contexts, ArgumentName: contexts }, { @@ -33089,6 +34551,7 @@ Whether the most recent push must be approved by someone other than the person w }, IsRequired: false, Summary: The list of status checks to require in order to merge into this branch., + ParameterName: checks, ArgumentName: checks } ], @@ -33123,6 +34586,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33140,6 +34604,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33157,6 +34622,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33191,6 +34657,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33208,6 +34675,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33225,6 +34693,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33258,6 +34727,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33275,6 +34745,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33292,6 +34763,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33326,6 +34798,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33343,6 +34816,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33360,6 +34834,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33394,6 +34869,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33411,6 +34887,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33428,6 +34905,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33462,6 +34940,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33479,6 +34958,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33496,6 +34976,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33529,6 +35010,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33546,6 +35028,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33563,6 +35046,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33597,6 +35081,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33614,6 +35099,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33631,6 +35117,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33664,6 +35151,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33681,6 +35169,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33698,6 +35187,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33732,6 +35222,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33749,6 +35240,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33766,6 +35258,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33800,6 +35293,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33817,6 +35311,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33834,6 +35329,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33868,6 +35364,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33885,6 +35382,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33902,6 +35400,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -33935,6 +35434,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -33952,6 +35452,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -33969,6 +35470,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -34003,6 +35505,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -34020,6 +35523,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -34037,6 +35541,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -34071,6 +35576,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -34088,6 +35594,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -34105,6 +35612,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -34139,6 +35647,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -34156,6 +35665,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -34173,6 +35683,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -34206,6 +35717,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -34223,6 +35735,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -34240,6 +35753,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -34274,6 +35788,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -34291,6 +35806,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -34308,6 +35824,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -34342,6 +35859,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -34359,6 +35877,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -34376,6 +35895,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch } ], @@ -34410,6 +35930,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -34427,6 +35948,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -34444,6 +35966,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch }, { @@ -34458,6 +35981,7 @@ Whether the most recent push must be approved by someone other than the person w }, IsRequired: true, Summary: The new name of the branch., + ParameterName: newName, ArgumentName: newName } ], @@ -34492,6 +36016,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -34509,6 +36034,7 @@ Whether the most recent push must be approved by someone other than the person w ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -34523,6 +36049,7 @@ Whether the most recent push must be approved by someone other than the person w }, IsRequired: true, Summary: The name of the check. For example, "code-coverage"., + ParameterName: name, ArgumentName: name }, { @@ -34537,6 +36064,7 @@ Whether the most recent push must be approved by someone other than the person w }, IsRequired: true, Summary: The SHA of the commit., + ParameterName: headSha, ArgumentName: headSha }, { @@ -34551,6 +36079,7 @@ Whether the most recent push must be approved by someone other than the person w }, IsRequired: false, Summary: The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used., + ParameterName: detailsUrl, ArgumentName: detailsUrl }, { @@ -34565,6 +36094,7 @@ Whether the most recent push must be approved by someone other than the person w }, IsRequired: false, Summary: A reference for the run on the integrator's system., + ParameterName: externalId, ArgumentName: externalId }, { @@ -34596,6 +36126,7 @@ Whether the most recent push must be approved by someone other than the person w Summary: The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.
Default Value: queued, + ParameterName: status, ArgumentName: status }, { @@ -34610,6 +36141,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`., + ParameterName: startedAt, ArgumentName: startedAt }, { @@ -34644,6 +36176,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa Summary: **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this., + ParameterName: conclusion, ArgumentName: conclusion }, { @@ -34658,6 +36191,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`., + ParameterName: completedAt, ArgumentName: completedAt }, { @@ -34672,6 +36206,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run., + ParameterName: output, ArgumentName: output }, { @@ -34686,6 +36221,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).", + ParameterName: actions, ArgumentName: actions } ], @@ -34720,6 +36256,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -34737,6 +36274,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -34754,6 +36292,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: checkRunId, ArgumentName: checkRunId } ], @@ -34787,6 +36326,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -34804,6 +36344,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -34821,6 +36362,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: checkRunId, ArgumentName: checkRunId }, { @@ -34835,6 +36377,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: The name of the check. For example, "code-coverage"., + ParameterName: name, ArgumentName: name }, { @@ -34849,6 +36392,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: The URL of the integrator's site that has the full details of the check., + ParameterName: detailsUrl, ArgumentName: detailsUrl }, { @@ -34863,6 +36407,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: A reference for the run on the integrator's system., + ParameterName: externalId, ArgumentName: externalId }, { @@ -34877,6 +36422,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`., + ParameterName: startedAt, ArgumentName: startedAt }, { @@ -34905,6 +36451,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`., + ParameterName: status, ArgumentName: status }, { @@ -34939,6 +36486,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa Summary: **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this., + ParameterName: conclusion, ArgumentName: conclusion }, { @@ -34953,6 +36501,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`., + ParameterName: completedAt, ArgumentName: completedAt }, { @@ -34967,6 +36516,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run., + ParameterName: output, ArgumentName: output }, { @@ -34981,6 +36531,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions).", + ParameterName: actions, ArgumentName: actions } ], @@ -35015,6 +36566,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -35032,6 +36584,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -35049,6 +36602,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: checkRunId, ArgumentName: checkRunId }, { @@ -35068,6 +36622,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -35087,6 +36642,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -35120,6 +36676,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -35137,6 +36694,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -35154,6 +36712,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: checkRunId, ArgumentName: checkRunId } ], @@ -35188,6 +36747,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -35205,6 +36765,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -35219,6 +36780,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: true, Summary: The sha of the head commit., + ParameterName: headSha, ArgumentName: headSha } ], @@ -35253,6 +36815,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -35270,6 +36833,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -35284,6 +36848,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa }, IsRequired: false, Summary: Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default., + ParameterName: autoTriggerChecks, ArgumentName: autoTriggerChecks } ], @@ -35318,6 +36883,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -35335,6 +36901,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -35352,6 +36919,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: checkSuiteId, ArgumentName: checkSuiteId } ], @@ -35385,6 +36953,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -35402,6 +36971,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -35419,6 +36989,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: checkSuiteId, ArgumentName: checkSuiteId }, { @@ -35436,6 +37007,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: checkName, ArgumentName: checkName }, { @@ -35461,6 +37033,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: status, ArgumentName: status }, { @@ -35486,6 +37059,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa DefaultValue: Filter.Latest, Summary:
Default Value: latest, + ParameterName: filter, ArgumentName: filter }, { @@ -35505,6 +37079,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -35524,6 +37099,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -35557,6 +37133,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -35574,6 +37151,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -35591,6 +37169,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: checkSuiteId, ArgumentName: checkSuiteId } ], @@ -35625,6 +37204,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -35642,6 +37222,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -35659,6 +37240,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Form, ParameterExplode: true, Summary: The name of the tool used to generate the code scanning analysis., + ParameterName: toolName, ArgumentName: toolName }, { @@ -35676,6 +37258,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa ParameterStyle: Form, ParameterExplode: true, Summary: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data., + ParameterName: toolGuid, ArgumentName: toolGuid }, { @@ -35695,6 +37278,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -35714,6 +37298,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -35733,6 +37318,7 @@ The current status of the check run. Only GitHub Actions can set a status of `wa Summary: The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`, `refs/heads/<branch name>` or simply `<branch name>`., + ParameterName: ref, ArgumentName: ref }, { @@ -35758,6 +37344,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -35783,6 +37370,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -35810,6 +37398,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Form, ParameterExplode: true, Summary: State of a code scanning alert., + ParameterName: state, ArgumentName: state }, { @@ -35843,6 +37432,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Form, ParameterExplode: true, Summary: Severity of a code scanning alert., + ParameterName: severity, ArgumentName: severity } ], @@ -35876,6 +37466,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -35893,6 +37484,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -35910,6 +37502,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: The security alert number., + ParameterName: alertNumber, ArgumentName: alertNumber } ], @@ -35943,6 +37536,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -35960,6 +37554,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -35977,6 +37572,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: The security alert number., + ParameterName: alertNumber, ArgumentName: alertNumber }, { @@ -35997,6 +37593,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< }, IsRequired: true, Summary: Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`., + ParameterName: state, ArgumentName: state }, { @@ -36021,6 +37618,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< }, IsRequired: false, Summary: **Required when the state is dismissed.** The reason for dismissing or closing the alert., + ParameterName: dismissedReason, ArgumentName: dismissedReason }, { @@ -36035,6 +37633,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< }, IsRequired: false, Summary: The dismissal comment associated with the dismissal of the alert., + ParameterName: dismissedComment, ArgumentName: dismissedComment } ], @@ -36069,6 +37668,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -36086,6 +37686,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -36103,6 +37704,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: The security alert number., + ParameterName: alertNumber, ArgumentName: alertNumber }, { @@ -36122,6 +37724,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -36141,6 +37744,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -36160,6 +37764,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< Summary: The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`, `refs/heads/<branch name>` or simply `<branch name>`., + ParameterName: ref, ArgumentName: ref } ], @@ -36193,6 +37798,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -36210,6 +37816,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -36227,6 +37834,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Form, ParameterExplode: true, Summary: The name of the tool used to generate the code scanning analysis., + ParameterName: toolName, ArgumentName: toolName }, { @@ -36244,6 +37852,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Form, ParameterExplode: true, Summary: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data., + ParameterName: toolGuid, ArgumentName: toolGuid }, { @@ -36263,6 +37872,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -36282,6 +37892,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -36301,6 +37912,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< Summary: The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`, `refs/heads/<branch name>` or simply `<branch name>`., + ParameterName: ref, ArgumentName: ref }, { @@ -36320,6 +37932,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< Summary: An identifier for the upload.
Example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53, + ParameterName: sarifId, ArgumentName: sarifId }, { @@ -36345,6 +37958,7 @@ An identifier for the upload. DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -36368,6 +37982,7 @@ An identifier for the upload. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort } ], @@ -36401,6 +38016,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -36418,6 +38034,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -36435,6 +38052,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: analysisId, ArgumentName: analysisId } ], @@ -36468,6 +38086,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -36485,6 +38104,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -36502,6 +38122,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: analysisId, ArgumentName: analysisId }, { @@ -36519,6 +38140,7 @@ An identifier for the upload. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: confirmDelete, ArgumentName: confirmDelete } ], @@ -36553,6 +38175,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -36570,6 +38193,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -36603,6 +38227,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -36620,6 +38245,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -36637,6 +38263,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: language, ArgumentName: language } ], @@ -36670,6 +38297,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -36687,6 +38315,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -36719,6 +38348,7 @@ An identifier for the upload. }, IsRequired: true, Summary: The language targeted by the CodeQL query, + ParameterName: language, ArgumentName: language }, { @@ -36733,6 +38363,7 @@ An identifier for the upload. }, IsRequired: true, Summary: A Base64-encoded tarball containing a CodeQL query and all its dependencies, + ParameterName: queryPack, ArgumentName: queryPack }, { @@ -36747,6 +38378,7 @@ An identifier for the upload. }, IsRequired: false, Summary: List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required., + ParameterName: repositories, ArgumentName: repositories }, { @@ -36761,6 +38393,7 @@ An identifier for the upload. }, IsRequired: false, Summary: List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required., + ParameterName: repositoryLists, ArgumentName: repositoryLists }, { @@ -36775,6 +38408,7 @@ An identifier for the upload. }, IsRequired: false, Summary: List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required., + ParameterName: repositoryOwners, ArgumentName: repositoryOwners } ], @@ -36809,6 +38443,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -36826,6 +38461,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -36843,6 +38479,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codeqlVariantAnalysisId, ArgumentName: codeqlVariantAnalysisId } ], @@ -36876,6 +38513,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -36893,6 +38531,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -36910,6 +38549,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codeqlVariantAnalysisId, ArgumentName: codeqlVariantAnalysisId }, { @@ -36927,6 +38567,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repoOwner, ArgumentName: repoOwner }, { @@ -36944,6 +38585,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repoName, ArgumentName: repoName } ], @@ -36977,6 +38619,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -36994,6 +38637,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -37027,6 +38671,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -37044,6 +38689,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -37064,6 +38710,7 @@ An identifier for the upload. }, IsRequired: false, Summary: The desired state of code scanning default setup., + ParameterName: state, ArgumentName: state }, { @@ -37084,6 +38731,7 @@ An identifier for the upload. }, IsRequired: false, Summary: CodeQL query suite to be used., + ParameterName: querySuite, ArgumentName: querySuite }, { @@ -37098,6 +38746,7 @@ An identifier for the upload. }, IsRequired: false, Summary: CodeQL languages to be analyzed., + ParameterName: languages, ArgumentName: languages } ], @@ -37132,6 +38781,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -37149,6 +38799,7 @@ An identifier for the upload. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -37163,6 +38814,7 @@ An identifier for the upload. }, IsRequired: true, Summary: The SHA of the commit to which the analysis you are uploading relates., + ParameterName: commitSha, ArgumentName: commitSha }, { @@ -37180,6 +38832,7 @@ An identifier for the upload. The full Git reference, formatted as `refs/heads/<branch name>`, `refs/tags/<tag>`, `refs/pull/<number>/merge`, or `refs/pull/<number>/head`.
Example: refs/heads/main, + ParameterName: ref, ArgumentName: ref }, { @@ -37194,6 +38847,7 @@ The full Git reference, formatted as `refs/heads/<branch name>`, }, IsRequired: true, Summary: A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning).", + ParameterName: sarif, ArgumentName: sarif }, { @@ -37211,6 +38865,7 @@ The full Git reference, formatted as `refs/heads/<branch name>`, The base directory used in the analysis, as it appears in the SARIF file. This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.
Example: file:///github/workspace/, + ParameterName: checkoutUri, ArgumentName: checkoutUri }, { @@ -37225,6 +38880,7 @@ This property is used to convert file paths from absolute to relative, so that a }, IsRequired: false, Summary: The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`., + ParameterName: startedAt, ArgumentName: startedAt }, { @@ -37239,6 +38895,7 @@ This property is used to convert file paths from absolute to relative, so that a }, IsRequired: false, Summary: The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`., + ParameterName: toolName, ArgumentName: toolName }, { @@ -37255,6 +38912,7 @@ This property is used to convert file paths from absolute to relative, so that a Summary: Whether the SARIF file will be validated according to the code scanning specifications. This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning., + ParameterName: validate, ArgumentName: validate } ], @@ -37289,6 +38947,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -37306,6 +38965,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -37323,6 +38983,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: sarifId, ArgumentName: sarifId } ], @@ -37356,6 +39017,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -37373,6 +39035,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -37390,6 +39053,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: ref, ArgumentName: ref } ], @@ -37425,6 +39089,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -37444,6 +39109,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -37461,6 +39127,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -37478,6 +39145,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -37511,6 +39179,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -37528,6 +39197,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -37542,6 +39212,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: Git ref (typically a branch name) for this codespace, + ParameterName: ref, ArgumentName: ref }, { @@ -37556,6 +39227,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided., + ParameterName: location, ArgumentName: location }, { @@ -37580,6 +39252,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated., + ParameterName: geo, ArgumentName: geo }, { @@ -37594,6 +39267,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: IP for location auto-detection when proxying a request, + ParameterName: clientIp, ArgumentName: clientIp }, { @@ -37608,6 +39282,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: Machine type to use for this codespace, + ParameterName: machine, ArgumentName: machine }, { @@ -37622,6 +39297,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: Path to devcontainer.json config to use for this codespace, + ParameterName: devcontainerPath, ArgumentName: devcontainerPath }, { @@ -37636,6 +39312,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: Whether to authorize requested permissions from devcontainer.json, + ParameterName: multiRepoPermissionsOptOut, ArgumentName: multiRepoPermissionsOptOut }, { @@ -37650,6 +39327,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: Working directory for this codespace, + ParameterName: workingDirectory, ArgumentName: workingDirectory }, { @@ -37664,6 +39342,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: Time in minutes before codespace stops from inactivity, + ParameterName: idleTimeoutMinutes, ArgumentName: idleTimeoutMinutes }, { @@ -37678,6 +39357,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: Display name for this codespace, + ParameterName: displayName, ArgumentName: displayName }, { @@ -37692,6 +39372,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days)., + ParameterName: retentionPeriodMinutes, ArgumentName: retentionPeriodMinutes } ], @@ -37728,6 +39409,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -37747,6 +39429,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -37764,6 +39447,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -37781,6 +39465,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -37814,6 +39499,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -37831,6 +39517,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -37849,6 +39536,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterExplode: true, Summary:
Example: WestUs2, + ParameterName: location, ArgumentName: location }, { @@ -37866,6 +39554,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: clientIp, ArgumentName: clientIp }, { @@ -37884,6 +39573,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterExplode: true, Summary:
Example: main, + ParameterName: ref, ArgumentName: ref } ], @@ -37917,6 +39607,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -37934,6 +39625,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -37952,6 +39644,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterExplode: true, Summary:
Example: main, + ParameterName: ref, ArgumentName: ref }, { @@ -37970,6 +39663,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterExplode: true, Summary:
Example: 1.2.3.4, + ParameterName: clientIp, ArgumentName: clientIp } ], @@ -38003,6 +39697,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38020,6 +39715,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -38038,6 +39734,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterExplode: true, Summary:
Example: master, + ParameterName: ref, ArgumentName: ref }, { @@ -38056,6 +39753,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterExplode: true, Summary:
Example: .devcontainer/example/devcontainer.json, + ParameterName: devcontainerPath, ArgumentName: devcontainerPath } ], @@ -38089,6 +39787,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38106,6 +39805,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -38125,6 +39825,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -38144,6 +39845,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -38177,6 +39879,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38194,6 +39897,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -38227,6 +39931,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38244,6 +39949,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -38261,6 +39967,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -38294,6 +40001,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38311,6 +40019,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -38328,6 +40037,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -38342,6 +40052,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint., + ParameterName: encryptedValue, ArgumentName: encryptedValue }, { @@ -38356,6 +40067,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi }, IsRequired: false, Summary: ID of the key you used to encrypt the secret., + ParameterName: keyId, ArgumentName: keyId } ], @@ -38390,6 +40102,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38407,6 +40120,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -38424,6 +40138,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -38458,6 +40173,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38475,6 +40191,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -38502,6 +40219,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi DefaultValue: Affiliation.All, Summary:
Default Value: all, + ParameterName: affiliation, ArgumentName: affiliation }, { @@ -38531,6 +40249,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: permission, ArgumentName: permission }, { @@ -38550,6 +40269,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -38569,6 +40289,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -38602,6 +40323,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38619,6 +40341,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -38636,6 +40359,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -38669,6 +40393,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38686,6 +40411,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -38703,6 +40429,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -38720,6 +40447,7 @@ This parameter is intended to help integrators ensure that the uploaded SARIF fi Summary: The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.
Default Value: push, + ParameterName: permission, ArgumentName: permission } ], @@ -38754,6 +40482,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38771,6 +40500,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -38788,6 +40518,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -38822,6 +40553,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38839,6 +40571,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -38856,6 +40589,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -38889,6 +40623,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38906,6 +40641,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -38925,6 +40661,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -38944,6 +40681,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -38977,6 +40715,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -38994,6 +40733,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -39011,6 +40751,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId } ], @@ -39044,6 +40785,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -39061,6 +40803,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -39078,6 +40821,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -39092,6 +40836,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: true, Summary: The contents of the comment, + ParameterName: body, ArgumentName: body } ], @@ -39126,6 +40871,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -39143,6 +40889,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -39160,6 +40907,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId } ], @@ -39194,6 +40942,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -39211,6 +40960,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -39228,6 +40978,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -39263,6 +41014,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -39282,6 +41034,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -39301,6 +41054,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -39334,6 +41088,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -39351,6 +41106,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -39368,6 +41124,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -39400,6 +41157,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: true, Summary: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment., + ParameterName: content, ArgumentName: content } ], @@ -39434,6 +41192,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -39451,6 +41210,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -39468,6 +41228,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -39485,6 +41246,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reactionId, ArgumentName: reactionId } ], @@ -39519,6 +41281,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -39536,6 +41299,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -39553,6 +41317,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: sha, ArgumentName: sha }, { @@ -39570,6 +41335,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: path, ArgumentName: path }, { @@ -39587,6 +41353,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: author, ArgumentName: author }, { @@ -39604,6 +41371,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: committer, ArgumentName: committer }, { @@ -39621,6 +41389,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -39638,6 +41407,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: until, ArgumentName: until }, { @@ -39657,6 +41427,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -39676,6 +41447,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -39709,6 +41481,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -39726,6 +41499,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -39743,6 +41517,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commitSha, ArgumentName: commitSha } ], @@ -39776,6 +41551,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -39793,6 +41569,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -39810,6 +41587,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commitSha, ArgumentName: commitSha }, { @@ -39829,6 +41607,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -39848,6 +41627,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -39881,6 +41661,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -39898,6 +41679,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -39915,6 +41697,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commitSha, ArgumentName: commitSha }, { @@ -39929,6 +41712,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: true, Summary: The contents of the comment., + ParameterName: body, ArgumentName: body }, { @@ -39943,6 +41727,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: false, Summary: Relative path of the file to comment on., + ParameterName: path, ArgumentName: path }, { @@ -39957,6 +41742,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: false, Summary: Line index in the diff to comment on., + ParameterName: position, ArgumentName: position }, { @@ -39971,6 +41757,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: false, Summary: **Deprecated**. Use **position** parameter instead. Line number in the file to comment on., + ParameterName: line, ArgumentName: line } ], @@ -40005,6 +41792,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -40022,6 +41810,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -40039,6 +41828,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commitSha, ArgumentName: commitSha }, { @@ -40058,6 +41848,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -40077,6 +41868,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -40110,6 +41902,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -40127,6 +41920,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -40146,6 +41940,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -40165,6 +41960,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -40182,6 +41978,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ref, ArgumentName: ref } ], @@ -40215,6 +42012,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -40232,6 +42030,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -40249,6 +42048,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ref, ArgumentName: ref }, { @@ -40266,6 +42066,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: checkName, ArgumentName: checkName }, { @@ -40291,6 +42092,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: status, ArgumentName: status }, { @@ -40316,6 +42118,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: Filter.Latest, Summary:
Default Value: latest, + ParameterName: filter, ArgumentName: filter }, { @@ -40335,6 +42138,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -40354,6 +42158,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -40371,6 +42176,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: appId, ArgumentName: appId } ], @@ -40404,6 +42210,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -40421,6 +42228,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -40438,6 +42246,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ref, ArgumentName: ref }, { @@ -40455,6 +42264,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: appId, ArgumentName: appId }, { @@ -40472,6 +42282,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: checkName, ArgumentName: checkName }, { @@ -40491,6 +42302,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -40510,6 +42322,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -40543,6 +42356,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -40560,6 +42374,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -40577,6 +42392,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ref, ArgumentName: ref }, { @@ -40596,6 +42412,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -40615,6 +42432,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -40648,6 +42466,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -40665,6 +42484,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -40682,6 +42502,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ref, ArgumentName: ref }, { @@ -40701,6 +42522,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -40720,6 +42542,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -40753,6 +42576,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -40770,6 +42594,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -40803,6 +42628,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -40820,6 +42646,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -40839,6 +42666,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -40858,6 +42686,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -40875,6 +42704,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: basehead, ArgumentName: basehead } ], @@ -40908,6 +42738,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -40925,6 +42756,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -40942,6 +42774,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: path, ArgumentName: path }, { @@ -40959,6 +42792,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: ref, ArgumentName: ref } ], @@ -40992,6 +42826,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -41009,6 +42844,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -41026,6 +42862,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: path, ArgumentName: path }, { @@ -41040,6 +42877,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: true, Summary: The commit message., + ParameterName: message, ArgumentName: message }, { @@ -41054,6 +42892,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: true, Summary: The new file content, using Base64 encoding., + ParameterName: content, ArgumentName: content }, { @@ -41068,6 +42907,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: false, Summary: **Required if you are updating a file**. The blob SHA of the file being replaced., + ParameterName: sha, ArgumentName: sha }, { @@ -41082,6 +42922,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: false, Summary: The branch name. Default: the repository’s default branch., + ParameterName: branch, ArgumentName: branch }, { @@ -41096,6 +42937,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: false, Summary: The person that committed the file. Default: the authenticated user., + ParameterName: committer, ArgumentName: committer }, { @@ -41110,6 +42952,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: false, Summary: The author of the file. Default: The `committer` or the authenticated user if you omit `committer`., + ParameterName: author, ArgumentName: author } ], @@ -41144,6 +42987,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -41161,6 +43005,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -41178,6 +43023,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: path, ArgumentName: path }, { @@ -41192,6 +43038,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: true, Summary: The commit message., + ParameterName: message, ArgumentName: message }, { @@ -41206,6 +43053,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: true, Summary: The blob SHA of the file being deleted., + ParameterName: sha, ArgumentName: sha }, { @@ -41220,6 +43068,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: false, Summary: The branch name. Default: the repository’s default branch, + ParameterName: branch, ArgumentName: branch }, { @@ -41234,6 +43083,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: false, Summary: object containing information about the committer., + ParameterName: committer, ArgumentName: committer }, { @@ -41248,6 +43098,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep }, IsRequired: false, Summary: object containing information about the author., + ParameterName: author, ArgumentName: author } ], @@ -41282,6 +43133,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -41299,6 +43151,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -41316,6 +43169,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: anon, ArgumentName: anon }, { @@ -41335,6 +43189,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -41354,6 +43209,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -41387,6 +43243,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -41404,6 +43261,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -41421,6 +43279,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: state, ArgumentName: state }, { @@ -41438,6 +43297,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: severity, ArgumentName: severity }, { @@ -41455,6 +43315,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: ecosystem, ArgumentName: ecosystem }, { @@ -41472,6 +43333,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: package, ArgumentName: package }, { @@ -41489,6 +43351,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: manifest, ArgumentName: manifest }, { @@ -41512,6 +43375,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: scope, ArgumentName: scope }, { @@ -41537,6 +43401,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -41562,6 +43427,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -41581,6 +43447,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -41600,6 +43467,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -41617,6 +43485,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -41634,6 +43503,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -41653,6 +43523,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: first, ArgumentName: first }, { @@ -41670,6 +43541,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: last, ArgumentName: last } ], @@ -41703,6 +43575,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -41720,6 +43593,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -41737,6 +43611,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: The security alert number., + ParameterName: alertNumber, ArgumentName: alertNumber } ], @@ -41770,6 +43645,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -41787,6 +43663,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -41804,6 +43681,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep ParameterStyle: Simple, ParameterExplode: false, Summary: The security alert number., + ParameterName: alertNumber, ArgumentName: alertNumber }, { @@ -41826,6 +43704,7 @@ The permission to grant the collaborator. **Only valid on organization-owned rep Summary: The state of the Dependabot alert. A `dismissed_reason` must be provided when setting the state to `dismissed`., + ParameterName: state, ArgumentName: state }, { @@ -41852,6 +43731,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., }, IsRequired: false, Summary: **Required when `state` is `dismissed`.** A reason for dismissing the alert., + ParameterName: dismissedReason, ArgumentName: dismissedReason }, { @@ -41866,6 +43746,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., }, IsRequired: false, Summary: An optional comment associated with dismissing the alert., + ParameterName: dismissedComment, ArgumentName: dismissedComment } ], @@ -41900,6 +43781,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -41917,6 +43799,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -41936,6 +43819,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -41955,6 +43839,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -41988,6 +43873,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -42005,6 +43891,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -42038,6 +43925,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -42055,6 +43943,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -42072,6 +43961,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -42105,6 +43995,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -42122,6 +44013,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -42139,6 +44031,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -42153,6 +44046,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., }, IsRequired: false, Summary: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint., + ParameterName: encryptedValue, ArgumentName: encryptedValue }, { @@ -42167,6 +44061,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., }, IsRequired: false, Summary: ID of the key you used to encrypt the secret., + ParameterName: keyId, ArgumentName: keyId } ], @@ -42201,6 +44096,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -42218,6 +44114,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -42235,6 +44132,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -42269,6 +44167,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -42286,6 +44185,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -42303,6 +44203,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: basehead, ArgumentName: basehead }, { @@ -42320,6 +44221,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -42353,6 +44255,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -42370,6 +44273,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -42403,6 +44307,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -42420,6 +44325,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -42434,6 +44340,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., }, IsRequired: true, Summary: The version of the repository snapshot submission., + ParameterName: version, ArgumentName: version }, { @@ -42448,6 +44355,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., }, IsRequired: true, Summary: , + ParameterName: job, ArgumentName: job }, { @@ -42464,6 +44372,7 @@ A `dismissed_reason` must be provided when setting the state to `dismissed`., Summary: The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.
Example: ddc951f4b1293222421f2c8df679786153acf689, + ParameterName: sha, ArgumentName: sha }, { @@ -42480,6 +44389,7 @@ The commit SHA associated with this dependency snapshot. Maximum length: 40 char Summary: The repository branch that triggered this snapshot.
Example: refs/heads/main, + ParameterName: ref, ArgumentName: ref }, { @@ -42494,6 +44404,7 @@ The repository branch that triggered this snapshot. }, IsRequired: true, Summary: A description of the detector used., + ParameterName: detector, ArgumentName: detector }, { @@ -42508,6 +44419,7 @@ The repository branch that triggered this snapshot. }, IsRequired: false, Summary: User-defined metadata to store domain-specific information limited to 8 keys with scalar values., + ParameterName: metadata, ArgumentName: metadata }, { @@ -42522,6 +44434,7 @@ The repository branch that triggered this snapshot. }, IsRequired: false, Summary: A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies., + ParameterName: manifests, ArgumentName: manifests }, { @@ -42538,6 +44451,7 @@ The repository branch that triggered this snapshot. Summary: The time at which the snapshot was scanned.
Example: , + ParameterName: scanned, ArgumentName: scanned } ], @@ -42572,6 +44486,7 @@ The time at which the snapshot was scanned. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -42589,6 +44504,7 @@ The time at which the snapshot was scanned. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -42608,6 +44524,7 @@ The time at which the snapshot was scanned. DefaultValue: "none", Summary:
Default Value: none, + ParameterName: sha, ArgumentName: sha }, { @@ -42627,6 +44544,7 @@ The time at which the snapshot was scanned. DefaultValue: "none", Summary:
Default Value: none, + ParameterName: ref, ArgumentName: ref }, { @@ -42646,6 +44564,7 @@ The time at which the snapshot was scanned. DefaultValue: "none", Summary:
Default Value: none, + ParameterName: task, ArgumentName: task }, { @@ -42665,6 +44584,7 @@ The time at which the snapshot was scanned. DefaultValue: "none", Summary:
Default Value: none, + ParameterName: environment, ArgumentName: environment }, { @@ -42684,6 +44604,7 @@ The time at which the snapshot was scanned. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -42703,6 +44624,7 @@ The time at which the snapshot was scanned. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -42736,6 +44658,7 @@ The time at which the snapshot was scanned. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -42753,6 +44676,7 @@ The time at which the snapshot was scanned. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -42767,6 +44691,7 @@ The time at which the snapshot was scanned. }, IsRequired: true, Summary: The ref to deploy. This can be a branch, tag, or SHA., + ParameterName: ref, ArgumentName: ref }, { @@ -42784,6 +44709,7 @@ The time at which the snapshot was scanned. Summary: Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).
Default Value: deploy, + ParameterName: task, ArgumentName: task }, { @@ -42801,6 +44727,7 @@ Specifies a task to execute (e.g., `deploy` or `deploy:migrations`). Summary: Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.
Default Value: true, + ParameterName: autoMerge, ArgumentName: autoMerge }, { @@ -42815,6 +44742,7 @@ Attempts to automatically merge the default branch into the requested ref, if it }, IsRequired: false, Summary: The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts., + ParameterName: requiredContexts, ArgumentName: requiredContexts }, { @@ -42830,6 +44758,7 @@ Attempts to automatically merge the default branch into the requested ref, if it IsRequired: false, DefaultValue: , Summary: , + ParameterName: payload, ArgumentName: payload }, { @@ -42847,6 +44776,7 @@ Attempts to automatically merge the default branch into the requested ref, if it Summary: Name for the target deployment environment (e.g., `production`, `staging`, `qa`).
Default Value: production, + ParameterName: environment, ArgumentName: environment }, { @@ -42864,6 +44794,7 @@ Name for the target deployment environment (e.g., `production`, `staging`, `qa`) Summary: Short description of the deployment.
Default Value: , + ParameterName: description, ArgumentName: description }, { @@ -42881,6 +44812,7 @@ Short description of the deployment. Summary: Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`
Default Value: false, + ParameterName: transientEnvironment, ArgumentName: transientEnvironment }, { @@ -42895,6 +44827,7 @@ Specifies if the given environment is specific to the deployment and will no lon }, IsRequired: false, Summary: Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise., + ParameterName: productionEnvironment, ArgumentName: productionEnvironment } ], @@ -42929,6 +44862,7 @@ Specifies if the given environment is specific to the deployment and will no lon ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -42946,6 +44880,7 @@ Specifies if the given environment is specific to the deployment and will no lon ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -42963,6 +44898,7 @@ Specifies if the given environment is specific to the deployment and will no lon ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentId, ArgumentName: deploymentId } ], @@ -42996,6 +44932,7 @@ Specifies if the given environment is specific to the deployment and will no lon ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -43013,6 +44950,7 @@ Specifies if the given environment is specific to the deployment and will no lon ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -43030,6 +44968,7 @@ Specifies if the given environment is specific to the deployment and will no lon ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentId, ArgumentName: deploymentId } ], @@ -43064,6 +45003,7 @@ Specifies if the given environment is specific to the deployment and will no lon ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -43081,6 +45021,7 @@ Specifies if the given environment is specific to the deployment and will no lon ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -43098,6 +45039,7 @@ Specifies if the given environment is specific to the deployment and will no lon ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentId, ArgumentName: deploymentId }, { @@ -43117,6 +45059,7 @@ Specifies if the given environment is specific to the deployment and will no lon DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -43136,6 +45079,7 @@ Specifies if the given environment is specific to the deployment and will no lon DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -43169,6 +45113,7 @@ Specifies if the given environment is specific to the deployment and will no lon ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -43186,6 +45131,7 @@ Specifies if the given environment is specific to the deployment and will no lon ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -43203,6 +45149,7 @@ Specifies if the given environment is specific to the deployment and will no lon ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentId, ArgumentName: deploymentId }, { @@ -43233,6 +45180,7 @@ Specifies if the given environment is specific to the deployment and will no lon }, IsRequired: true, Summary: The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub., + ParameterName: state, ArgumentName: state }, { @@ -43250,6 +45198,7 @@ Specifies if the given environment is specific to the deployment and will no lon Summary: The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.
Default Value: , + ParameterName: targetUrl, ArgumentName: targetUrl }, { @@ -43267,6 +45216,7 @@ The target URL to associate with this status. This URL should contain output to Summary: The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""`
Default Value: , + ParameterName: logUrl, ArgumentName: logUrl }, { @@ -43284,6 +45234,7 @@ The full URL of the deployment's output. This parameter replaces `target_url`. W Summary: A short description of the status. The maximum description length is 140 characters.
Default Value: , + ParameterName: description, ArgumentName: description }, { @@ -43298,6 +45249,7 @@ A short description of the status. The maximum description length is 140 charact }, IsRequired: false, Summary: Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used., + ParameterName: environment, ArgumentName: environment }, { @@ -43315,6 +45267,7 @@ A short description of the status. The maximum description length is 140 charact Summary: Sets the URL for accessing your environment. Default: `""`
Default Value: , + ParameterName: environmentUrl, ArgumentName: environmentUrl }, { @@ -43329,6 +45282,7 @@ Sets the URL for accessing your environment. Default: `""` }, IsRequired: false, Summary: Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`, + ParameterName: autoInactive, ArgumentName: autoInactive } ], @@ -43363,6 +45317,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -43380,6 +45335,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -43397,6 +45353,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentId, ArgumentName: deploymentId }, { @@ -43414,6 +45371,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: statusId, ArgumentName: statusId } ], @@ -43447,6 +45405,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -43464,6 +45423,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -43478,6 +45438,7 @@ Sets the URL for accessing your environment. Default: `""` }, IsRequired: true, Summary: A custom webhook event name. Must be 100 characters or fewer., + ParameterName: eventType, ArgumentName: eventType }, { @@ -43492,6 +45453,7 @@ Sets the URL for accessing your environment. Default: `""` }, IsRequired: false, Summary: JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10., + ParameterName: clientPayload, ArgumentName: clientPayload } ], @@ -43526,6 +45488,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -43543,6 +45506,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -43562,6 +45526,7 @@ Sets the URL for accessing your environment. Default: `""` DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -43581,6 +45546,7 @@ Sets the URL for accessing your environment. Default: `""` DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -43614,6 +45580,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -43631,6 +45598,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -43648,6 +45616,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName } ], @@ -43681,6 +45650,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -43698,6 +45668,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -43715,6 +45686,7 @@ Sets the URL for accessing your environment. Default: `""` ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -43731,6 +45703,7 @@ Sets the URL for accessing your environment. Default: `""` Summary: The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
Example: 30, + ParameterName: waitTimer, ArgumentName: waitTimer }, { @@ -43747,6 +45720,7 @@ The amount of time to delay a job after the job is initially triggered. The time Summary: Whether or not a user who created the job is prevented from approving their own job.
Example: false, + ParameterName: preventSelfReview, ArgumentName: preventSelfReview }, { @@ -43761,6 +45735,7 @@ Whether or not a user who created the job is prevented from approving their own }, IsRequired: false, Summary: The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed., + ParameterName: reviewers, ArgumentName: reviewers }, { @@ -43778,6 +45753,7 @@ Whether or not a user who created the job is prevented from approving their own }, IsRequired: false, Summary: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`., + ParameterName: deploymentBranchPolicy, ArgumentName: deploymentBranchPolicy } ], @@ -43812,6 +45788,7 @@ Whether or not a user who created the job is prevented from approving their own ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -43829,6 +45806,7 @@ Whether or not a user who created the job is prevented from approving their own ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -43846,6 +45824,7 @@ Whether or not a user who created the job is prevented from approving their own ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName } ], @@ -43880,6 +45859,7 @@ Whether or not a user who created the job is prevented from approving their own ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -43897,6 +45877,7 @@ Whether or not a user who created the job is prevented from approving their own ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -43914,6 +45895,7 @@ Whether or not a user who created the job is prevented from approving their own ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -43933,6 +45915,7 @@ Whether or not a user who created the job is prevented from approving their own DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -43952,6 +45935,7 @@ Whether or not a user who created the job is prevented from approving their own DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -43985,6 +45969,7 @@ Whether or not a user who created the job is prevented from approving their own ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -44002,6 +45987,7 @@ Whether or not a user who created the job is prevented from approving their own ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -44019,6 +46005,7 @@ Whether or not a user who created the job is prevented from approving their own ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -44038,6 +46025,7 @@ The name pattern that branches or tags must match in order to deploy to the envi Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
Example: release/*, + ParameterName: name, ArgumentName: name }, { @@ -44060,6 +46048,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d Summary: Whether this rule targets a branch or tag
Example: branch, + ParameterName: type, ArgumentName: type } ], @@ -44094,6 +46083,7 @@ Whether this rule targets a branch or tag ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -44111,6 +46101,7 @@ Whether this rule targets a branch or tag ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -44128,6 +46119,7 @@ Whether this rule targets a branch or tag ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -44145,6 +46137,7 @@ Whether this rule targets a branch or tag ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branchPolicyId, ArgumentName: branchPolicyId } ], @@ -44178,6 +46171,7 @@ Whether this rule targets a branch or tag ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -44195,6 +46189,7 @@ Whether this rule targets a branch or tag ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -44212,6 +46207,7 @@ Whether this rule targets a branch or tag ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -44229,6 +46225,7 @@ Whether this rule targets a branch or tag ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branchPolicyId, ArgumentName: branchPolicyId }, { @@ -44248,6 +46245,7 @@ The name pattern that branches must match in order to deploy to the environment. Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`. For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
Example: release/*, + ParameterName: name, ArgumentName: name } ], @@ -44282,6 +46280,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -44299,6 +46298,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -44316,6 +46316,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -44333,6 +46334,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branchPolicyId, ArgumentName: branchPolicyId } ], @@ -44367,6 +46369,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -44384,6 +46387,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -44401,6 +46405,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner } ], @@ -44434,6 +46439,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -44451,6 +46457,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -44468,6 +46475,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -44482,6 +46490,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d }, IsRequired: false, Summary: The ID of the custom app that will be enabled on the environment., + ParameterName: integrationId, ArgumentName: integrationId } ], @@ -44516,6 +46525,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -44533,6 +46543,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -44550,6 +46561,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -44569,6 +46581,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -44588,6 +46601,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -44621,6 +46635,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -44638,6 +46653,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -44655,6 +46671,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -44672,6 +46689,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: protectionRuleId, ArgumentName: protectionRuleId } ], @@ -44705,6 +46723,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -44722,6 +46741,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -44739,6 +46759,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -44756,6 +46777,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: protectionRuleId, ArgumentName: protectionRuleId } ], @@ -44790,6 +46812,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -44807,6 +46830,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -44824,6 +46848,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -44843,6 +46868,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -44862,6 +46888,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -44895,6 +46922,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -44912,6 +46940,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -44929,6 +46958,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName } ], @@ -44962,6 +46992,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -44979,6 +47010,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -44996,6 +47028,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -45013,6 +47046,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -45046,6 +47080,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -45063,6 +47098,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -45080,6 +47116,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -45097,6 +47134,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -45111,6 +47149,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d }, IsRequired: true, Summary: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint., + ParameterName: encryptedValue, ArgumentName: encryptedValue }, { @@ -45125,6 +47164,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d }, IsRequired: true, Summary: ID of the key you used to encrypt the secret., + ParameterName: keyId, ArgumentName: keyId } ], @@ -45159,6 +47199,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -45176,6 +47217,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -45193,6 +47235,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -45210,6 +47253,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -45244,6 +47288,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -45261,6 +47306,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -45278,6 +47324,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -45297,6 +47344,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d DefaultValue: 10, Summary:
Default Value: 10, + ParameterName: perPage, ArgumentName: perPage }, { @@ -45316,6 +47364,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -45349,6 +47398,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -45366,6 +47416,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -45383,6 +47434,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -45397,6 +47449,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d }, IsRequired: true, Summary: The name of the variable., + ParameterName: name, ArgumentName: name }, { @@ -45411,6 +47464,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d }, IsRequired: true, Summary: The value of the variable., + ParameterName: value, ArgumentName: value } ], @@ -45445,6 +47499,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -45462,6 +47517,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -45479,6 +47535,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -45496,6 +47553,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -45529,6 +47587,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -45546,6 +47605,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -45563,6 +47623,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -45580,6 +47641,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName }, { @@ -45594,6 +47656,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d }, IsRequired: false, Summary: The name of the variable., + ParameterName: name, ArgumentName: name }, { @@ -45608,6 +47671,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d }, IsRequired: false, Summary: The value of the variable., + ParameterName: value, ArgumentName: value } ], @@ -45642,6 +47706,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -45659,6 +47724,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -45676,6 +47742,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -45693,6 +47760,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: environmentName, ArgumentName: environmentName } ], @@ -45727,6 +47795,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -45744,6 +47813,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -45763,6 +47833,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -45782,6 +47853,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -45815,6 +47887,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -45832,6 +47905,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -45861,6 +47935,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d DefaultValue: Sort.Newest, Summary:
Default Value: newest, + ParameterName: sort, ArgumentName: sort }, { @@ -45880,6 +47955,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -45899,6 +47975,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -45932,6 +48009,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -45949,6 +48027,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -45963,6 +48042,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d }, IsRequired: false, Summary: Optional parameter to specify the organization name if forking into an organization., + ParameterName: organization, ArgumentName: organization }, { @@ -45977,6 +48057,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d }, IsRequired: false, Summary: When forking from an existing repository, a new name for the fork., + ParameterName: name, ArgumentName: name }, { @@ -45991,6 +48072,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d }, IsRequired: false, Summary: When forking from an existing repository, fork with only the default branch., + ParameterName: defaultBranchOnly, ArgumentName: defaultBranchOnly } ], @@ -46025,6 +48107,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -46042,6 +48125,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -46056,6 +48140,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d }, IsRequired: true, Summary: The new blob's content., + ParameterName: content, ArgumentName: content }, { @@ -46073,6 +48158,7 @@ For more information about pattern matching syntax, see the [Ruby File.fnmatch d Summary: The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported.
Default Value: utf-8, + ParameterName: encoding, ArgumentName: encoding } ], @@ -46107,6 +48193,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -46124,6 +48211,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -46141,6 +48229,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: fileSha, ArgumentName: fileSha } ], @@ -46174,6 +48263,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -46191,6 +48281,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -46205,6 +48296,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support }, IsRequired: true, Summary: The commit message, + ParameterName: message, ArgumentName: message }, { @@ -46219,6 +48311,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support }, IsRequired: true, Summary: The SHA of the tree object this commit points to, + ParameterName: tree, ArgumentName: tree }, { @@ -46233,6 +48326,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support }, IsRequired: false, Summary: The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided., + ParameterName: parents, ArgumentName: parents }, { @@ -46247,6 +48341,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support }, IsRequired: false, Summary: Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details., + ParameterName: author, ArgumentName: author }, { @@ -46261,6 +48356,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support }, IsRequired: false, Summary: Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details., + ParameterName: committer, ArgumentName: committer }, { @@ -46275,6 +48371,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support }, IsRequired: false, Summary: The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits., + ParameterName: signature, ArgumentName: signature } ], @@ -46309,6 +48406,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -46326,6 +48424,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -46343,6 +48442,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commitSha, ArgumentName: commitSha } ], @@ -46376,6 +48476,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -46393,6 +48494,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -46410,6 +48512,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ref, ArgumentName: ref } ], @@ -46443,6 +48546,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -46460,6 +48564,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -46477,6 +48582,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ref, ArgumentName: ref } ], @@ -46510,6 +48616,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -46527,6 +48634,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -46541,6 +48649,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support }, IsRequired: true, Summary: The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected., + ParameterName: ref, ArgumentName: ref }, { @@ -46555,6 +48664,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support }, IsRequired: true, Summary: The SHA1 value for this reference., + ParameterName: sha, ArgumentName: sha } ], @@ -46589,6 +48699,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -46606,6 +48717,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -46623,6 +48735,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ref, ArgumentName: ref }, { @@ -46637,6 +48750,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support }, IsRequired: true, Summary: The SHA1 value to set this reference to, + ParameterName: sha, ArgumentName: sha }, { @@ -46654,6 +48768,7 @@ The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are support Summary: Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.
Default Value: false, + ParameterName: force, ArgumentName: force } ], @@ -46688,6 +48803,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -46705,6 +48821,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -46722,6 +48839,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ref, ArgumentName: ref } ], @@ -46756,6 +48874,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -46773,6 +48892,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -46787,6 +48907,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa }, IsRequired: true, Summary: The tag's name. This is typically a version (e.g., "v0.0.1")., + ParameterName: tag, ArgumentName: tag }, { @@ -46801,6 +48922,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa }, IsRequired: true, Summary: The tag message., + ParameterName: message, ArgumentName: message }, { @@ -46815,6 +48937,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa }, IsRequired: true, Summary: The SHA of the git object this is tagging., + ParameterName: object, ArgumentName: object }, { @@ -46837,6 +48960,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa }, IsRequired: true, Summary: The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`., + ParameterName: type, ArgumentName: type }, { @@ -46851,6 +48975,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa }, IsRequired: false, Summary: An object with information about the individual creating the tag., + ParameterName: tagger, ArgumentName: tagger } ], @@ -46885,6 +49010,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -46902,6 +49028,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -46919,6 +49046,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: tagSha, ArgumentName: tagSha } ], @@ -46952,6 +49080,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -46969,6 +49098,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -46983,6 +49113,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa }, IsRequired: true, Summary: Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure., + ParameterName: tree, ArgumentName: tree }, { @@ -47000,6 +49131,7 @@ Indicates whether to force the update or to make sure the update is a fast-forwa The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. , + ParameterName: baseTree, ArgumentName: baseTree } ], @@ -47034,6 +49166,7 @@ If not provided, GitHub will create a new Git tree object from only the entries ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -47051,6 +49184,7 @@ If not provided, GitHub will create a new Git tree object from only the entries ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -47068,6 +49202,7 @@ If not provided, GitHub will create a new Git tree object from only the entries ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: treeSha, ArgumentName: treeSha }, { @@ -47085,6 +49220,7 @@ If not provided, GitHub will create a new Git tree object from only the entries ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: recursive, ArgumentName: recursive } ], @@ -47118,6 +49254,7 @@ If not provided, GitHub will create a new Git tree object from only the entries ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -47135,6 +49272,7 @@ If not provided, GitHub will create a new Git tree object from only the entries ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -47154,6 +49292,7 @@ If not provided, GitHub will create a new Git tree object from only the entries DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -47173,6 +49312,7 @@ If not provided, GitHub will create a new Git tree object from only the entries DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -47206,6 +49346,7 @@ If not provided, GitHub will create a new Git tree object from only the entries ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -47223,6 +49364,7 @@ If not provided, GitHub will create a new Git tree object from only the entries ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -47237,6 +49379,7 @@ If not provided, GitHub will create a new Git tree object from only the entries }, IsRequired: false, Summary: Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`., + ParameterName: name, ArgumentName: name }, { @@ -47251,6 +49394,7 @@ If not provided, GitHub will create a new Git tree object from only the entries }, IsRequired: false, Summary: Key/value pairs to provide settings for this webhook., + ParameterName: config, ArgumentName: config }, { @@ -47268,6 +49412,7 @@ If not provided, GitHub will create a new Git tree object from only the entries Summary: Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.
Default Value: [push], + ParameterName: events, ArgumentName: events }, { @@ -47285,6 +49430,7 @@ Determines what [events](https://docs.github.com/webhooks/event-payloads) the ho Summary: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
Default Value: true, + ParameterName: active, ArgumentName: active } ], @@ -47319,6 +49465,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -47336,6 +49483,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -47353,6 +49501,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId } ], @@ -47386,6 +49535,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -47403,6 +49553,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -47420,6 +49571,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId }, { @@ -47439,6 +49591,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true }, IsRequired: false, Summary: Configuration object of the webhook, + ParameterName: config, ArgumentName: config }, { @@ -47456,6 +49609,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true Summary: Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.
Default Value: [push], + ParameterName: events, ArgumentName: events }, { @@ -47470,6 +49624,7 @@ Determines what [events](https://docs.github.com/webhooks/event-payloads) the ho }, IsRequired: false, Summary: Determines a list of events to be added to the list of events that the Hook triggers for., + ParameterName: addEvents, ArgumentName: addEvents }, { @@ -47484,6 +49639,7 @@ Determines what [events](https://docs.github.com/webhooks/event-payloads) the ho }, IsRequired: false, Summary: Determines a list of events to be removed from the list of events that the Hook triggers for., + ParameterName: removeEvents, ArgumentName: removeEvents }, { @@ -47501,6 +49657,7 @@ Determines what [events](https://docs.github.com/webhooks/event-payloads) the ho Summary: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
Default Value: true, + ParameterName: active, ArgumentName: active } ], @@ -47535,6 +49692,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -47552,6 +49710,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -47569,6 +49728,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId } ], @@ -47603,6 +49763,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -47620,6 +49781,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -47637,6 +49799,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId } ], @@ -47670,6 +49833,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -47687,6 +49851,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -47704,6 +49869,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId }, { @@ -47720,6 +49886,7 @@ Determines if notifications are sent when the webhook is triggered. Set to `true Summary: The URL to which the payloads will be delivered.
Example: https://example.com/webhook, + ParameterName: url, ArgumentName: url }, { @@ -47736,6 +49903,7 @@ The URL to which the payloads will be delivered. Summary: The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
Example: "json", + ParameterName: contentType, ArgumentName: contentType }, { @@ -47752,6 +49920,7 @@ The media type used to serialize the payloads. Supported values include `json` a Summary: If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).
Example: "********", + ParameterName: secret, ArgumentName: secret }, { @@ -47766,6 +49935,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig }, IsRequired: false, Summary: , + ParameterName: insecureSsl, ArgumentName: insecureSsl } ], @@ -47800,6 +49970,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -47817,6 +49988,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -47834,6 +50006,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId }, { @@ -47853,6 +50026,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -47870,6 +50044,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: cursor, ArgumentName: cursor }, { @@ -47887,6 +50062,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: redelivery, ArgumentName: redelivery } ], @@ -47920,6 +50096,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -47937,6 +50114,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -47954,6 +50132,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId }, { @@ -47971,6 +50150,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deliveryId, ArgumentName: deliveryId } ], @@ -48004,6 +50184,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48021,6 +50202,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -48038,6 +50220,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId }, { @@ -48055,6 +50238,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deliveryId, ArgumentName: deliveryId } ], @@ -48089,6 +50273,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48106,6 +50291,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -48123,6 +50309,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId } ], @@ -48157,6 +50344,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48174,6 +50362,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -48191,6 +50380,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: hookId, ArgumentName: hookId } ], @@ -48225,6 +50415,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48242,6 +50433,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -48275,6 +50467,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48292,6 +50485,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -48306,6 +50500,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig }, IsRequired: true, Summary: The URL of the originating repository., + ParameterName: vcsUrl, ArgumentName: vcsUrl }, { @@ -48330,6 +50525,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig }, IsRequired: false, Summary: The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response., + ParameterName: vcs, ArgumentName: vcs }, { @@ -48344,6 +50540,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig }, IsRequired: false, Summary: If authentication is required, the username to provide to `vcs_url`., + ParameterName: vcsUsername, ArgumentName: vcsUsername }, { @@ -48358,6 +50555,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig }, IsRequired: false, Summary: If authentication is required, the password to provide to `vcs_url`., + ParameterName: vcsPassword, ArgumentName: vcsPassword }, { @@ -48372,6 +50570,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig }, IsRequired: false, Summary: For a tfvc import, the name of the project that is being imported., + ParameterName: tfvcProject, ArgumentName: tfvcProject } ], @@ -48406,6 +50605,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48423,6 +50623,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -48437,6 +50638,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig }, IsRequired: false, Summary: The username to provide to the originating repository., + ParameterName: vcsUsername, ArgumentName: vcsUsername }, { @@ -48451,6 +50653,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig }, IsRequired: false, Summary: The password to provide to the originating repository., + ParameterName: vcsPassword, ArgumentName: vcsPassword }, { @@ -48477,6 +50680,7 @@ If provided, the `secret` will be used as the `key` to generate the HMAC hex dig Summary: The type of version control system you are migrating from.
Example: "git", + ParameterName: vcs, ArgumentName: vcs }, { @@ -48493,6 +50697,7 @@ The type of version control system you are migrating from. Summary: For a tfvc import, the name of the project that is being imported.
Example: "project1", + ParameterName: tfvcProject, ArgumentName: tfvcProject } ], @@ -48527,6 +50732,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48544,6 +50750,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -48578,6 +50785,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48595,6 +50803,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -48612,6 +50821,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since } ], @@ -48645,6 +50855,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48662,6 +50873,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -48679,6 +50891,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: authorId, ArgumentName: authorId }, { @@ -48693,6 +50906,7 @@ For a tfvc import, the name of the project that is being imported. }, IsRequired: false, Summary: The new Git author email., + ParameterName: email, ArgumentName: email }, { @@ -48707,6 +50921,7 @@ For a tfvc import, the name of the project that is being imported. }, IsRequired: false, Summary: The new Git author name., + ParameterName: name, ArgumentName: name } ], @@ -48741,6 +50956,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48758,6 +50974,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -48791,6 +51008,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48808,6 +51026,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -48828,6 +51047,7 @@ For a tfvc import, the name of the project that is being imported. }, IsRequired: true, Summary: Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import., + ParameterName: useLfs, ArgumentName: useLfs } ], @@ -48862,6 +51082,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48879,6 +51100,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -48912,6 +51134,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48929,6 +51152,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -48962,6 +51186,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -48979,6 +51204,7 @@ For a tfvc import, the name of the project that is being imported. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -49003,6 +51229,7 @@ For a tfvc import, the name of the project that is being imported. Summary: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.
Example: collaborators_only, + ParameterName: limit, ArgumentName: limit }, { @@ -49031,6 +51258,7 @@ The type of GitHub user that can comment, open issues, or create pull requests w Summary: The duration of the interaction restriction. Default: `one_day`.
Example: one_month, + ParameterName: expiry, ArgumentName: expiry } ], @@ -49065,6 +51293,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -49082,6 +51311,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -49116,6 +51346,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -49133,6 +51364,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -49152,6 +51384,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -49171,6 +51404,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -49204,6 +51438,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -49221,6 +51456,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -49238,6 +51474,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: invitationId, ArgumentName: invitationId }, { @@ -49264,6 +51501,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: false, Summary: The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`., + ParameterName: permissions, ArgumentName: permissions } ], @@ -49298,6 +51536,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -49315,6 +51554,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -49332,6 +51572,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: invitationId, ArgumentName: invitationId } ], @@ -49366,6 +51607,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -49383,6 +51625,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -49400,6 +51643,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: milestone, ArgumentName: milestone }, { @@ -49427,6 +51671,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: State.Open, Summary:
Default Value: open, + ParameterName: state, ArgumentName: state }, { @@ -49444,6 +51689,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: assignee, ArgumentName: assignee }, { @@ -49461,6 +51707,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: creator, ArgumentName: creator }, { @@ -49478,6 +51725,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: mentioned, ArgumentName: mentioned }, { @@ -49495,6 +51743,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: labels, ArgumentName: labels }, { @@ -49522,6 +51771,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -49547,6 +51797,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -49564,6 +51815,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -49583,6 +51835,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -49602,6 +51855,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -49635,6 +51889,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -49652,6 +51907,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -49666,6 +51922,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: true, Summary: The title of the issue., + ParameterName: title, ArgumentName: title }, { @@ -49680,6 +51937,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: false, Summary: The contents of the issue., + ParameterName: body, ArgumentName: body }, { @@ -49694,6 +51952,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: false, Summary: Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_, + ParameterName: assignee, ArgumentName: assignee }, { @@ -49709,6 +51968,7 @@ The duration of the interaction restriction. Default: `one_day`. IsRequired: false, DefaultValue: , Summary: , + ParameterName: milestone, ArgumentName: milestone }, { @@ -49723,6 +51983,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: false, Summary: Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._, + ParameterName: labels, ArgumentName: labels }, { @@ -49737,6 +51998,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: false, Summary: Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._, + ParameterName: assignees, ArgumentName: assignees } ], @@ -49771,6 +52033,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -49788,6 +52051,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -49813,6 +52077,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -49836,6 +52101,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: direction, ArgumentName: direction }, { @@ -49853,6 +52119,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -49872,6 +52139,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -49891,6 +52159,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -49924,6 +52193,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -49941,6 +52211,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -49958,6 +52229,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId } ], @@ -49991,6 +52263,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -50008,6 +52281,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -50025,6 +52299,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -50039,6 +52314,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: true, Summary: The contents of the comment., + ParameterName: body, ArgumentName: body } ], @@ -50073,6 +52349,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -50090,6 +52367,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -50107,6 +52385,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId } ], @@ -50141,6 +52420,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -50158,6 +52438,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -50175,6 +52456,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -50210,6 +52492,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -50229,6 +52512,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -50248,6 +52532,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -50281,6 +52566,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -50298,6 +52584,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -50315,6 +52602,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -50347,6 +52635,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: true, Summary: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment., + ParameterName: content, ArgumentName: content } ], @@ -50381,6 +52670,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -50398,6 +52688,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -50415,6 +52706,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -50432,6 +52724,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reactionId, ArgumentName: reactionId } ], @@ -50466,6 +52759,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -50483,6 +52777,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -50502,6 +52797,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -50521,6 +52817,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -50554,6 +52851,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -50571,6 +52869,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -50588,6 +52887,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: eventId, ArgumentName: eventId } ], @@ -50621,6 +52921,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -50638,6 +52939,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -50655,6 +52957,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber } ], @@ -50688,6 +52991,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -50705,6 +53009,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -50722,6 +53027,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -50737,6 +53043,7 @@ The duration of the interaction restriction. Default: `one_day`. IsRequired: false, DefaultValue: , Summary: The title of the issue., + ParameterName: title, ArgumentName: title }, { @@ -50751,6 +53058,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: false, Summary: The contents of the issue., + ParameterName: body, ArgumentName: body }, { @@ -50765,6 +53073,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: false, Summary: Username to assign to this issue. **This field is deprecated.**, + ParameterName: assignee, ArgumentName: assignee }, { @@ -50785,6 +53094,7 @@ The duration of the interaction restriction. Default: `one_day`. }, IsRequired: false, Summary: The open or closed state of the issue., + ParameterName: state, ArgumentName: state }, { @@ -50809,6 +53119,7 @@ The duration of the interaction restriction. Default: `one_day`. Summary: The reason for the state change. Ignored unless `state` is changed.
Example: not_planned, + ParameterName: stateReason, ArgumentName: stateReason }, { @@ -50824,6 +53135,7 @@ The reason for the state change. Ignored unless `state` is changed. IsRequired: false, DefaultValue: , Summary: , + ParameterName: milestone, ArgumentName: milestone }, { @@ -50838,6 +53150,7 @@ The reason for the state change. Ignored unless `state` is changed. }, IsRequired: false, Summary: Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped., + ParameterName: labels, ArgumentName: labels }, { @@ -50852,6 +53165,7 @@ The reason for the state change. Ignored unless `state` is changed. }, IsRequired: false, Summary: Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped., + ParameterName: assignees, ArgumentName: assignees } ], @@ -50886,6 +53200,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -50903,6 +53218,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -50920,6 +53236,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -50934,6 +53251,7 @@ The reason for the state change. Ignored unless `state` is changed. }, IsRequired: false, Summary: Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._, + ParameterName: assignees, ArgumentName: assignees } ], @@ -50968,6 +53286,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -50985,6 +53304,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -51002,6 +53322,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -51016,6 +53337,7 @@ The reason for the state change. Ignored unless `state` is changed. }, IsRequired: false, Summary: Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._, + ParameterName: assignees, ArgumentName: assignees } ], @@ -51050,6 +53372,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -51067,6 +53390,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -51084,6 +53408,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -51101,6 +53426,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: assignee, ArgumentName: assignee } ], @@ -51134,6 +53460,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -51151,6 +53478,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -51168,6 +53496,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -51185,6 +53514,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -51204,6 +53534,7 @@ The reason for the state change. Ignored unless `state` is changed. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -51223,6 +53554,7 @@ The reason for the state change. Ignored unless `state` is changed. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -51256,6 +53588,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -51273,6 +53606,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -51290,6 +53624,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -51304,6 +53639,7 @@ The reason for the state change. Ignored unless `state` is changed. }, IsRequired: true, Summary: The contents of the comment., + ParameterName: body, ArgumentName: body } ], @@ -51338,6 +53674,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -51355,6 +53692,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -51372,6 +53710,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -51391,6 +53730,7 @@ The reason for the state change. Ignored unless `state` is changed. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -51410,6 +53750,7 @@ The reason for the state change. Ignored unless `state` is changed. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -51443,6 +53784,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -51460,6 +53802,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -51477,6 +53820,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -51496,6 +53840,7 @@ The reason for the state change. Ignored unless `state` is changed. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -51515,6 +53860,7 @@ The reason for the state change. Ignored unless `state` is changed. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -51548,6 +53894,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -51565,6 +53912,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -51582,6 +53930,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber } ], @@ -51616,6 +53965,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -51633,6 +53983,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -51650,6 +54001,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber } ], @@ -51684,6 +54036,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -51701,6 +54054,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -51718,6 +54072,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber } ], @@ -51752,6 +54107,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -51769,6 +54125,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -51786,6 +54143,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -51803,6 +54161,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -51837,6 +54196,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -51854,6 +54214,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -51871,6 +54232,7 @@ The reason for the state change. Ignored unless `state` is changed. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -51900,6 +54262,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if * `too heated` * `resolved` * `spam`, + ParameterName: lockReason, ArgumentName: lockReason } ], @@ -51934,6 +54297,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -51951,6 +54315,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -51968,6 +54333,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber } ], @@ -52002,6 +54368,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -52019,6 +54386,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -52036,6 +54404,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -52071,6 +54440,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -52090,6 +54460,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -52109,6 +54480,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -52142,6 +54514,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -52159,6 +54532,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -52176,6 +54550,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -52208,6 +54583,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if }, IsRequired: true, Summary: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue., + ParameterName: content, ArgumentName: content } ], @@ -52242,6 +54618,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -52259,6 +54636,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -52276,6 +54654,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -52293,6 +54672,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reactionId, ArgumentName: reactionId } ], @@ -52327,6 +54707,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -52344,6 +54725,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -52361,6 +54743,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: issueNumber, ArgumentName: issueNumber }, { @@ -52380,6 +54763,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -52399,6 +54783,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -52432,6 +54817,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -52449,6 +54835,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -52468,6 +54855,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -52487,6 +54875,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -52520,6 +54909,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -52537,6 +54927,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -52551,6 +54942,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if }, IsRequired: false, Summary: A name for the key., + ParameterName: title, ArgumentName: title }, { @@ -52565,6 +54957,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if }, IsRequired: true, Summary: The contents of the key., + ParameterName: key, ArgumentName: key }, { @@ -52582,6 +54975,7 @@ The reason for locking the issue or pull request conversation. Lock will fail if If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).", + ParameterName: readOnly, ArgumentName: readOnly } ], @@ -52616,6 +55010,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -52633,6 +55028,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -52650,6 +55046,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: keyId, ArgumentName: keyId } ], @@ -52683,6 +55080,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -52700,6 +55098,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -52717,6 +55116,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: keyId, ArgumentName: keyId } ], @@ -52751,6 +55151,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -52768,6 +55169,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -52787,6 +55189,7 @@ Deploy keys with write access can perform the same actions as an organization me DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -52806,6 +55209,7 @@ Deploy keys with write access can perform the same actions as an organization me DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -52839,6 +55243,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -52856,6 +55261,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -52870,6 +55276,7 @@ Deploy keys with write access can perform the same actions as an organization me }, IsRequired: true, Summary: The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).", + ParameterName: name, ArgumentName: name }, { @@ -52884,6 +55291,7 @@ Deploy keys with write access can perform the same actions as an organization me }, IsRequired: false, Summary: The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`., + ParameterName: color, ArgumentName: color }, { @@ -52898,6 +55306,7 @@ Deploy keys with write access can perform the same actions as an organization me }, IsRequired: false, Summary: A short description of the label. Must be 100 characters or fewer., + ParameterName: description, ArgumentName: description } ], @@ -52932,6 +55341,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -52949,6 +55359,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -52966,6 +55377,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -52999,6 +55411,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -53016,6 +55429,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -53033,6 +55447,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -53047,6 +55462,7 @@ Deploy keys with write access can perform the same actions as an organization me }, IsRequired: false, Summary: The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).", + ParameterName: newName, ArgumentName: newName }, { @@ -53061,6 +55477,7 @@ Deploy keys with write access can perform the same actions as an organization me }, IsRequired: false, Summary: The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`., + ParameterName: color, ArgumentName: color }, { @@ -53075,6 +55492,7 @@ Deploy keys with write access can perform the same actions as an organization me }, IsRequired: false, Summary: A short description of the label. Must be 100 characters or fewer., + ParameterName: description, ArgumentName: description } ], @@ -53109,6 +55527,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -53126,6 +55545,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -53143,6 +55563,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: name, ArgumentName: name } ], @@ -53177,6 +55598,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -53194,6 +55616,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -53227,6 +55650,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -53244,6 +55668,7 @@ Deploy keys with write access can perform the same actions as an organization me ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -53263,6 +55688,7 @@ Deploy keys with write access can perform the same actions as an organization me Summary: The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`, `refs/heads/<branch name>` or simply `<branch name>`., + ParameterName: ref, ArgumentName: ref } ], @@ -53296,6 +55722,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -53313,6 +55740,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -53327,6 +55755,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< }, IsRequired: true, Summary: The name of the branch which should be updated to match upstream., + ParameterName: branch, ArgumentName: branch } ], @@ -53361,6 +55790,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -53378,6 +55808,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -53392,6 +55823,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< }, IsRequired: true, Summary: The name of the base branch that the head will be merged into., + ParameterName: base, ArgumentName: base }, { @@ -53406,6 +55838,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< }, IsRequired: true, Summary: The head to merge. This can be a branch name or a commit SHA1., + ParameterName: head, ArgumentName: head }, { @@ -53420,6 +55853,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< }, IsRequired: false, Summary: Commit message to use for the merge commit. If omitted, a default message will be used., + ParameterName: commitMessage, ArgumentName: commitMessage } ], @@ -53454,6 +55888,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -53471,6 +55906,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -53498,6 +55934,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< DefaultValue: State.Open, Summary:
Default Value: open, + ParameterName: state, ArgumentName: state }, { @@ -53523,6 +55960,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< DefaultValue: Sort.DueOn, Summary:
Default Value: due_on, + ParameterName: sort, ArgumentName: sort }, { @@ -53548,6 +55986,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< DefaultValue: Direction.Asc, Summary:
Default Value: asc, + ParameterName: direction, ArgumentName: direction }, { @@ -53567,6 +56006,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -53586,6 +56026,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -53619,6 +56060,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -53636,6 +56078,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -53650,6 +56093,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< }, IsRequired: true, Summary: The title of the milestone., + ParameterName: title, ArgumentName: title }, { @@ -53673,6 +56117,7 @@ The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/< Summary: The state of the milestone. Either `open` or `closed`.
Default Value: open, + ParameterName: state, ArgumentName: state }, { @@ -53687,6 +56132,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: A description of the milestone., + ParameterName: description, ArgumentName: description }, { @@ -53701,6 +56147,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`., + ParameterName: dueOn, ArgumentName: dueOn } ], @@ -53735,6 +56182,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -53752,6 +56200,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -53769,6 +56218,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: milestoneNumber, ArgumentName: milestoneNumber } ], @@ -53802,6 +56252,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -53819,6 +56270,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -53836,6 +56288,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: milestoneNumber, ArgumentName: milestoneNumber }, { @@ -53850,6 +56303,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: The title of the milestone., + ParameterName: title, ArgumentName: title }, { @@ -53873,6 +56327,7 @@ The state of the milestone. Either `open` or `closed`. Summary: The state of the milestone. Either `open` or `closed`.
Default Value: open, + ParameterName: state, ArgumentName: state }, { @@ -53887,6 +56342,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: A description of the milestone., + ParameterName: description, ArgumentName: description }, { @@ -53901,6 +56357,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`., + ParameterName: dueOn, ArgumentName: dueOn } ], @@ -53935,6 +56392,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -53952,6 +56410,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -53969,6 +56428,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: milestoneNumber, ArgumentName: milestoneNumber } ], @@ -54003,6 +56463,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -54020,6 +56481,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -54037,6 +56499,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: milestoneNumber, ArgumentName: milestoneNumber }, { @@ -54056,6 +56519,7 @@ The state of the milestone. Either `open` or `closed`. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -54075,6 +56539,7 @@ The state of the milestone. Either `open` or `closed`. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -54108,6 +56573,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -54125,6 +56591,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -54144,6 +56611,7 @@ The state of the milestone. Either `open` or `closed`. DefaultValue: false, Summary:
Default Value: false, + ParameterName: all, ArgumentName: all }, { @@ -54163,6 +56631,7 @@ The state of the milestone. Either `open` or `closed`. DefaultValue: false, Summary:
Default Value: false, + ParameterName: participating, ArgumentName: participating }, { @@ -54180,6 +56649,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -54197,6 +56667,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -54216,6 +56687,7 @@ The state of the milestone. Either `open` or `closed`. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -54235,6 +56707,7 @@ The state of the milestone. Either `open` or `closed`. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -54268,6 +56741,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -54285,6 +56759,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -54299,6 +56774,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp., + ParameterName: lastReadAt, ArgumentName: lastReadAt } ], @@ -54333,6 +56809,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -54350,6 +56827,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -54383,6 +56861,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -54400,6 +56879,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -54420,6 +56900,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`., + ParameterName: buildType, ArgumentName: buildType }, { @@ -54434,6 +56915,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: The source branch and directory used to publish your Pages site., + ParameterName: source, ArgumentName: source } ], @@ -54468,6 +56950,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -54485,6 +56968,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -54499,6 +56983,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/pages/configuring-a-custom-domain-for-your-github-pages-site).", + ParameterName: cname, ArgumentName: cname }, { @@ -54513,6 +56998,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: Specify whether HTTPS should be enforced for the repository., + ParameterName: httpsEnforced, ArgumentName: httpsEnforced }, { @@ -54533,6 +57019,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch., + ParameterName: buildType, ArgumentName: buildType }, { @@ -54548,6 +57035,7 @@ The state of the milestone. Either `open` or `closed`. IsRequired: false, DefaultValue: , Summary: , + ParameterName: source, ArgumentName: source } ], @@ -54582,6 +57070,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -54599,6 +57088,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -54633,6 +57123,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -54650,6 +57141,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -54669,6 +57161,7 @@ The state of the milestone. Either `open` or `closed`. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -54688,6 +57181,7 @@ The state of the milestone. Either `open` or `closed`. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -54721,6 +57215,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -54738,6 +57233,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -54772,6 +57268,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -54789,6 +57286,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -54822,6 +57320,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -54839,6 +57338,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -54856,6 +57356,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: buildId, ArgumentName: buildId } ], @@ -54889,6 +57390,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -54906,6 +57408,7 @@ The state of the milestone. Either `open` or `closed`. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -54920,6 +57423,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required., + ParameterName: artifactId, ArgumentName: artifactId }, { @@ -54934,6 +57438,7 @@ The state of the milestone. Either `open` or `closed`. }, IsRequired: false, Summary: The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required., + ParameterName: artifactUrl, ArgumentName: artifactUrl }, { @@ -54951,6 +57456,7 @@ The state of the milestone. Either `open` or `closed`. Summary: The target environment for this GitHub Pages deployment.
Default Value: github-pages, + ParameterName: environment, ArgumentName: environment }, { @@ -54968,6 +57474,7 @@ The target environment for this GitHub Pages deployment. Summary: A unique string that represents the version of the build for this deployment.
Default Value: GITHUB_SHA, + ParameterName: pagesBuildVersion, ArgumentName: pagesBuildVersion }, { @@ -54982,6 +57489,7 @@ A unique string that represents the version of the build for this deployment. }, IsRequired: true, Summary: The OIDC token issued by GitHub Actions certifying the origin of the deployment., + ParameterName: oidcToken, ArgumentName: oidcToken } ], @@ -55016,6 +57524,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -55033,6 +57542,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -55050,6 +57560,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pagesDeploymentId, ArgumentName: pagesDeploymentId } ], @@ -55083,6 +57594,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -55100,6 +57612,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -55117,6 +57630,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pagesDeploymentId, ArgumentName: pagesDeploymentId } ], @@ -55151,6 +57665,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -55168,6 +57683,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -55201,6 +57717,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -55218,6 +57735,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -55251,6 +57769,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -55268,6 +57787,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -55302,6 +57822,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -55319,6 +57840,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -55353,6 +57875,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -55370,6 +57893,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -55397,6 +57921,7 @@ A unique string that represents the version of the build for this deployment. DefaultValue: State.Open, Summary:
Default Value: open, + ParameterName: state, ArgumentName: state }, { @@ -55416,6 +57941,7 @@ A unique string that represents the version of the build for this deployment. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -55435,6 +57961,7 @@ A unique string that represents the version of the build for this deployment. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -55468,6 +57995,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -55485,6 +58013,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -55499,6 +58028,7 @@ A unique string that represents the version of the build for this deployment. }, IsRequired: true, Summary: The name of the project., + ParameterName: name, ArgumentName: name }, { @@ -55513,6 +58043,7 @@ A unique string that represents the version of the build for this deployment. }, IsRequired: false, Summary: The description of the project., + ParameterName: body, ArgumentName: body } ], @@ -55547,6 +58078,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -55564,6 +58096,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -55597,6 +58130,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -55614,6 +58148,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -55628,6 +58163,7 @@ A unique string that represents the version of the build for this deployment. }, IsRequired: true, Summary: A list of custom property names and associated values to apply to the repositories., + ParameterName: properties, ArgumentName: properties } ], @@ -55662,6 +58198,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -55679,6 +58216,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -55706,6 +58244,7 @@ A unique string that represents the version of the build for this deployment. DefaultValue: State.Open, Summary:
Default Value: open, + ParameterName: state, ArgumentName: state }, { @@ -55723,6 +58262,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: head, ArgumentName: head }, { @@ -55740,6 +58280,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: base, ArgumentName: base }, { @@ -55769,6 +58310,7 @@ A unique string that represents the version of the build for this deployment. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -55792,6 +58334,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: direction, ArgumentName: direction }, { @@ -55811,6 +58354,7 @@ A unique string that represents the version of the build for this deployment. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -55830,6 +58374,7 @@ A unique string that represents the version of the build for this deployment. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -55863,6 +58408,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -55880,6 +58426,7 @@ A unique string that represents the version of the build for this deployment. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -55894,6 +58441,7 @@ A unique string that represents the version of the build for this deployment. }, IsRequired: false, Summary: The title of the new pull request. Required unless `issue` is specified., + ParameterName: title, ArgumentName: title }, { @@ -55908,6 +58456,7 @@ A unique string that represents the version of the build for this deployment. }, IsRequired: true, Summary: The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`., + ParameterName: head, ArgumentName: head }, { @@ -55924,6 +58473,7 @@ A unique string that represents the version of the build for this deployment. Summary: The name of the repository where the changes in the pull request were made. This field is required for cross-repository pull requests if both repositories are owned by the same organization.
Example: octo-org/octo-repo, + ParameterName: headRepo, ArgumentName: headRepo }, { @@ -55938,6 +58488,7 @@ The name of the repository where the changes in the pull request were made. This }, IsRequired: true, Summary: The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository., + ParameterName: base, ArgumentName: base }, { @@ -55952,6 +58503,7 @@ The name of the repository where the changes in the pull request were made. This }, IsRequired: false, Summary: The contents of the pull request., + ParameterName: body, ArgumentName: body }, { @@ -55966,6 +58518,7 @@ The name of the repository where the changes in the pull request were made. This }, IsRequired: false, Summary: Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request., + ParameterName: maintainerCanModify, ArgumentName: maintainerCanModify }, { @@ -55980,6 +58533,7 @@ The name of the repository where the changes in the pull request were made. This }, IsRequired: false, Summary: Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://docs.github.com/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more., + ParameterName: draft, ArgumentName: draft }, { @@ -55996,6 +58550,7 @@ The name of the repository where the changes in the pull request were made. This Summary: An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.
Example: 1, + ParameterName: issue, ArgumentName: issue } ], @@ -56030,6 +58585,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -56047,6 +58603,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -56072,6 +58629,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: sort, ArgumentName: sort }, { @@ -56095,6 +58653,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: direction, ArgumentName: direction }, { @@ -56112,6 +58671,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -56131,6 +58691,7 @@ An issue in the repository to convert to a pull request. The issue title, body, DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -56150,6 +58711,7 @@ An issue in the repository to convert to a pull request. The issue title, body, DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -56183,6 +58745,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -56200,6 +58763,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -56217,6 +58781,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId } ], @@ -56250,6 +58815,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -56267,6 +58833,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -56284,6 +58851,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -56298,6 +58866,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: true, Summary: The text of the reply to the review comment., + ParameterName: body, ArgumentName: body } ], @@ -56332,6 +58901,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -56349,6 +58919,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -56366,6 +58937,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId } ], @@ -56400,6 +58972,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -56417,6 +58990,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -56434,6 +59008,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -56469,6 +59044,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -56488,6 +59064,7 @@ An issue in the repository to convert to a pull request. The issue title, body, DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -56507,6 +59084,7 @@ An issue in the repository to convert to a pull request. The issue title, body, DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -56540,6 +59118,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -56557,6 +59136,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -56574,6 +59154,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -56606,6 +59187,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: true, Summary: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the pull request review comment., + ParameterName: content, ArgumentName: content } ], @@ -56640,6 +59222,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -56657,6 +59240,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -56674,6 +59258,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -56691,6 +59276,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reactionId, ArgumentName: reactionId } ], @@ -56725,6 +59311,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -56742,6 +59329,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -56759,6 +59347,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber } ], @@ -56792,6 +59381,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -56809,6 +59399,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -56826,6 +59417,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -56840,6 +59432,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: The title of the pull request., + ParameterName: title, ArgumentName: title }, { @@ -56854,6 +59447,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: The contents of the pull request., + ParameterName: body, ArgumentName: body }, { @@ -56874,6 +59468,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: State of this Pull Request. Either `open` or `closed`., + ParameterName: state, ArgumentName: state }, { @@ -56888,6 +59483,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository., + ParameterName: base, ArgumentName: base }, { @@ -56902,6 +59498,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request., + ParameterName: maintainerCanModify, ArgumentName: maintainerCanModify } ], @@ -56936,6 +59533,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -56953,6 +59551,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -56970,6 +59569,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -56984,6 +59584,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided., + ParameterName: location, ArgumentName: location }, { @@ -57008,6 +59609,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is being deprecated., + ParameterName: geo, ArgumentName: geo }, { @@ -57022,6 +59624,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: IP for location auto-detection when proxying a request, + ParameterName: clientIp, ArgumentName: clientIp }, { @@ -57036,6 +59639,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: Machine type to use for this codespace, + ParameterName: machine, ArgumentName: machine }, { @@ -57050,6 +59654,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: Path to devcontainer.json config to use for this codespace, + ParameterName: devcontainerPath, ArgumentName: devcontainerPath }, { @@ -57064,6 +59669,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: Whether to authorize requested permissions from devcontainer.json, + ParameterName: multiRepoPermissionsOptOut, ArgumentName: multiRepoPermissionsOptOut }, { @@ -57078,6 +59684,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: Working directory for this codespace, + ParameterName: workingDirectory, ArgumentName: workingDirectory }, { @@ -57092,6 +59699,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: Time in minutes before codespace stops from inactivity, + ParameterName: idleTimeoutMinutes, ArgumentName: idleTimeoutMinutes }, { @@ -57106,6 +59714,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: Display name for this codespace, + ParameterName: displayName, ArgumentName: displayName }, { @@ -57120,6 +59729,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days)., + ParameterName: retentionPeriodMinutes, ArgumentName: retentionPeriodMinutes } ], @@ -57154,6 +59764,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -57171,6 +59782,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -57188,6 +59800,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -57213,6 +59826,7 @@ An issue in the repository to convert to a pull request. The issue title, body, DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -57236,6 +59850,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: direction, ArgumentName: direction }, { @@ -57253,6 +59868,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -57272,6 +59888,7 @@ An issue in the repository to convert to a pull request. The issue title, body, DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -57291,6 +59908,7 @@ An issue in the repository to convert to a pull request. The issue title, body, DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -57324,6 +59942,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -57341,6 +59960,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -57358,6 +59978,7 @@ An issue in the repository to convert to a pull request. The issue title, body, ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -57372,6 +59993,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: true, Summary: The text of the review comment., + ParameterName: body, ArgumentName: body }, { @@ -57386,6 +60008,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: true, Summary: The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`., + ParameterName: commitId, ArgumentName: commitId }, { @@ -57400,6 +60023,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: true, Summary: The relative path to the file that necessitates a comment., + ParameterName: path, ArgumentName: path }, { @@ -57414,6 +60038,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file., + ParameterName: position, ArgumentName: position }, { @@ -57434,6 +60059,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://docs.github.com/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation., + ParameterName: side, ArgumentName: side }, { @@ -57448,6 +60074,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: **Required unless using `subject_type:file`**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to., + ParameterName: line, ArgumentName: line }, { @@ -57462,6 +60089,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: **Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation., + ParameterName: startLine, ArgumentName: startLine }, { @@ -57484,6 +60112,7 @@ An issue in the repository to convert to a pull request. The issue title, body, }, IsRequired: false, Summary: **Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://docs.github.com/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context., + ParameterName: startSide, ArgumentName: startSide }, { @@ -57500,6 +60129,7 @@ An issue in the repository to convert to a pull request. The issue title, body, Summary: The ID of the review comment to reply to. To find the ID of a review comment with ["List review comments on a pull request"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.
Example: 2, + ParameterName: inReplyTo, ArgumentName: inReplyTo }, { @@ -57520,6 +60150,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: The level at which the comment is targeted., + ParameterName: subjectType, ArgumentName: subjectType } ], @@ -57554,6 +60185,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -57571,6 +60203,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -57588,6 +60221,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -57605,6 +60239,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentId, ArgumentName: commentId }, { @@ -57619,6 +60254,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: true, Summary: The text of the review comment., + ParameterName: body, ArgumentName: body } ], @@ -57653,6 +60289,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -57670,6 +60307,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -57687,6 +60325,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -57706,6 +60345,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -57725,6 +60365,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -57758,6 +60399,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -57775,6 +60417,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -57792,6 +60435,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -57811,6 +60455,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -57830,6 +60475,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -57863,6 +60509,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -57880,6 +60527,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -57897,6 +60545,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber } ], @@ -57930,6 +60579,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -57947,6 +60597,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -57964,6 +60615,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -57978,6 +60630,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: Title for the automatic commit message., + ParameterName: commitTitle, ArgumentName: commitTitle }, { @@ -57992,6 +60645,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: Extra detail to append to automatic commit message., + ParameterName: commitMessage, ArgumentName: commitMessage }, { @@ -58006,6 +60660,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: SHA that pull request head must match to allow merge., + ParameterName: sha, ArgumentName: sha }, { @@ -58028,6 +60683,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: The merge method to use., + ParameterName: mergeMethod, ArgumentName: mergeMethod } ], @@ -58062,6 +60718,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -58079,6 +60736,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -58096,6 +60754,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber } ], @@ -58129,6 +60788,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -58146,6 +60806,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -58163,6 +60824,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -58177,6 +60839,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: An array of user `login`s that will be requested., + ParameterName: reviewers, ArgumentName: reviewers }, { @@ -58191,6 +60854,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: An array of team `slug`s that will be requested., + ParameterName: teamReviewers, ArgumentName: teamReviewers } ], @@ -58225,6 +60889,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -58242,6 +60907,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -58259,6 +60925,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -58273,6 +60940,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: true, Summary: An array of user `login`s that will be removed., + ParameterName: reviewers, ArgumentName: reviewers }, { @@ -58287,6 +60955,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: An array of team `slug`s that will be removed., + ParameterName: teamReviewers, ArgumentName: teamReviewers } ], @@ -58321,6 +60990,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -58338,6 +61008,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -58355,6 +61026,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -58374,6 +61046,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -58393,6 +61066,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -58426,6 +61100,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -58443,6 +61118,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -58460,6 +61136,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -58474,6 +61151,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value., + ParameterName: commitId, ArgumentName: commitId }, { @@ -58488,6 +61166,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review., + ParameterName: body, ArgumentName: body }, { @@ -58510,6 +61189,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request) when you are ready., + ParameterName: @event, ArgumentName: @event }, { @@ -58524,6 +61204,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: Use the following table to specify the location, destination, and contents of the draft review comment., + ParameterName: comments, ArgumentName: comments } ], @@ -58558,6 +61239,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -58575,6 +61257,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -58592,6 +61275,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -58609,6 +61293,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reviewId, ArgumentName: reviewId } ], @@ -58642,6 +61327,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -58659,6 +61345,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -58676,6 +61363,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -58693,6 +61381,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reviewId, ArgumentName: reviewId }, { @@ -58707,6 +61396,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: true, Summary: The body text of the pull request review., + ParameterName: body, ArgumentName: body } ], @@ -58741,6 +61431,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -58758,6 +61449,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -58775,6 +61467,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -58792,6 +61485,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reviewId, ArgumentName: reviewId } ], @@ -58826,6 +61520,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -58843,6 +61538,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -58860,6 +61556,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -58877,6 +61574,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reviewId, ArgumentName: reviewId }, { @@ -58896,6 +61594,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -58915,6 +61614,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -58948,6 +61648,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -58965,6 +61666,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -58982,6 +61684,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -58999,6 +61702,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reviewId, ArgumentName: reviewId }, { @@ -59013,6 +61717,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: true, Summary: The message for the pull request review dismissal, + ParameterName: message, ArgumentName: message }, { @@ -59032,6 +61737,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit IsRequired: false, Summary:
Example: "DISMISS", + ParameterName: @event, ArgumentName: @event } ], @@ -59066,6 +61772,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -59083,6 +61790,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -59100,6 +61808,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -59117,6 +61826,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reviewId, ArgumentName: reviewId }, { @@ -59131,6 +61841,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: The body text of the pull request review, + ParameterName: body, ArgumentName: body }, { @@ -59153,6 +61864,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: true, Summary: The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action., + ParameterName: @event, ArgumentName: @event } ], @@ -59187,6 +61899,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -59204,6 +61917,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -59221,6 +61935,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: pullNumber, ArgumentName: pullNumber }, { @@ -59235,6 +61950,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref., + ParameterName: expectedHeadSha, ArgumentName: expectedHeadSha } ], @@ -59269,6 +61985,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -59286,6 +62003,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -59303,6 +62021,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: ref, ArgumentName: ref } ], @@ -59336,6 +62055,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -59353,6 +62073,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -59370,6 +62091,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: dir, ArgumentName: dir }, { @@ -59387,6 +62109,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: ref, ArgumentName: ref } ], @@ -59420,6 +62143,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -59437,6 +62161,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -59456,6 +62181,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -59475,6 +62201,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -59508,6 +62235,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -59525,6 +62253,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -59539,6 +62268,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: true, Summary: The name of the tag., + ParameterName: tagName, ArgumentName: tagName }, { @@ -59553,6 +62283,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch., + ParameterName: targetCommitish, ArgumentName: targetCommitish }, { @@ -59567,6 +62298,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: The name of the release., + ParameterName: name, ArgumentName: name }, { @@ -59581,6 +62313,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: Text describing the contents of the tag., + ParameterName: body, ArgumentName: body }, { @@ -59598,6 +62331,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit Summary: `true` to create a draft (unpublished) release, `false` to create a published one.
Default Value: false, + ParameterName: draft, ArgumentName: draft }, { @@ -59615,6 +62349,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit Summary: `true` to identify the release as a prerelease. `false` to identify the release as a full release.
Default Value: false, + ParameterName: prerelease, ArgumentName: prerelease }, { @@ -59629,6 +62364,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit }, IsRequired: false, Summary: If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).", + ParameterName: discussionCategoryName, ArgumentName: discussionCategoryName }, { @@ -59646,6 +62382,7 @@ The ID of the review comment to reply to. To find the ID of a review comment wit Summary: Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.
Default Value: false, + ParameterName: generateReleaseNotes, ArgumentName: generateReleaseNotes }, { @@ -59671,6 +62408,7 @@ Whether to automatically generate the name and body for this release. If `name` Summary: Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.
Default Value: true, + ParameterName: makeLatest, ArgumentName: makeLatest } ], @@ -59705,6 +62443,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -59722,6 +62461,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -59739,6 +62479,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: assetId, ArgumentName: assetId } ], @@ -59772,6 +62513,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -59789,6 +62531,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -59806,6 +62549,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: assetId, ArgumentName: assetId }, { @@ -59820,6 +62564,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: false, Summary: The file name of the asset., + ParameterName: name, ArgumentName: name }, { @@ -59834,6 +62579,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: false, Summary: An alternate short description of the asset. Used in place of the filename., + ParameterName: label, ArgumentName: label }, { @@ -59849,6 +62595,7 @@ Specifies whether this release should be set as the latest release for the repos IsRequired: false, Summary:
Example: "uploaded", + ParameterName: state, ArgumentName: state } ], @@ -59883,6 +62630,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -59900,6 +62648,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -59917,6 +62666,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: assetId, ArgumentName: assetId } ], @@ -59951,6 +62701,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -59968,6 +62719,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -59982,6 +62734,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: true, Summary: The tag name for the release. This can be an existing tag or a new one., + ParameterName: tagName, ArgumentName: tagName }, { @@ -59996,6 +62749,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: false, Summary: Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists., + ParameterName: targetCommitish, ArgumentName: targetCommitish }, { @@ -60010,6 +62764,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: false, Summary: The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release., + ParameterName: previousTagName, ArgumentName: previousTagName }, { @@ -60024,6 +62779,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: false, Summary: Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used., + ParameterName: configurationFilePath, ArgumentName: configurationFilePath } ], @@ -60058,6 +62814,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -60075,6 +62832,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -60108,6 +62866,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -60125,6 +62884,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -60142,6 +62902,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: tag, ArgumentName: tag } ], @@ -60175,6 +62936,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -60192,6 +62954,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -60209,6 +62972,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: releaseId, ArgumentName: releaseId } ], @@ -60242,6 +63006,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -60259,6 +63024,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -60276,6 +63042,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: releaseId, ArgumentName: releaseId }, { @@ -60290,6 +63057,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: false, Summary: The name of the tag., + ParameterName: tagName, ArgumentName: tagName }, { @@ -60304,6 +63072,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: false, Summary: Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch., + ParameterName: targetCommitish, ArgumentName: targetCommitish }, { @@ -60318,6 +63087,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: false, Summary: The name of the release., + ParameterName: name, ArgumentName: name }, { @@ -60332,6 +63102,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: false, Summary: Text describing the contents of the tag., + ParameterName: body, ArgumentName: body }, { @@ -60346,6 +63117,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: false, Summary: `true` makes the release a draft, and `false` publishes the release., + ParameterName: draft, ArgumentName: draft }, { @@ -60360,6 +63132,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: false, Summary: `true` to identify the release as a prerelease, `false` to identify the release as a full release., + ParameterName: prerelease, ArgumentName: prerelease }, { @@ -60385,6 +63158,7 @@ Specifies whether this release should be set as the latest release for the repos Summary: Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.
Default Value: true, + ParameterName: makeLatest, ArgumentName: makeLatest }, { @@ -60399,6 +63173,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: false, Summary: If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. If there is already a discussion linked to the release, this parameter is ignored. For more information, see "[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).", + ParameterName: discussionCategoryName, ArgumentName: discussionCategoryName } ], @@ -60433,6 +63208,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -60450,6 +63226,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -60467,6 +63244,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: releaseId, ArgumentName: releaseId } ], @@ -60501,6 +63279,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -60518,6 +63297,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -60535,6 +63315,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: releaseId, ArgumentName: releaseId }, { @@ -60554,6 +63335,7 @@ Specifies whether this release should be set as the latest release for the repos DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -60573,6 +63355,7 @@ Specifies whether this release should be set as the latest release for the repos DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -60606,6 +63389,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -60623,6 +63407,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -60640,6 +63425,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: releaseId, ArgumentName: releaseId }, { @@ -60657,6 +63443,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -60674,6 +63461,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: label, ArgumentName: label } ], @@ -60708,6 +63496,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -60725,6 +63514,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -60742,6 +63532,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: releaseId, ArgumentName: releaseId }, { @@ -60773,6 +63564,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -60792,6 +63584,7 @@ Specifies whether this release should be set as the latest release for the repos DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -60811,6 +63604,7 @@ Specifies whether this release should be set as the latest release for the repos DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -60844,6 +63638,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -60861,6 +63656,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -60878,6 +63674,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: releaseId, ArgumentName: releaseId }, { @@ -60906,6 +63703,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: true, Summary: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the release., + ParameterName: content, ArgumentName: content } ], @@ -60940,6 +63738,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -60957,6 +63756,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -60974,6 +63774,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: releaseId, ArgumentName: releaseId }, { @@ -60991,6 +63792,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: reactionId, ArgumentName: reactionId } ], @@ -61025,6 +63827,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -61042,6 +63845,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -61059,6 +63863,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: branch, ArgumentName: branch }, { @@ -61078,6 +63883,7 @@ Specifies whether this release should be set as the latest release for the repos DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -61097,6 +63903,7 @@ Specifies whether this release should be set as the latest release for the repos DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -61130,6 +63937,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -61147,6 +63955,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -61166,6 +63975,7 @@ Specifies whether this release should be set as the latest release for the repos DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -61185,6 +63995,7 @@ Specifies whether this release should be set as the latest release for the repos DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -61204,6 +64015,7 @@ Specifies whether this release should be set as the latest release for the repos DefaultValue: true, Summary:
Default Value: true, + ParameterName: includesParents, ArgumentName: includesParents } ], @@ -61237,6 +64049,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -61254,6 +64067,7 @@ Specifies whether this release should be set as the latest release for the repos ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -61268,6 +64082,7 @@ Specifies whether this release should be set as the latest release for the repos }, IsRequired: true, Summary: The name of the ruleset., + ParameterName: name, ArgumentName: name }, { @@ -61293,6 +64108,7 @@ Specifies whether this release should be set as the latest release for the repos The target of the ruleset **Note**: The `push` target is in beta and is subject to change., + ParameterName: target, ArgumentName: target }, { @@ -61315,6 +64131,7 @@ The target of the ruleset }, IsRequired: true, Summary: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise)., + ParameterName: enforcement, ArgumentName: enforcement }, { @@ -61329,6 +64146,7 @@ The target of the ruleset }, IsRequired: false, Summary: The actors that can bypass the rules in this ruleset, + ParameterName: bypassActors, ArgumentName: bypassActors }, { @@ -61345,6 +64163,7 @@ The target of the ruleset }, IsRequired: false, Summary: Parameters for a repository ruleset ref name condition, + ParameterName: conditions, ArgumentName: conditions }, { @@ -61359,6 +64178,7 @@ The target of the ruleset }, IsRequired: false, Summary: An array of rules within the ruleset., + ParameterName: rules, ArgumentName: rules } ], @@ -61393,6 +64213,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -61410,6 +64231,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -61427,6 +64249,7 @@ The target of the ruleset ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: ref, ArgumentName: ref }, { @@ -61456,6 +64279,7 @@ The target of the ruleset DefaultValue: TimePeriod.Day, Summary:
Default Value: day, + ParameterName: timePeriod, ArgumentName: timePeriod }, { @@ -61473,6 +64297,7 @@ The target of the ruleset ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: actorName, ArgumentName: actorName }, { @@ -61502,6 +64327,7 @@ The target of the ruleset DefaultValue: RuleSuiteResult.All, Summary:
Default Value: all, + ParameterName: ruleSuiteResult, ArgumentName: ruleSuiteResult }, { @@ -61521,6 +64347,7 @@ The target of the ruleset DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -61540,6 +64367,7 @@ The target of the ruleset DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -61573,6 +64401,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -61590,6 +64419,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -61607,6 +64437,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ruleSuiteId, ArgumentName: ruleSuiteId } ], @@ -61640,6 +64471,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -61657,6 +64489,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -61674,6 +64507,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: rulesetId, ArgumentName: rulesetId }, { @@ -61693,6 +64527,7 @@ The target of the ruleset DefaultValue: true, Summary:
Default Value: true, + ParameterName: includesParents, ArgumentName: includesParents } ], @@ -61726,6 +64561,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -61743,6 +64579,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -61760,6 +64597,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: rulesetId, ArgumentName: rulesetId }, { @@ -61774,6 +64612,7 @@ The target of the ruleset }, IsRequired: false, Summary: The name of the ruleset., + ParameterName: name, ArgumentName: name }, { @@ -61799,6 +64638,7 @@ The target of the ruleset The target of the ruleset **Note**: The `push` target is in beta and is subject to change., + ParameterName: target, ArgumentName: target }, { @@ -61821,6 +64661,7 @@ The target of the ruleset }, IsRequired: false, Summary: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise)., + ParameterName: enforcement, ArgumentName: enforcement }, { @@ -61835,6 +64676,7 @@ The target of the ruleset }, IsRequired: false, Summary: The actors that can bypass the rules in this ruleset, + ParameterName: bypassActors, ArgumentName: bypassActors }, { @@ -61851,6 +64693,7 @@ The target of the ruleset }, IsRequired: false, Summary: Parameters for a repository ruleset ref name condition, + ParameterName: conditions, ArgumentName: conditions }, { @@ -61865,6 +64708,7 @@ The target of the ruleset }, IsRequired: false, Summary: An array of rules within the ruleset., + ParameterName: rules, ArgumentName: rules } ], @@ -61899,6 +64743,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -61916,6 +64761,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -61933,6 +64779,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: rulesetId, ArgumentName: rulesetId } ], @@ -61967,6 +64814,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -61984,6 +64832,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -62007,6 +64856,7 @@ The target of the ruleset ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: state, ArgumentName: state }, { @@ -62024,6 +64874,7 @@ The target of the ruleset ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: secretType, ArgumentName: secretType }, { @@ -62041,6 +64892,7 @@ The target of the ruleset ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: resolution, ArgumentName: resolution }, { @@ -62066,6 +64918,7 @@ The target of the ruleset DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -62091,6 +64944,7 @@ The target of the ruleset DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -62110,6 +64964,7 @@ The target of the ruleset DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -62129,6 +64984,7 @@ The target of the ruleset DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -62146,6 +65002,7 @@ The target of the ruleset ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -62163,6 +65020,7 @@ The target of the ruleset ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -62180,6 +65038,7 @@ The target of the ruleset ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: validity, ArgumentName: validity } ], @@ -62213,6 +65072,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -62230,6 +65090,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -62247,6 +65108,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: The security alert number., + ParameterName: alertNumber, ArgumentName: alertNumber } ], @@ -62280,6 +65142,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -62297,6 +65160,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -62314,6 +65178,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: The security alert number., + ParameterName: alertNumber, ArgumentName: alertNumber }, { @@ -62334,6 +65199,7 @@ The target of the ruleset }, IsRequired: true, Summary: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`., + ParameterName: state, ArgumentName: state }, { @@ -62358,6 +65224,7 @@ The target of the ruleset }, IsRequired: false, Summary: **Required when the `state` is `resolved`.** The reason for resolving the alert., + ParameterName: resolution, ArgumentName: resolution }, { @@ -62372,6 +65239,7 @@ The target of the ruleset }, IsRequired: false, Summary: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`., + ParameterName: resolutionComment, ArgumentName: resolutionComment } ], @@ -62406,6 +65274,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -62423,6 +65292,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -62440,6 +65310,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: The security alert number., + ParameterName: alertNumber, ArgumentName: alertNumber }, { @@ -62459,6 +65330,7 @@ The target of the ruleset DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -62478,6 +65350,7 @@ The target of the ruleset DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -62511,6 +65384,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -62528,6 +65402,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -62553,6 +65428,7 @@ The target of the ruleset DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -62580,6 +65456,7 @@ The target of the ruleset DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -62597,6 +65474,7 @@ The target of the ruleset ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -62614,6 +65492,7 @@ The target of the ruleset ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -62633,6 +65512,7 @@ The target of the ruleset DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -62660,6 +65540,7 @@ The target of the ruleset ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: state, ArgumentName: state } ], @@ -62693,6 +65574,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -62710,6 +65592,7 @@ The target of the ruleset ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -62724,6 +65607,7 @@ The target of the ruleset }, IsRequired: true, Summary: A short summary of the advisory., + ParameterName: summary, ArgumentName: summary }, { @@ -62738,6 +65622,7 @@ The target of the ruleset }, IsRequired: true, Summary: A detailed description of what the advisory impacts., + ParameterName: description, ArgumentName: description }, { @@ -62752,6 +65637,7 @@ The target of the ruleset }, IsRequired: false, Summary: The Common Vulnerabilities and Exposures (CVE) ID., + ParameterName: cveId, ArgumentName: cveId }, { @@ -62766,6 +65652,7 @@ The target of the ruleset }, IsRequired: true, Summary: A product affected by the vulnerability detailed in a repository security advisory., + ParameterName: vulnerabilities, ArgumentName: vulnerabilities }, { @@ -62780,6 +65667,7 @@ The target of the ruleset }, IsRequired: false, Summary: A list of Common Weakness Enumeration (CWE) IDs., + ParameterName: cweIds, ArgumentName: cweIds }, { @@ -62794,6 +65682,7 @@ The target of the ruleset }, IsRequired: false, Summary: A list of users receiving credit for their participation in the security advisory., + ParameterName: credits, ArgumentName: credits }, { @@ -62818,6 +65707,7 @@ The target of the ruleset }, IsRequired: false, Summary: The severity of the advisory. You must choose between setting this field or `cvss_vector_string`., + ParameterName: severity, ArgumentName: severity }, { @@ -62832,6 +65722,7 @@ The target of the ruleset }, IsRequired: false, Summary: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`., + ParameterName: cvssVectorString, ArgumentName: cvssVectorString }, { @@ -62849,6 +65740,7 @@ The target of the ruleset Summary: Whether to create a temporary private fork of the repository to collaborate on a fix.
Default Value: false, + ParameterName: startPrivateFork, ArgumentName: startPrivateFork } ], @@ -62883,6 +65775,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -62900,6 +65793,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -62914,6 +65808,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: true, Summary: A short summary of the advisory., + ParameterName: summary, ArgumentName: summary }, { @@ -62928,6 +65823,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: true, Summary: A detailed description of what the advisory impacts., + ParameterName: description, ArgumentName: description }, { @@ -62942,6 +65838,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: An array of products affected by the vulnerability detailed in a repository security advisory., + ParameterName: vulnerabilities, ArgumentName: vulnerabilities }, { @@ -62956,6 +65853,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: A list of Common Weakness Enumeration (CWE) IDs., + ParameterName: cweIds, ArgumentName: cweIds }, { @@ -62980,6 +65878,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: The severity of the advisory. You must choose between setting this field or `cvss_vector_string`., + ParameterName: severity, ArgumentName: severity }, { @@ -62994,6 +65893,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`., + ParameterName: cvssVectorString, ArgumentName: cvssVectorString }, { @@ -63011,6 +65911,7 @@ Whether to create a temporary private fork of the repository to collaborate on a Summary: Whether to create a temporary private fork of the repository to collaborate on a fix.
Default Value: false, + ParameterName: startPrivateFork, ArgumentName: startPrivateFork } ], @@ -63045,6 +65946,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -63062,6 +65964,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -63079,6 +65982,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ghsaId, ArgumentName: ghsaId } ], @@ -63112,6 +66016,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -63129,6 +66034,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -63146,6 +66052,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ghsaId, ArgumentName: ghsaId }, { @@ -63160,6 +66067,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: A short summary of the advisory., + ParameterName: summary, ArgumentName: summary }, { @@ -63174,6 +66082,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: A detailed description of what the advisory impacts., + ParameterName: description, ArgumentName: description }, { @@ -63188,6 +66097,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: The Common Vulnerabilities and Exposures (CVE) ID., + ParameterName: cveId, ArgumentName: cveId }, { @@ -63202,6 +66112,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: A product affected by the vulnerability detailed in a repository security advisory., + ParameterName: vulnerabilities, ArgumentName: vulnerabilities }, { @@ -63216,6 +66127,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: A list of Common Weakness Enumeration (CWE) IDs., + ParameterName: cweIds, ArgumentName: cweIds }, { @@ -63230,6 +66142,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: A list of users receiving credit for their participation in the security advisory., + ParameterName: credits, ArgumentName: credits }, { @@ -63254,6 +66167,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: The severity of the advisory. You must choose between setting this field or `cvss_vector_string`., + ParameterName: severity, ArgumentName: severity }, { @@ -63268,6 +66182,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`., + ParameterName: cvssVectorString, ArgumentName: cvssVectorString }, { @@ -63290,6 +66205,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: The state of the advisory., + ParameterName: state, ArgumentName: state }, { @@ -63304,6 +66220,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: A list of usernames who have been granted write access to the advisory., + ParameterName: collaboratingUsers, ArgumentName: collaboratingUsers }, { @@ -63318,6 +66235,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: false, Summary: A list of team slugs which have been granted write access to the advisory., + ParameterName: collaboratingTeams, ArgumentName: collaboratingTeams } ], @@ -63352,6 +66270,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -63369,6 +66288,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -63386,6 +66306,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ghsaId, ArgumentName: ghsaId } ], @@ -63420,6 +66341,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -63437,6 +66359,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -63454,6 +66377,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ghsaId, ArgumentName: ghsaId } ], @@ -63488,6 +66412,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -63505,6 +66430,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -63524,6 +66450,7 @@ Whether to create a temporary private fork of the repository to collaborate on a DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -63543,6 +66470,7 @@ Whether to create a temporary private fork of the repository to collaborate on a DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -63576,6 +66504,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -63593,6 +66522,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -63626,6 +66556,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -63643,6 +66574,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -63676,6 +66608,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -63693,6 +66626,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -63726,6 +66660,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -63743,6 +66678,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -63776,6 +66712,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -63793,6 +66730,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -63826,6 +66764,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -63843,6 +66782,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -63860,6 +66800,7 @@ Whether to create a temporary private fork of the repository to collaborate on a ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: sha, ArgumentName: sha }, { @@ -63884,6 +66825,7 @@ Whether to create a temporary private fork of the repository to collaborate on a }, IsRequired: true, Summary: The state of the status., + ParameterName: state, ArgumentName: state }, { @@ -63901,6 +66843,7 @@ Whether to create a temporary private fork of the repository to collaborate on a The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: `http://ci.example.com/user/repo/build/sha`, + ParameterName: targetUrl, ArgumentName: targetUrl }, { @@ -63915,6 +66858,7 @@ For example, if your continuous integration system is posting build status, you }, IsRequired: false, Summary: A short description of the status., + ParameterName: description, ArgumentName: description }, { @@ -63932,6 +66876,7 @@ For example, if your continuous integration system is posting build status, you Summary: A string label to differentiate this status from the status of other systems. This field is case-insensitive.
Default Value: default, + ParameterName: context, ArgumentName: context } ], @@ -63966,6 +66911,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -63983,6 +66929,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -64002,6 +66949,7 @@ A string label to differentiate this status from the status of other systems. Th DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -64021,6 +66969,7 @@ A string label to differentiate this status from the status of other systems. Th DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -64054,6 +67003,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64071,6 +67021,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -64104,6 +67055,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64121,6 +67073,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -64135,6 +67088,7 @@ A string label to differentiate this status from the status of other systems. Th }, IsRequired: false, Summary: Determines if notifications should be received from this repository., + ParameterName: subscribed, ArgumentName: subscribed }, { @@ -64149,6 +67103,7 @@ A string label to differentiate this status from the status of other systems. Th }, IsRequired: false, Summary: Determines if all notifications should be blocked from this repository., + ParameterName: ignored, ArgumentName: ignored } ], @@ -64183,6 +67138,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64200,6 +67156,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -64234,6 +67191,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64251,6 +67209,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -64270,6 +67229,7 @@ A string label to differentiate this status from the status of other systems. Th DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -64289,6 +67249,7 @@ A string label to differentiate this status from the status of other systems. Th DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -64322,6 +67283,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64339,6 +67301,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -64372,6 +67335,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64389,6 +67353,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -64403,6 +67368,7 @@ A string label to differentiate this status from the status of other systems. Th }, IsRequired: true, Summary: An optional glob pattern to match against when enforcing tag protection., + ParameterName: pattern, ArgumentName: pattern } ], @@ -64437,6 +67403,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64454,6 +67421,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -64471,6 +67439,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: tagProtectionId, ArgumentName: tagProtectionId } ], @@ -64505,6 +67474,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64522,6 +67492,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -64539,6 +67510,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ref, ArgumentName: ref } ], @@ -64572,6 +67544,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64589,6 +67562,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -64608,6 +67582,7 @@ A string label to differentiate this status from the status of other systems. Th DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -64627,6 +67602,7 @@ A string label to differentiate this status from the status of other systems. Th DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -64660,6 +67636,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64677,6 +67654,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -64696,6 +67674,7 @@ A string label to differentiate this status from the status of other systems. Th DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -64715,6 +67694,7 @@ A string label to differentiate this status from the status of other systems. Th DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -64748,6 +67728,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64765,6 +67746,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -64779,6 +67761,7 @@ A string label to differentiate this status from the status of other systems. Th }, IsRequired: true, Summary: An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters., + ParameterName: names, ArgumentName: names } ], @@ -64813,6 +67796,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64830,6 +67814,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -64855,6 +67840,7 @@ A string label to differentiate this status from the status of other systems. Th DefaultValue: Per.Day, Summary:
Default Value: day, + ParameterName: per, ArgumentName: per } ], @@ -64888,6 +67874,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64905,6 +67892,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -64938,6 +67926,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -64955,6 +67944,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -64988,6 +67978,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -65005,6 +67996,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -65030,6 +68022,7 @@ A string label to differentiate this status from the status of other systems. Th DefaultValue: Per.Day, Summary:
Default Value: day, + ParameterName: per, ArgumentName: per } ], @@ -65063,6 +68056,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -65080,6 +68074,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -65094,6 +68089,7 @@ A string label to differentiate this status from the status of other systems. Th }, IsRequired: true, Summary: The username or organization name the repository will be transferred to., + ParameterName: newOwner, ArgumentName: newOwner }, { @@ -65108,6 +68104,7 @@ A string label to differentiate this status from the status of other systems. Th }, IsRequired: false, Summary: The new name to be given to the repository., + ParameterName: newName, ArgumentName: newName }, { @@ -65122,6 +68119,7 @@ A string label to differentiate this status from the status of other systems. Th }, IsRequired: false, Summary: ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories., + ParameterName: teamIds, ArgumentName: teamIds } ], @@ -65156,6 +68154,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -65173,6 +68172,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -65206,6 +68206,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -65223,6 +68224,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -65257,6 +68259,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -65274,6 +68277,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -65308,6 +68312,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -65325,6 +68330,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -65342,6 +68348,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: ref, ArgumentName: ref } ], @@ -65375,6 +68382,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: templateOwner, ArgumentName: templateOwner }, { @@ -65392,6 +68400,7 @@ A string label to differentiate this status from the status of other systems. Th ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: templateRepo, ArgumentName: templateRepo }, { @@ -65406,6 +68415,7 @@ A string label to differentiate this status from the status of other systems. Th }, IsRequired: false, Summary: The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization., + ParameterName: owner, ArgumentName: owner }, { @@ -65420,6 +68430,7 @@ A string label to differentiate this status from the status of other systems. Th }, IsRequired: true, Summary: The name of the new repository., + ParameterName: name, ArgumentName: name }, { @@ -65434,6 +68445,7 @@ A string label to differentiate this status from the status of other systems. Th }, IsRequired: false, Summary: A short description of the new repository., + ParameterName: description, ArgumentName: description }, { @@ -65451,6 +68463,7 @@ A string label to differentiate this status from the status of other systems. Th Summary: Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.
Default Value: false, + ParameterName: includeAllBranches, ArgumentName: includeAllBranches }, { @@ -65468,6 +68481,7 @@ Set to `true` to include the directory structure and files from all branches in Summary: Either `true` to create a new private repository or `false` to create a new public one.
Default Value: false, + ParameterName: private, ArgumentName: private } ], @@ -65502,6 +68516,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since } ], @@ -65535,6 +68550,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: q, ArgumentName: q }, { @@ -65556,6 +68572,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: sort, ArgumentName: sort }, { @@ -65581,6 +68598,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -65600,6 +68618,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -65619,6 +68638,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -65652,6 +68672,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: q, ArgumentName: q }, { @@ -65675,6 +68696,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: sort, ArgumentName: sort }, { @@ -65700,6 +68722,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -65719,6 +68742,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -65738,6 +68762,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -65771,6 +68796,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: q, ArgumentName: q }, { @@ -65812,6 +68838,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: sort, ArgumentName: sort }, { @@ -65837,6 +68864,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -65856,6 +68884,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -65875,6 +68904,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -65908,6 +68938,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId }, { @@ -65925,6 +68956,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: q, ArgumentName: q }, { @@ -65948,6 +68980,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: sort, ArgumentName: sort }, { @@ -65973,6 +69006,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -65992,6 +69026,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -66011,6 +69046,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -66044,6 +69080,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: q, ArgumentName: q }, { @@ -66071,6 +69108,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: sort, ArgumentName: sort }, { @@ -66096,6 +69134,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -66115,6 +69154,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -66134,6 +69174,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -66167,6 +69208,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: q, ArgumentName: q }, { @@ -66186,6 +69228,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -66205,6 +69248,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -66238,6 +69282,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: q, ArgumentName: q }, { @@ -66263,6 +69308,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: sort, ArgumentName: sort }, { @@ -66288,6 +69334,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -66307,6 +69354,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -66326,6 +69374,7 @@ Either `true` to create a new private repository or `false` to create a new publ DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -66359,6 +69408,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId } ], @@ -66392,6 +69442,7 @@ Either `true` to create a new private repository or `false` to create a new publ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -66406,6 +69457,7 @@ Either `true` to create a new private repository or `false` to create a new publ }, IsRequired: true, Summary: The name of the team., + ParameterName: name, ArgumentName: name }, { @@ -66420,6 +69472,7 @@ Either `true` to create a new private repository or `false` to create a new publ }, IsRequired: false, Summary: The description of the team., + ParameterName: description, ArgumentName: description }, { @@ -66446,6 +69499,7 @@ The level of privacy this team should have. Editing teams without specifying thi * `closed` - visible to all members of this organization. **For a parent or child team:** * `closed` - visible to all members of this organization., + ParameterName: privacy, ArgumentName: privacy }, { @@ -66469,6 +69523,7 @@ The level of privacy this team should have. Editing teams without specifying thi The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are: * `notifications_enabled` - team members receive notifications when the team is @mentioned. * `notifications_disabled` - no one receives notifications., + ParameterName: notificationSetting, ArgumentName: notificationSetting }, { @@ -66494,6 +69549,7 @@ The notification setting the team has chosen. Editing teams without specifying t Summary: **Deprecated**. The permission that new repositories will be added to the team with when none is specified.
Default Value: pull, + ParameterName: permission, ArgumentName: permission }, { @@ -66508,6 +69564,7 @@ The notification setting the team has chosen. Editing teams without specifying t }, IsRequired: false, Summary: The ID of a team to set as the parent team., + ParameterName: parentTeamId, ArgumentName: parentTeamId } ], @@ -66542,6 +69599,7 @@ The notification setting the team has chosen. Editing teams without specifying t ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId } ], @@ -66576,6 +69634,7 @@ The notification setting the team has chosen. Editing teams without specifying t ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -66601,6 +69660,7 @@ The notification setting the team has chosen. Editing teams without specifying t DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -66620,6 +69680,7 @@ The notification setting the team has chosen. Editing teams without specifying t DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -66639,6 +69700,7 @@ The notification setting the team has chosen. Editing teams without specifying t DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -66672,6 +69734,7 @@ The notification setting the team has chosen. Editing teams without specifying t ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -66686,6 +69749,7 @@ The notification setting the team has chosen. Editing teams without specifying t }, IsRequired: true, Summary: The discussion post's title., + ParameterName: title, ArgumentName: title }, { @@ -66700,6 +69764,7 @@ The notification setting the team has chosen. Editing teams without specifying t }, IsRequired: true, Summary: The discussion post's body text., + ParameterName: body, ArgumentName: body }, { @@ -66717,6 +69782,7 @@ The notification setting the team has chosen. Editing teams without specifying t Summary: Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.
Default Value: false, + ParameterName: private, ArgumentName: private } ], @@ -66751,6 +69817,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -66768,6 +69835,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber } ], @@ -66801,6 +69869,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -66818,6 +69887,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -66832,6 +69902,7 @@ Private posts are only visible to team members, organization owners, and team ma }, IsRequired: false, Summary: The discussion post's title., + ParameterName: title, ArgumentName: title }, { @@ -66846,6 +69917,7 @@ Private posts are only visible to team members, organization owners, and team ma }, IsRequired: false, Summary: The discussion post's body text., + ParameterName: body, ArgumentName: body } ], @@ -66880,6 +69952,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -66897,6 +69970,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber } ], @@ -66931,6 +70005,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -66948,6 +70023,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -66973,6 +70049,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -66992,6 +70069,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -67011,6 +70089,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -67044,6 +70123,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -67061,6 +70141,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -67075,6 +70156,7 @@ Private posts are only visible to team members, organization owners, and team ma }, IsRequired: true, Summary: The discussion comment's body text., + ParameterName: body, ArgumentName: body } ], @@ -67109,6 +70191,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -67126,6 +70209,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -67143,6 +70227,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentNumber, ArgumentName: commentNumber } ], @@ -67176,6 +70261,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -67193,6 +70279,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -67210,6 +70297,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentNumber, ArgumentName: commentNumber }, { @@ -67224,6 +70312,7 @@ Private posts are only visible to team members, organization owners, and team ma }, IsRequired: true, Summary: The discussion comment's body text., + ParameterName: body, ArgumentName: body } ], @@ -67258,6 +70347,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -67275,6 +70365,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -67292,6 +70383,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentNumber, ArgumentName: commentNumber } ], @@ -67326,6 +70418,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -67343,6 +70436,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -67360,6 +70454,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentNumber, ArgumentName: commentNumber }, { @@ -67395,6 +70490,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -67414,6 +70510,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -67433,6 +70530,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -67466,6 +70564,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -67483,6 +70582,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -67500,6 +70600,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: commentNumber, ArgumentName: commentNumber }, { @@ -67532,6 +70633,7 @@ Private posts are only visible to team members, organization owners, and team ma }, IsRequired: true, Summary: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment., + ParameterName: content, ArgumentName: content } ], @@ -67566,6 +70668,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -67583,6 +70686,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -67618,6 +70722,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -67637,6 +70742,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -67656,6 +70762,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -67689,6 +70796,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -67706,6 +70814,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: discussionNumber, ArgumentName: discussionNumber }, { @@ -67738,6 +70847,7 @@ Private posts are only visible to team members, organization owners, and team ma }, IsRequired: true, Summary: The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion., + ParameterName: content, ArgumentName: content } ], @@ -67772,6 +70882,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -67791,6 +70902,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -67810,6 +70922,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -67843,6 +70956,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -67870,6 +70984,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: Role.All, Summary:
Default Value: all, + ParameterName: role, ArgumentName: role }, { @@ -67889,6 +71004,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -67908,6 +71024,7 @@ Private posts are only visible to team members, organization owners, and team ma DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -67941,6 +71058,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -67958,6 +71076,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -67991,6 +71110,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68008,6 +71128,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -68042,6 +71163,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68059,6 +71181,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -68093,6 +71216,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68110,6 +71234,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -68143,6 +71268,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68160,6 +71286,7 @@ Private posts are only visible to team members, organization owners, and team ma ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -68183,6 +71310,7 @@ Private posts are only visible to team members, organization owners, and team ma Summary: The role that this user should have in the team.
Default Value: member, + ParameterName: role, ArgumentName: role } ], @@ -68217,6 +71345,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68234,6 +71363,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -68268,6 +71398,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68287,6 +71418,7 @@ The role that this user should have in the team. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -68306,6 +71438,7 @@ The role that this user should have in the team. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -68339,6 +71472,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68356,6 +71490,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId } ], @@ -68389,6 +71524,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68406,6 +71542,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId }, { @@ -68428,6 +71565,7 @@ The role that this user should have in the team. }, IsRequired: false, Summary: The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method).", + ParameterName: permission, ArgumentName: permission } ], @@ -68462,6 +71600,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68479,6 +71618,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: projectId, ArgumentName: projectId } ], @@ -68513,6 +71653,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68532,6 +71673,7 @@ The role that this user should have in the team. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -68551,6 +71693,7 @@ The role that this user should have in the team. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -68584,6 +71727,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68601,6 +71745,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -68618,6 +71763,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -68651,6 +71797,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68668,6 +71815,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -68685,6 +71833,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo }, { @@ -68707,6 +71856,7 @@ The role that this user should have in the team. }, IsRequired: false, Summary: The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository., + ParameterName: permission, ArgumentName: permission } ], @@ -68741,6 +71891,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68758,6 +71909,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -68775,6 +71927,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -68809,6 +71962,7 @@ The role that this user should have in the team. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: teamId, ArgumentName: teamId }, { @@ -68828,6 +71982,7 @@ The role that this user should have in the team. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -68847,6 +72002,7 @@ The role that this user should have in the team. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -68894,6 +72050,7 @@ The role that this user should have in the team. Summary: The new name of the user.
Example: Omar Jahandar, + ParameterName: name, ArgumentName: name }, { @@ -68910,6 +72067,7 @@ The new name of the user. Summary: The publicly visible email address of the user.
Example: omar@example.com, + ParameterName: email, ArgumentName: email }, { @@ -68926,6 +72084,7 @@ The publicly visible email address of the user. Summary: The new blog URL of the user.
Example: blog.example.com, + ParameterName: blog, ArgumentName: blog }, { @@ -68942,6 +72101,7 @@ The new blog URL of the user. Summary: The new Twitter username of the user.
Example: therealomarj, + ParameterName: twitterUsername, ArgumentName: twitterUsername }, { @@ -68958,6 +72118,7 @@ The new Twitter username of the user. Summary: The new company of the user.
Example: Acme corporation, + ParameterName: company, ArgumentName: company }, { @@ -68974,6 +72135,7 @@ The new company of the user. Summary: The new location of the user.
Example: Berlin, Germany, + ParameterName: location, ArgumentName: location }, { @@ -68988,6 +72150,7 @@ The new location of the user. }, IsRequired: false, Summary: The new hiring availability of the user., + ParameterName: hireable, ArgumentName: hireable }, { @@ -69002,6 +72165,7 @@ The new location of the user. }, IsRequired: false, Summary: The new short biography of the user., + ParameterName: bio, ArgumentName: bio } ], @@ -69038,6 +72202,7 @@ The new location of the user. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -69057,6 +72222,7 @@ The new location of the user. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -69090,6 +72256,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -69123,6 +72290,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -69157,6 +72325,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -69193,6 +72362,7 @@ The new location of the user. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -69212,6 +72382,7 @@ The new location of the user. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -69229,6 +72400,7 @@ The new location of the user. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -69280,6 +72452,7 @@ The new location of the user. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -69299,6 +72472,7 @@ The new location of the user. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -69347,6 +72521,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -69380,6 +72555,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -69394,6 +72570,7 @@ The new location of the user. }, IsRequired: false, Summary: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get the public key for the authenticated user](https://docs.github.com/rest/codespaces/secrets#get-public-key-for-the-authenticated-user) endpoint., + ParameterName: encryptedValue, ArgumentName: encryptedValue }, { @@ -69408,6 +72585,7 @@ The new location of the user. }, IsRequired: true, Summary: ID of the key you used to encrypt the secret., + ParameterName: keyId, ArgumentName: keyId }, { @@ -69422,6 +72600,7 @@ The new location of the user. }, IsRequired: false, Summary: An array of repository ids that can access the user secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Set selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints., + ParameterName: selectedRepositoryIds, ArgumentName: selectedRepositoryIds } ], @@ -69456,6 +72635,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -69490,6 +72670,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName } ], @@ -69523,6 +72704,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -69537,6 +72719,7 @@ The new location of the user. }, IsRequired: true, Summary: An array of repository ids for which a codespace can access the secret. You can manage the list of selected repositories using the [List selected repositories for a user secret](https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret), [Add a selected repository to a user secret](https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret), and [Remove a selected repository from a user secret](https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret) endpoints., + ParameterName: selectedRepositoryIds, ArgumentName: selectedRepositoryIds } ], @@ -69571,6 +72754,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -69588,6 +72772,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -69622,6 +72807,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: secretName, ArgumentName: secretName }, { @@ -69639,6 +72825,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -69673,6 +72860,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codespaceName, ArgumentName: codespaceName } ], @@ -69706,6 +72894,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codespaceName, ArgumentName: codespaceName }, { @@ -69720,6 +72909,7 @@ The new location of the user. }, IsRequired: false, Summary: A valid machine to transition this codespace to., + ParameterName: machine, ArgumentName: machine }, { @@ -69734,6 +72924,7 @@ The new location of the user. }, IsRequired: false, Summary: Display name for this codespace, + ParameterName: displayName, ArgumentName: displayName }, { @@ -69748,6 +72939,7 @@ The new location of the user. }, IsRequired: false, Summary: Recently opened folders inside the codespace. It is currently used by the clients to determine the folder path to load the codespace in., + ParameterName: recentFolders, ArgumentName: recentFolders } ], @@ -69782,6 +72974,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codespaceName, ArgumentName: codespaceName } ], @@ -69816,6 +73009,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codespaceName, ArgumentName: codespaceName } ], @@ -69850,6 +73044,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codespaceName, ArgumentName: codespaceName }, { @@ -69867,6 +73062,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: exportId, ArgumentName: exportId } ], @@ -69900,6 +73096,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codespaceName, ArgumentName: codespaceName } ], @@ -69933,6 +73130,7 @@ The new location of the user. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codespaceName, ArgumentName: codespaceName }, { @@ -69947,6 +73145,7 @@ The new location of the user. }, IsRequired: false, Summary: A name for the new repository., + ParameterName: name, ArgumentName: name }, { @@ -69964,6 +73163,7 @@ The new location of the user. Summary: Whether the new repository should be private.
Default Value: false, + ParameterName: private, ArgumentName: private } ], @@ -69998,6 +73198,7 @@ Whether the new repository should be private. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codespaceName, ArgumentName: codespaceName } ], @@ -70032,6 +73233,7 @@ Whether the new repository should be private. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: codespaceName, ArgumentName: codespaceName } ], @@ -70084,6 +73286,7 @@ Whether the new repository should be private. }, IsRequired: true, Summary: Denotes whether an email is publicly visible., + ParameterName: visibility, ArgumentName: visibility } ], @@ -70120,6 +73323,7 @@ Whether the new repository should be private. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -70139,6 +73343,7 @@ Whether the new repository should be private. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -70206,6 +73411,7 @@ Whether the new repository should be private. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -70225,6 +73431,7 @@ Whether the new repository should be private. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -70260,6 +73467,7 @@ Whether the new repository should be private. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -70279,6 +73487,7 @@ Whether the new repository should be private. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -70312,6 +73521,7 @@ Whether the new repository should be private. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -70345,6 +73555,7 @@ Whether the new repository should be private. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -70379,6 +73590,7 @@ Whether the new repository should be private. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -70415,6 +73627,7 @@ Whether the new repository should be private. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -70434,6 +73647,7 @@ Whether the new repository should be private. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -70464,6 +73678,7 @@ Whether the new repository should be private. }, IsRequired: false, Summary: A descriptive name for the new key., + ParameterName: name, ArgumentName: name }, { @@ -70478,6 +73693,7 @@ Whether the new repository should be private. }, IsRequired: true, Summary: A GPG key in ASCII-armored format., + ParameterName: armoredPublicKey, ArgumentName: armoredPublicKey } ], @@ -70512,6 +73728,7 @@ Whether the new repository should be private. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gpgKeyId, ArgumentName: gpgKeyId } ], @@ -70545,6 +73762,7 @@ Whether the new repository should be private. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: gpgKeyId, ArgumentName: gpgKeyId } ], @@ -70581,6 +73799,7 @@ Whether the new repository should be private. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -70600,6 +73819,7 @@ Whether the new repository should be private. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -70633,6 +73853,7 @@ Whether the new repository should be private. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: installationId, ArgumentName: installationId }, { @@ -70652,6 +73873,7 @@ Whether the new repository should be private. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -70671,6 +73893,7 @@ Whether the new repository should be private. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -70704,6 +73927,7 @@ Whether the new repository should be private. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: installationId, ArgumentName: installationId }, { @@ -70721,6 +73945,7 @@ Whether the new repository should be private. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -70755,6 +73980,7 @@ Whether the new repository should be private. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: installationId, ArgumentName: installationId }, { @@ -70772,6 +73998,7 @@ Whether the new repository should be private. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repositoryId, ArgumentName: repositoryId } ], @@ -70828,6 +74055,7 @@ Whether the new repository should be private. Summary: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit is in effect.
Example: collaborators_only, + ParameterName: limit, ArgumentName: limit }, { @@ -70856,6 +74084,7 @@ The type of GitHub user that can comment, open issues, or create pull requests w Summary: The duration of the interaction restriction. Default: `one_day`.
Example: one_month, + ParameterName: expiry, ArgumentName: expiry } ], @@ -70922,6 +74151,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: Filter.Assigned, Summary:
Default Value: assigned, + ParameterName: filter, ArgumentName: filter }, { @@ -70949,6 +74179,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: State.Open, Summary:
Default Value: open, + ParameterName: state, ArgumentName: state }, { @@ -70966,6 +74197,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: labels, ArgumentName: labels }, { @@ -70993,6 +74225,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -71018,6 +74251,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -71035,6 +74269,7 @@ The duration of the interaction restriction. Default: `one_day`. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -71054,6 +74289,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -71073,6 +74309,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -71108,6 +74345,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -71127,6 +74365,7 @@ The duration of the interaction restriction. Default: `one_day`. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -71159,6 +74398,7 @@ The duration of the interaction restriction. Default: `one_day`. Summary: A descriptive name for the new key.
Example: Personal MacBook Air, + ParameterName: title, ArgumentName: title }, { @@ -71173,6 +74413,7 @@ A descriptive name for the new key. }, IsRequired: true, Summary: The public SSH key to add to your GitHub account., + ParameterName: key, ArgumentName: key } ], @@ -71207,6 +74448,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: keyId, ArgumentName: keyId } ], @@ -71240,6 +74482,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: keyId, ArgumentName: keyId } ], @@ -71276,6 +74519,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -71295,6 +74539,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -71330,6 +74575,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -71349,6 +74595,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -71388,6 +74635,7 @@ A descriptive name for the new key. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: state, ArgumentName: state }, { @@ -71407,6 +74655,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -71426,6 +74675,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -71459,6 +74709,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org } ], @@ -71492,6 +74743,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -71510,6 +74762,7 @@ A descriptive name for the new key. }, IsRequired: true, Summary: The state that the membership should be in. Only `"active"` will be accepted., + ParameterName: state, ArgumentName: state } ], @@ -71546,6 +74799,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -71565,6 +74819,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -71597,6 +74852,7 @@ A descriptive name for the new key. Summary: Lock the repositories being migrated at the start of the migration
Example: true, + ParameterName: lockRepositories, ArgumentName: lockRepositories }, { @@ -71613,6 +74869,7 @@ Lock the repositories being migrated at the start of the migration Summary: Indicates whether metadata should be excluded and only git source should be included for the migration.
Example: true, + ParameterName: excludeMetadata, ArgumentName: excludeMetadata }, { @@ -71629,6 +74886,7 @@ Indicates whether metadata should be excluded and only git source should be incl Summary: Indicates whether the repository git data should be excluded from the migration.
Example: true, + ParameterName: excludeGitData, ArgumentName: excludeGitData }, { @@ -71645,6 +74903,7 @@ Indicates whether the repository git data should be excluded from the migration. Summary: Do not include attachments in the migration
Example: true, + ParameterName: excludeAttachments, ArgumentName: excludeAttachments }, { @@ -71661,6 +74920,7 @@ Do not include attachments in the migration Summary: Do not include releases in the migration
Example: true, + ParameterName: excludeReleases, ArgumentName: excludeReleases }, { @@ -71677,6 +74937,7 @@ Do not include releases in the migration Summary: Indicates whether projects owned by the organization or users should be excluded.
Example: true, + ParameterName: excludeOwnerProjects, ArgumentName: excludeOwnerProjects }, { @@ -71695,6 +74956,7 @@ Indicates whether projects owned by the organization or users should be excluded Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).
Default Value: false
Example: true, + ParameterName: orgMetadataOnly, ArgumentName: orgMetadataOnly }, { @@ -71711,6 +74973,7 @@ Indicates whether this should only include organization metadata (repositories a Summary: Exclude attributes from the API response to improve performance
Example: [repositories], + ParameterName: exclude, ArgumentName: exclude }, { @@ -71725,6 +74988,7 @@ Exclude attributes from the API response to improve performance }, IsRequired: true, Summary: , + ParameterName: repositories, ArgumentName: repositories } ], @@ -71759,6 +75023,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: migrationId, ArgumentName: migrationId }, { @@ -71776,6 +75041,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: exclude, ArgumentName: exclude } ], @@ -71809,6 +75075,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: migrationId, ArgumentName: migrationId } ], @@ -71842,6 +75109,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: migrationId, ArgumentName: migrationId } ], @@ -71876,6 +75144,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: migrationId, ArgumentName: migrationId }, { @@ -71893,6 +75162,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repoName, ArgumentName: repoName } ], @@ -71927,6 +75197,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: migrationId, ArgumentName: migrationId }, { @@ -71946,6 +75217,7 @@ Exclude attributes from the API response to improve performance DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -71965,6 +75237,7 @@ Exclude attributes from the API response to improve performance DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -72000,6 +75273,7 @@ Exclude attributes from the API response to improve performance DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -72019,6 +75293,7 @@ Exclude attributes from the API response to improve performance DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -72066,6 +75341,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -72091,6 +75367,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: visibility, ArgumentName: visibility }, { @@ -72110,6 +75387,7 @@ Exclude attributes from the API response to improve performance DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -72129,6 +75407,7 @@ Exclude attributes from the API response to improve performance DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -72176,6 +75455,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -72193,6 +75473,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName } ], @@ -72240,6 +75521,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -72257,6 +75539,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName } ], @@ -72305,6 +75588,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -72322,6 +75606,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -72339,6 +75624,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: token, ArgumentName: token } ], @@ -72387,6 +75673,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -72404,6 +75691,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -72423,6 +75711,7 @@ Exclude attributes from the API response to improve performance DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -72442,6 +75731,7 @@ Exclude attributes from the API response to improve performance DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -72467,6 +75757,7 @@ Exclude attributes from the API response to improve performance DefaultValue: State.Active, Summary:
Default Value: active, + ParameterName: state, ArgumentName: state } ], @@ -72514,6 +75805,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -72531,6 +75823,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -72548,6 +75841,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageVersionId, ArgumentName: packageVersionId } ], @@ -72595,6 +75889,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -72612,6 +75907,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -72629,6 +75925,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageVersionId, ArgumentName: packageVersionId } ], @@ -72677,6 +75974,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -72694,6 +75992,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -72711,6 +76010,7 @@ Exclude attributes from the API response to improve performance ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageVersionId, ArgumentName: packageVersionId } ], @@ -72744,6 +76044,7 @@ Exclude attributes from the API response to improve performance Summary: Name of the project
Example: Week One Sprint, + ParameterName: name, ArgumentName: name }, { @@ -72760,6 +76061,7 @@ Name of the project Summary: Body of the project
Example: This project represents the sprint of the first week in January, + ParameterName: body, ArgumentName: body } ], @@ -72796,6 +76098,7 @@ Body of the project DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -72815,6 +76118,7 @@ Body of the project DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -72858,6 +76162,7 @@ Body of the project DefaultValue: Visibility.All, Summary:
Default Value: all, + ParameterName: visibility, ArgumentName: visibility }, { @@ -72877,6 +76182,7 @@ Body of the project DefaultValue: "owner,collaborator,organization_member", Summary:
Default Value: owner,collaborator,organization_member, + ParameterName: affiliation, ArgumentName: affiliation }, { @@ -72908,6 +76214,7 @@ Body of the project DefaultValue: Type.All, Summary:
Default Value: all, + ParameterName: type, ArgumentName: type }, { @@ -72937,6 +76244,7 @@ Body of the project DefaultValue: Sort.FullName, Summary:
Default Value: full_name, + ParameterName: sort, ArgumentName: sort }, { @@ -72960,6 +76268,7 @@ Body of the project ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: direction, ArgumentName: direction }, { @@ -72979,6 +76288,7 @@ Body of the project DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -72998,6 +76308,7 @@ Body of the project DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -73015,6 +76326,7 @@ Body of the project ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -73032,6 +76344,7 @@ Body of the project ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before } ], @@ -73064,6 +76377,7 @@ Body of the project Summary: The name of the repository.
Example: Team Environment, + ParameterName: name, ArgumentName: name }, { @@ -73078,6 +76392,7 @@ The name of the repository. }, IsRequired: false, Summary: A short description of the repository., + ParameterName: description, ArgumentName: description }, { @@ -73092,6 +76407,7 @@ The name of the repository. }, IsRequired: false, Summary: A URL with more information about the repository., + ParameterName: homepage, ArgumentName: homepage }, { @@ -73109,6 +76425,7 @@ The name of the repository. Summary: Whether the repository is private.
Default Value: false, + ParameterName: private, ArgumentName: private }, { @@ -73127,6 +76444,7 @@ Whether the repository is private. Whether issues are enabled.
Default Value: true
Example: true, + ParameterName: hasIssues, ArgumentName: hasIssues }, { @@ -73145,6 +76463,7 @@ Whether issues are enabled. Whether projects are enabled.
Default Value: true
Example: true, + ParameterName: hasProjects, ArgumentName: hasProjects }, { @@ -73163,6 +76482,7 @@ Whether projects are enabled. Whether the wiki is enabled.
Default Value: true
Example: true, + ParameterName: hasWiki, ArgumentName: hasWiki }, { @@ -73181,6 +76501,7 @@ Whether the wiki is enabled. Whether discussions are enabled.
Default Value: false
Example: true, + ParameterName: hasDiscussions, ArgumentName: hasDiscussions }, { @@ -73195,6 +76516,7 @@ Whether discussions are enabled. }, IsRequired: false, Summary: The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization., + ParameterName: teamId, ArgumentName: teamId }, { @@ -73212,6 +76534,7 @@ Whether discussions are enabled. Summary: Whether the repository is initialized with a minimal README.
Default Value: false, + ParameterName: autoInit, ArgumentName: autoInit }, { @@ -73228,6 +76551,7 @@ Whether the repository is initialized with a minimal README. Summary: The desired language or platform to apply to the .gitignore.
Example: Haskell, + ParameterName: gitignoreTemplate, ArgumentName: gitignoreTemplate }, { @@ -73244,6 +76568,7 @@ The desired language or platform to apply to the .gitignore. Summary: The license keyword of the open source license for this repository.
Example: mit, + ParameterName: licenseTemplate, ArgumentName: licenseTemplate }, { @@ -73262,6 +76587,7 @@ The license keyword of the open source license for this repository. Whether to allow squash merges for pull requests.
Default Value: true
Example: true, + ParameterName: allowSquashMerge, ArgumentName: allowSquashMerge }, { @@ -73280,6 +76606,7 @@ Whether to allow squash merges for pull requests. Whether to allow merge commits for pull requests.
Default Value: true
Example: true, + ParameterName: allowMergeCommit, ArgumentName: allowMergeCommit }, { @@ -73298,6 +76625,7 @@ Whether to allow merge commits for pull requests. Whether to allow rebase merges for pull requests.
Default Value: true
Example: true, + ParameterName: allowRebaseMerge, ArgumentName: allowRebaseMerge }, { @@ -73316,6 +76644,7 @@ Whether to allow rebase merges for pull requests. Whether to allow Auto-merge to be used on pull requests.
Default Value: false
Example: false, + ParameterName: allowAutoMerge, ArgumentName: allowAutoMerge }, { @@ -73334,6 +76663,7 @@ Whether to allow Auto-merge to be used on pull requests. Whether to delete head branches when pull requests are merged
Default Value: false
Example: false, + ParameterName: deleteBranchOnMerge, ArgumentName: deleteBranchOnMerge }, { @@ -73358,6 +76688,7 @@ The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit)., + ParameterName: squashMergeCommitTitle, ArgumentName: squashMergeCommitTitle }, { @@ -73385,6 +76716,7 @@ The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message., + ParameterName: squashMergeCommitMessage, ArgumentName: squashMergeCommitMessage }, { @@ -73409,6 +76741,7 @@ The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)., + ParameterName: mergeCommitTitle, ArgumentName: mergeCommitTitle }, { @@ -73436,6 +76769,7 @@ The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message., + ParameterName: mergeCommitMessage, ArgumentName: mergeCommitMessage }, { @@ -73454,6 +76788,7 @@ The default value for a merge commit message. Whether downloads are enabled.
Default Value: true
Example: true, + ParameterName: hasDownloads, ArgumentName: hasDownloads }, { @@ -73472,6 +76807,7 @@ Whether downloads are enabled. Whether this repository acts as a template that can be used to generate new repositories.
Default Value: false
Example: true, + ParameterName: isTemplate, ArgumentName: isTemplate } ], @@ -73508,6 +76844,7 @@ Whether this repository acts as a template that can be used to generate new repo DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -73527,6 +76864,7 @@ Whether this repository acts as a template that can be used to generate new repo DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -73560,6 +76898,7 @@ Whether this repository acts as a template that can be used to generate new repo ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: invitationId, ArgumentName: invitationId } ], @@ -73594,6 +76933,7 @@ Whether this repository acts as a template that can be used to generate new repo ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: invitationId, ArgumentName: invitationId } ], @@ -73630,6 +76970,7 @@ Whether this repository acts as a template that can be used to generate new repo DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -73649,6 +76990,7 @@ Whether this repository acts as a template that can be used to generate new repo DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -73681,6 +77023,7 @@ Whether this repository acts as a template that can be used to generate new repo Summary: Full URLs for the social media profiles to add.
Example: [], + ParameterName: accountUrls, ArgumentName: accountUrls } ], @@ -73714,6 +77057,7 @@ Full URLs for the social media profiles to add. Summary: Full URLs for the social media profiles to delete.
Example: [], + ParameterName: accountUrls, ArgumentName: accountUrls } ], @@ -73750,6 +77094,7 @@ Full URLs for the social media profiles to delete. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -73769,6 +77114,7 @@ Full URLs for the social media profiles to delete. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -73801,6 +77147,7 @@ Full URLs for the social media profiles to delete. Summary: A descriptive name for the new key.
Example: Personal MacBook Air, + ParameterName: title, ArgumentName: title }, { @@ -73815,6 +77162,7 @@ A descriptive name for the new key. }, IsRequired: true, Summary: The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).", + ParameterName: key, ArgumentName: key } ], @@ -73849,6 +77197,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: sshSigningKeyId, ArgumentName: sshSigningKeyId } ], @@ -73882,6 +77231,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: sshSigningKeyId, ArgumentName: sshSigningKeyId } ], @@ -73924,6 +77274,7 @@ A descriptive name for the new key. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -73949,6 +77300,7 @@ A descriptive name for the new key. DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -73968,6 +77320,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -73987,6 +77340,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -74020,6 +77374,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -74037,6 +77392,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -74070,6 +77426,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -74087,6 +77444,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -74121,6 +77479,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: owner, ArgumentName: owner }, { @@ -74138,6 +77497,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: repo, ArgumentName: repo } ], @@ -74174,6 +77534,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -74193,6 +77554,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -74228,6 +77590,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -74247,6 +77610,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -74280,6 +77644,7 @@ A descriptive name for the new key. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -74299,6 +77664,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -74332,6 +77698,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -74365,6 +77732,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -74398,6 +77766,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -74417,6 +77786,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -74436,6 +77806,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -74469,6 +77840,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -74486,6 +77858,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: org, ArgumentName: org }, { @@ -74505,6 +77878,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -74524,6 +77898,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -74557,6 +77932,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -74576,6 +77952,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -74595,6 +77972,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -74628,6 +78006,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -74647,6 +78026,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -74666,6 +78046,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -74699,6 +78080,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -74718,6 +78100,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -74737,6 +78120,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -74770,6 +78154,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -74787,6 +78172,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: targetUser, ArgumentName: targetUser } ], @@ -74820,6 +78206,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -74837,6 +78224,7 @@ A descriptive name for the new key. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: since, ArgumentName: since }, { @@ -74856,6 +78244,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -74875,6 +78264,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -74908,6 +78298,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -74927,6 +78318,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -74946,6 +78338,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -74979,6 +78372,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -75006,6 +78400,7 @@ A descriptive name for the new key. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: subjectType, ArgumentName: subjectType }, { @@ -75023,6 +78418,7 @@ A descriptive name for the new key. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: subjectId, ArgumentName: subjectId } ], @@ -75056,6 +78452,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -75089,6 +78486,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -75108,6 +78506,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -75127,6 +78526,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -75160,6 +78560,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -75179,6 +78580,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -75198,6 +78600,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -75245,6 +78648,7 @@ A descriptive name for the new key. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -75270,6 +78674,7 @@ A descriptive name for the new key. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: visibility, ArgumentName: visibility }, { @@ -75287,6 +78692,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -75306,6 +78712,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page }, { @@ -75325,6 +78732,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage } ], @@ -75372,6 +78780,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -75389,6 +78798,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -75406,6 +78816,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -75453,6 +78864,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -75470,6 +78882,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -75487,6 +78900,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -75535,6 +78949,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -75552,6 +78967,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -75569,6 +78985,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -75586,6 +79003,7 @@ A descriptive name for the new key. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: token, ArgumentName: token } ], @@ -75634,6 +79052,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -75651,6 +79070,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -75668,6 +79088,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -75715,6 +79136,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -75732,6 +79154,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -75749,6 +79172,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageVersionId, ArgumentName: packageVersionId }, { @@ -75766,6 +79190,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -75813,6 +79238,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -75830,6 +79256,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -75847,6 +79274,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -75864,6 +79292,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageVersionId, ArgumentName: packageVersionId } ], @@ -75912,6 +79341,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageType, ArgumentName: packageType }, { @@ -75929,6 +79359,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageName, ArgumentName: packageName }, { @@ -75946,6 +79377,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -75963,6 +79395,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: packageVersionId, ArgumentName: packageVersionId } ], @@ -75997,6 +79430,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -76024,6 +79458,7 @@ A descriptive name for the new key. DefaultValue: State.Open, Summary:
Default Value: open, + ParameterName: state, ArgumentName: state }, { @@ -76043,6 +79478,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -76062,6 +79498,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -76095,6 +79532,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -76114,6 +79552,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -76133,6 +79572,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -76166,6 +79606,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -76185,6 +79626,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -76204,6 +79646,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -76237,6 +79680,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -76264,6 +79708,7 @@ A descriptive name for the new key. DefaultValue: Type.Owner, Summary:
Default Value: owner, + ParameterName: type, ArgumentName: type }, { @@ -76293,6 +79738,7 @@ A descriptive name for the new key. DefaultValue: Sort.FullName, Summary:
Default Value: full_name, + ParameterName: sort, ArgumentName: sort }, { @@ -76316,6 +79762,7 @@ A descriptive name for the new key. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: direction, ArgumentName: direction }, { @@ -76335,6 +79782,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -76354,6 +79802,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -76387,6 +79836,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -76420,6 +79870,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -76453,6 +79904,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username } ], @@ -76486,6 +79938,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -76505,6 +79958,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -76524,6 +79978,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -76557,6 +80012,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -76576,6 +80032,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -76595,6 +80052,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -76628,6 +80086,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -76653,6 +80112,7 @@ A descriptive name for the new key. DefaultValue: Sort.Created, Summary:
Default Value: created, + ParameterName: sort, ArgumentName: sort }, { @@ -76678,6 +80138,7 @@ A descriptive name for the new key. DefaultValue: Direction.Desc, Summary:
Default Value: desc, + ParameterName: direction, ArgumentName: direction }, { @@ -76697,6 +80158,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -76716,6 +80178,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], @@ -76749,6 +80212,7 @@ A descriptive name for the new key. ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: username, ArgumentName: username }, { @@ -76768,6 +80232,7 @@ A descriptive name for the new key. DefaultValue: 30, Summary:
Default Value: 30, + ParameterName: perPage, ArgumentName: perPage }, { @@ -76787,6 +80252,7 @@ A descriptive name for the new key. DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: page, ArgumentName: page } ], diff --git a/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/Ollama/_.verified.txt b/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/Ollama/_.verified.txt index b1413d6f45..3a15b38742 100644 --- a/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/Ollama/_.verified.txt +++ b/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/Ollama/_.verified.txt @@ -24,6 +24,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: model, ArgumentName: model }, { @@ -40,6 +41,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a Summary: The prompt to generate a response.
Example: Why is the sky blue?, + ParameterName: prompt, ArgumentName: prompt }, { @@ -54,6 +56,7 @@ The prompt to generate a response. }, IsRequired: false, Summary: (optional) a list of Base64-encoded images to include in the message (for multimodal models such as llava), + ParameterName: images, ArgumentName: images }, { @@ -68,6 +71,7 @@ The prompt to generate a response. }, IsRequired: false, Summary: The system prompt to (overrides what is defined in the Modelfile)., + ParameterName: system, ArgumentName: system }, { @@ -82,6 +86,7 @@ The prompt to generate a response. }, IsRequired: false, Summary: The full prompt or prompt template (overrides what is defined in the Modelfile)., + ParameterName: template, ArgumentName: template }, { @@ -96,6 +101,7 @@ The prompt to generate a response. }, IsRequired: false, Summary: The context parameter returned from a previous request to [generateCompletion], this can be used to keep a short conversational memory., + ParameterName: context, ArgumentName: context }, { @@ -144,6 +150,7 @@ The prompt to generate a response. }, IsRequired: false, Summary: Additional model parameters listed in the documentation for the Modelfile such as `temperature`., + ParameterName: options, ArgumentName: options }, { @@ -168,6 +175,7 @@ Enable JSON mode by setting the format parameter to json. This will structure th Note: it's important to instruct the model to use JSON in the prompt. Otherwise, the model may generate large amounts whitespace. , + ParameterName: format, ArgumentName: format }, { @@ -186,6 +194,7 @@ If `true` no formatting will be applied to the prompt and no context will be ret You may choose to use the `raw` parameter if you are specifying a full templated prompt in your request to the API, and are managing history yourself. , + ParameterName: raw, ArgumentName: raw }, { @@ -204,6 +213,7 @@ You may choose to use the `raw` parameter if you are specifying a full templated If `false` the response will be returned as a single response object, otherwise the response will be streamed as a series of objects.
Default Value: false, + ParameterName: stream, ArgumentName: stream }, { @@ -225,6 +235,7 @@ How long (in minutes) to keep the model loaded in memory. - If set to 0, the model will be unloaded immediately once finished. - If not set, the model will stay loaded for 5 minutes by default , + ParameterName: keepAlive, ArgumentName: keepAlive } ], @@ -261,6 +272,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: model, ArgumentName: model }, { @@ -275,6 +287,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a }, IsRequired: true, Summary: The messages of the chat, this can be used to keep a chat memory, + ParameterName: messages, ArgumentName: messages }, { @@ -299,6 +312,7 @@ Enable JSON mode by setting the format parameter to json. This will structure th Note: it's important to instruct the model to use JSON in the prompt. Otherwise, the model may generate large amounts whitespace. , + ParameterName: format, ArgumentName: format }, { @@ -347,6 +361,7 @@ Note: it's important to instruct the model to use JSON in the prompt. Otherwise, }, IsRequired: false, Summary: Additional model parameters listed in the documentation for the Modelfile such as `temperature`., + ParameterName: options, ArgumentName: options }, { @@ -365,6 +380,7 @@ Note: it's important to instruct the model to use JSON in the prompt. Otherwise, If `false` the response will be returned as a single response object, otherwise the response will be streamed as a series of objects.
Default Value: false, + ParameterName: stream, ArgumentName: stream }, { @@ -386,6 +402,7 @@ How long (in minutes) to keep the model loaded in memory. - If set to 0, the model will be unloaded immediately once finished. - If not set, the model will stay loaded for 5 minutes by default , + ParameterName: keepAlive, ArgumentName: keepAlive } ], @@ -422,6 +439,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: model, ArgumentName: model }, { @@ -438,6 +456,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a Summary: Text to generate embeddings for.
Example: Here is an article about llamas..., + ParameterName: prompt, ArgumentName: prompt }, { @@ -486,6 +505,7 @@ Text to generate embeddings for. }, IsRequired: false, Summary: Additional model parameters listed in the documentation for the Modelfile such as `temperature`., + ParameterName: options, ArgumentName: options } ], @@ -522,6 +542,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: mario, + ParameterName: name, ArgumentName: name }, { @@ -538,6 +559,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a Summary: The contents of the Modelfile.
Example: FROM llama2\nSYSTEM You are mario from Super Mario Bros., + ParameterName: modelfile, ArgumentName: modelfile }, { @@ -556,6 +578,7 @@ The contents of the Modelfile. If `false` the response will be returned as a single response object, otherwise the response will be streamed as a series of objects.
Default Value: false, + ParameterName: stream, ArgumentName: stream } ], @@ -607,6 +630,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: name, ArgumentName: name } ], @@ -640,6 +664,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a Summary: Name of the model to copy.
Example: llama2:7b, + ParameterName: source, ArgumentName: source }, { @@ -656,6 +681,7 @@ Name of the model to copy. Summary: Name of the new model.
Example: llama2-backup, + ParameterName: destination, ArgumentName: destination } ], @@ -692,6 +718,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:13b, + ParameterName: name, ArgumentName: name } ], @@ -728,6 +755,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: name, ArgumentName: name }, { @@ -748,6 +776,7 @@ Allow insecure connections to the library. Only use this if you are pulling from your own library during development.
Default Value: false, + ParameterName: insecure, ArgumentName: insecure }, { @@ -766,6 +795,7 @@ Only use this if you are pulling from your own library during development. If `false` the response will be returned as a single response object, otherwise the response will be streamed as a series of objects.
Default Value: false, + ParameterName: stream, ArgumentName: stream } ], @@ -799,6 +829,7 @@ If `false` the response will be returned as a single response object, otherwise Summary: The name of the model to push in the form of <namespace>/<model>:<tag>.
Example: mattw/pygmalion:latest, + ParameterName: name, ArgumentName: name }, { @@ -819,6 +850,7 @@ Allow insecure connections to the library. Only use this if you are pushing to your library during development.
Default Value: false, + ParameterName: insecure, ArgumentName: insecure }, { @@ -837,6 +869,7 @@ Only use this if you are pushing to your library during development. If `false` the response will be returned as a single response object, otherwise the response will be streamed as a series of objects.
Default Value: false, + ParameterName: stream, ArgumentName: stream } ], diff --git a/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/OpenAi/_.verified.txt b/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/OpenAi/_.verified.txt index 8dde49b954..06b3bdf48b 100644 --- a/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/OpenAi/_.verified.txt +++ b/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/OpenAi/_.verified.txt @@ -19,6 +19,7 @@ }, IsRequired: true, Summary: A list of messages comprising the conversation so far. [Example Python code](https://cookbook.openai.com/examples/how_to_format_inputs_to_chatgpt_models)., + ParameterName: messages, ArgumentName: messages }, { @@ -35,6 +36,7 @@ Summary: ID of the model to use. See the [model endpoint compatibility](/docs/models/model-endpoint-compatibility) table for details on which models work with the Chat API.
Example: gpt-4-turbo, + ParameterName: model, ArgumentName: model }, { @@ -55,6 +57,7 @@ Number between -2.0 and 2.0. Positive values penalize new tokens based on their [See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)
Default Value: 0, + ParameterName: frequencyPenalty, ArgumentName: frequencyPenalty }, { @@ -74,6 +77,7 @@ Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.
Default Value: , + ParameterName: logitBias, ArgumentName: logitBias }, { @@ -91,6 +95,7 @@ Accepts a JSON object that maps tokens (specified by their token ID in the token Summary: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`.
Default Value: false, + ParameterName: logprobs, ArgumentName: logprobs }, { @@ -105,6 +110,7 @@ Whether to return log probabilities of the output tokens or not. If true, return }, IsRequired: false, Summary: An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used., + ParameterName: topLogprobs, ArgumentName: topLogprobs }, { @@ -123,6 +129,7 @@ The maximum number of [tokens](/tokenizer) that can be generated in the chat com The total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. , + ParameterName: maxTokens, ArgumentName: maxTokens }, { @@ -141,6 +148,7 @@ The total length of input tokens and generated tokens is limited by the model's How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs.
Default Value: 1
Example: 1, + ParameterName: n, ArgumentName: n }, { @@ -161,6 +169,7 @@ Number between -2.0 and 2.0. Positive values penalize new tokens based on whethe [See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)
Default Value: 0, + ParameterName: presencePenalty, ArgumentName: presencePenalty }, { @@ -181,6 +190,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. , + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -199,6 +209,7 @@ This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. , + ParameterName: seed, ArgumentName: seed }, { @@ -217,6 +228,7 @@ Determinism is not guaranteed, and you should refer to the `system_fingerprint` Up to 4 sequences where the API will stop generating further tokens.
Default Value: , + ParameterName: stop, ArgumentName: stop }, { @@ -235,6 +247,7 @@ Up to 4 sequences where the API will stop generating further tokens. If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
Default Value: false, + ParameterName: stream, ArgumentName: stream }, { @@ -254,6 +267,7 @@ If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sen Options for streaming response. Only set this when you set `stream: true`.
Default Value: , + ParameterName: streamOptions, ArgumentName: streamOptions }, { @@ -275,6 +289,7 @@ We generally recommend altering this or `top_p` but not both.
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -296,6 +311,7 @@ We generally recommend altering this or `temperature` but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -312,6 +328,7 @@ We generally recommend altering this or `temperature` but not both. Summary: A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported. , + ParameterName: tools, ArgumentName: tools }, { @@ -334,6 +351,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ `none` is the default when no tools are present. `auto` is the default if tools are present. , + ParameterName: toolChoice, ArgumentName: toolChoice }, { @@ -351,6 +369,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
Example: user-1234, + ParameterName: user, ArgumentName: user }, { @@ -375,6 +394,7 @@ Specifying a particular function via `{"name": "my_function"}` forces the model `none` is the default when no functions are present. `auto` is the default if functions are present. , + ParameterName: functionCall, ArgumentName: functionCall }, { @@ -393,6 +413,7 @@ Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for. , + ParameterName: functions, ArgumentName: functions } ], @@ -426,6 +447,7 @@ A list of functions the model may generate JSON inputs for. Summary: ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. , + ParameterName: model, ArgumentName: model }, { @@ -446,6 +468,7 @@ The prompt(s) to generate completions for, encoded as a string, array of strings Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.
Default Value: <|endoftext|>, + ParameterName: prompt, ArgumentName: prompt }, { @@ -468,6 +491,7 @@ When used with `n`, `best_of` controls the number of candidate completions and ` **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.
Default Value: 1, + ParameterName: bestOf, ArgumentName: bestOf }, { @@ -486,6 +510,7 @@ When used with `n`, `best_of` controls the number of candidate completions and ` Echo back the prompt in addition to the completion
Default Value: false, + ParameterName: echo, ArgumentName: echo }, { @@ -506,6 +531,7 @@ Number between -2.0 and 2.0. Positive values penalize new tokens based on their [See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)
Default Value: 0, + ParameterName: frequencyPenalty, ArgumentName: frequencyPenalty }, { @@ -527,6 +553,7 @@ Accepts a JSON object that maps tokens (specified by their token ID in the GPT t As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token from being generated.
Default Value: , + ParameterName: logitBias, ArgumentName: logitBias }, { @@ -546,6 +573,7 @@ Include the log probabilities on the `logprobs` most likely output tokens, as we The maximum value for `logprobs` is 5.
Default Value: , + ParameterName: logprobs, ArgumentName: logprobs }, { @@ -567,6 +595,7 @@ The token count of your prompt plus `max_tokens` cannot exceed the model's conte
Default Value: 16
Example: 16, + ParameterName: maxTokens, ArgumentName: maxTokens }, { @@ -588,6 +617,7 @@ How many completions to generate for each prompt.
Default Value: 1
Example: 1, + ParameterName: n, ArgumentName: n }, { @@ -608,6 +638,7 @@ Number between -2.0 and 2.0. Positive values penalize new tokens based on whethe [See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)
Default Value: 0, + ParameterName: presencePenalty, ArgumentName: presencePenalty }, { @@ -626,6 +657,7 @@ If specified, our system will make a best effort to sample deterministically, su Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. , + ParameterName: seed, ArgumentName: seed }, { @@ -644,6 +676,7 @@ Determinism is not guaranteed, and you should refer to the `system_fingerprint` Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
Default Value: , + ParameterName: stop, ArgumentName: stop }, { @@ -662,6 +695,7 @@ Up to 4 sequences where the API will stop generating further tokens. The returne Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
Default Value: false, + ParameterName: stream, ArgumentName: stream }, { @@ -681,6 +715,7 @@ Whether to stream back partial progress. If set, tokens will be sent as data-onl Options for streaming response. Only set this when you set `stream: true`.
Default Value: , + ParameterName: streamOptions, ArgumentName: streamOptions }, { @@ -701,6 +736,7 @@ This parameter is only supported for `gpt-3.5-turbo-instruct`.
Default Value:
Example: test., + ParameterName: suffix, ArgumentName: suffix }, { @@ -722,6 +758,7 @@ We generally recommend altering this or `top_p` but not both.
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -743,6 +780,7 @@ We generally recommend altering this or `temperature` but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -760,6 +798,7 @@ We generally recommend altering this or `temperature` but not both. A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
Example: user-1234, + ParameterName: user, ArgumentName: user } ], @@ -793,6 +832,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor Summary: A text description of the desired image(s). The maximum length is 1000 characters for `dall-e-2` and 4000 characters for `dall-e-3`.
Example: A cute baby sea otter, + ParameterName: prompt, ArgumentName: prompt }, { @@ -811,6 +851,7 @@ A text description of the desired image(s). The maximum length is 1000 character The model to use for image generation.
Default Value: dall-e-2
Example: dall-e-3, + ParameterName: model, ArgumentName: model }, { @@ -829,6 +870,7 @@ The model to use for image generation. The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.
Default Value: 1
Example: 1, + ParameterName: n, ArgumentName: n }, { @@ -853,6 +895,7 @@ The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only The quality of the image that will be generated. `hd` creates images with finer details and greater consistency across the image. This param is only supported for `dall-e-3`.
Default Value: standard
Example: standard, + ParameterName: quality, ArgumentName: quality }, { @@ -877,6 +920,7 @@ The quality of the image that will be generated. `hd` creates images with finer The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated.
Default Value: url
Example: url, + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -907,6 +951,7 @@ The format in which the generated images are returned. Must be one of `url` or ` The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`. Must be one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3` models.
Default Value: 1024x1024
Example: 1024x1024, + ParameterName: size, ArgumentName: size }, { @@ -931,6 +976,7 @@ The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x The style of the generated images. Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for `dall-e-3`.
Default Value: vivid
Example: vivid, + ParameterName: style, ArgumentName: style }, { @@ -948,6 +994,7 @@ The style of the generated images. Must be one of `vivid` or `natural`. Vivid ca A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
Example: user-1234, + ParameterName: user, ArgumentName: user } ], @@ -979,6 +1026,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor }, IsRequired: true, Summary: The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask., + ParameterName: image, ArgumentName: image }, { @@ -995,6 +1043,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor Summary: A text description of the desired image(s). The maximum length is 1000 characters.
Example: A cute baby sea otter wearing a beret, + ParameterName: prompt, ArgumentName: prompt }, { @@ -1009,6 +1058,7 @@ A text description of the desired image(s). The maximum length is 1000 character }, IsRequired: false, Summary: An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where `image` should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as `image`., + ParameterName: mask, ArgumentName: mask }, { @@ -1027,6 +1077,7 @@ A text description of the desired image(s). The maximum length is 1000 character The model to use for image generation. Only `dall-e-2` is supported at this time.
Default Value: dall-e-2
Example: dall-e-2, + ParameterName: model, ArgumentName: model }, { @@ -1045,6 +1096,7 @@ The model to use for image generation. Only `dall-e-2` is supported at this time The number of images to generate. Must be between 1 and 10.
Default Value: 1
Example: 1, + ParameterName: n, ArgumentName: n }, { @@ -1071,6 +1123,7 @@ The number of images to generate. Must be between 1 and 10. The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.
Default Value: 1024x1024
Example: 1024x1024, + ParameterName: size, ArgumentName: size }, { @@ -1095,6 +1148,7 @@ The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated.
Default Value: url
Example: url, + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -1112,6 +1166,7 @@ The format in which the generated images are returned. Must be one of `url` or ` A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
Example: user-1234, + ParameterName: user, ArgumentName: user } ], @@ -1143,6 +1198,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor }, IsRequired: true, Summary: The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square., + ParameterName: image, ArgumentName: image }, { @@ -1161,6 +1217,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor The model to use for image generation. Only `dall-e-2` is supported at this time.
Default Value: dall-e-2
Example: dall-e-2, + ParameterName: model, ArgumentName: model }, { @@ -1179,6 +1236,7 @@ The model to use for image generation. Only `dall-e-2` is supported at this time The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.
Default Value: 1
Example: 1, + ParameterName: n, ArgumentName: n }, { @@ -1203,6 +1261,7 @@ The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated.
Default Value: url
Example: url, + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -1229,6 +1288,7 @@ The format in which the generated images are returned. Must be one of `url` or ` The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.
Default Value: 1024x1024
Example: 1024x1024, + ParameterName: size, ArgumentName: size }, { @@ -1246,6 +1306,7 @@ The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
Example: user-1234, + ParameterName: user, ArgumentName: user } ], @@ -1280,6 +1341,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for `text-embedding-ada-002`), cannot be an empty string, and any array must be 2048 dimensions or less. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.
Example: The quick brown fox jumped over the lazy dog, + ParameterName: input, ArgumentName: input }, { @@ -1297,6 +1359,7 @@ Input text to embed, encoded as a string or array of tokens. To embed multiple i ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.
Example: text-embedding-3-small, + ParameterName: model, ArgumentName: model }, { @@ -1321,6 +1384,7 @@ ID of the model to use. You can use the [List models](/docs/api-reference/models The format to return the embeddings in. Can be either `float` or [`base64`](https://pypi.org/project/pybase64/).
Default Value: float
Example: float, + ParameterName: encodingFormat, ArgumentName: encodingFormat }, { @@ -1337,6 +1401,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http Summary: The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. , + ParameterName: dimensions, ArgumentName: dimensions }, { @@ -1354,6 +1419,7 @@ The number of dimensions the resulting output embeddings should have. Only suppo A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
Example: user-1234, + ParameterName: user, ArgumentName: user } ], @@ -1387,6 +1453,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor Summary: One of the available [TTS models](/docs/models/tts): `tts-1` or `tts-1-hd` , + ParameterName: model, ArgumentName: model }, { @@ -1401,6 +1468,7 @@ One of the available [TTS models](/docs/models/tts): `tts-1` or `tts-1-hd` }, IsRequired: true, Summary: The text to generate audio for. The maximum length is 4096 characters., + ParameterName: input, ArgumentName: input }, { @@ -1429,6 +1497,7 @@ One of the available [TTS models](/docs/models/tts): `tts-1` or `tts-1-hd` }, IsRequired: true, Summary: The voice to use when generating the audio. Supported voices are `alloy`, `echo`, `fable`, `onyx`, `nova`, and `shimmer`. Previews of the voices are available in the [Text to speech guide](/docs/guides/text-to-speech/voice-options)., + ParameterName: voice, ArgumentName: voice }, { @@ -1460,6 +1529,7 @@ One of the available [TTS models](/docs/models/tts): `tts-1` or `tts-1-hd` Summary: The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`.
Default Value: mp3, + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -1477,6 +1547,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav Summary: The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the default.
Default Value: 1, + ParameterName: speed, ArgumentName: speed } ], @@ -1510,6 +1581,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is Summary: The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. , + ParameterName: file, ArgumentName: file }, { @@ -1527,6 +1599,7 @@ The audio file object (not file name) to transcribe, in one of these formats: fl ID of the model to use. Only `whisper-1` (which is powered by our open source Whisper V2 model) is currently available.
Example: whisper-1, + ParameterName: model, ArgumentName: model }, { @@ -1543,6 +1616,7 @@ ID of the model to use. Only `whisper-1` (which is powered by our open source Wh Summary: The language of the input audio. Supplying the input language in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format will improve accuracy and latency. , + ParameterName: language, ArgumentName: language }, { @@ -1559,6 +1633,7 @@ The language of the input audio. Supplying the input language in [ISO-639-1](htt Summary: An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should match the audio language. , + ParameterName: prompt, ArgumentName: prompt }, { @@ -1589,6 +1664,7 @@ An optional text to guide the model's style or continue a previous audio segment The format of the transcript output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`.
Default Value: json, + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -1607,6 +1683,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.
Default Value: 0, + ParameterName: temperature, ArgumentName: temperature } ], @@ -1640,6 +1717,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the Summary: The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. , + ParameterName: file, ArgumentName: file }, { @@ -1657,6 +1735,7 @@ The audio file object (not file name) translate, in one of these formats: flac, ID of the model to use. Only `whisper-1` (which is powered by our open source Whisper V2 model) is currently available.
Example: whisper-1, + ParameterName: model, ArgumentName: model }, { @@ -1673,6 +1752,7 @@ ID of the model to use. Only `whisper-1` (which is powered by our open source Wh Summary: An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should be in English. , + ParameterName: prompt, ArgumentName: prompt }, { @@ -1691,6 +1771,7 @@ An optional text to guide the model's style or continue a previous audio segment The format of the transcript output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`.
Default Value: json, + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -1709,6 +1790,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.
Default Value: 0, + ParameterName: temperature, ArgumentName: temperature } ], @@ -1743,6 +1825,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: purpose, ArgumentName: purpose } ], @@ -1775,6 +1858,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the Summary: The File object (not file name) to be uploaded. , + ParameterName: file, ArgumentName: file }, { @@ -1801,6 +1885,7 @@ The intended purpose of the uploaded file. Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Message](/docs/api-reference/messages) files, "vision" for Assistants image file inputs, "batch" for [Batch API](/docs/guides/batch), and "fine-tune" for [Fine-tuning](/docs/api-reference/fine-tuning). , + ParameterName: purpose, ArgumentName: purpose } ], @@ -1835,6 +1920,7 @@ Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Message]( ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: fileId, ArgumentName: fileId } ], @@ -1869,6 +1955,7 @@ Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Message]( ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: fileId, ArgumentName: fileId } ], @@ -1902,6 +1989,7 @@ Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Message]( ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: fileId, ArgumentName: fileId } ], @@ -1936,6 +2024,7 @@ The name of the model to fine-tune. You can select one of the [supported models](/docs/guides/fine-tuning/what-models-can-be-fine-tuned).
Example: gpt-3.5-turbo, + ParameterName: model, ArgumentName: model }, { @@ -1959,6 +2048,7 @@ Your dataset must be formatted as a JSONL file. Additionally, you must upload yo See the [fine-tuning guide](/docs/guides/fine-tuning) for more details.
Example: file-abc123, + ParameterName: trainingFile, ArgumentName: trainingFile }, { @@ -1973,6 +2063,7 @@ See the [fine-tuning guide](/docs/guides/fine-tuning) for more details. }, IsRequired: false, Summary: The hyperparameters used for the fine-tuning job., + ParameterName: hyperparameters, ArgumentName: hyperparameters }, { @@ -1992,6 +2083,7 @@ A string of up to 18 characters that will be added to your fine-tuned model name For example, a `suffix` of "custom-model-name" would produce a model name like `ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel`.
Default Value: , + ParameterName: suffix, ArgumentName: suffix }, { @@ -2018,6 +2110,7 @@ Your dataset must be formatted as a JSONL file. You must upload your file with t See the [fine-tuning guide](/docs/guides/fine-tuning) for more details.
Example: file-abc123, + ParameterName: validationFile, ArgumentName: validationFile }, { @@ -2032,6 +2125,7 @@ See the [fine-tuning guide](/docs/guides/fine-tuning) for more details. }, IsRequired: false, Summary: A list of integrations to enable for your fine-tuning job., + ParameterName: integrations, ArgumentName: integrations }, { @@ -2050,6 +2144,7 @@ The seed controls the reproducibility of the job. Passing in the same seed and j If a seed is not specified, one will be generated for you.
Example: 42, + ParameterName: seed, ArgumentName: seed } ], @@ -2084,6 +2179,7 @@ If a seed is not specified, one will be generated for you. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -2103,6 +2199,7 @@ If a seed is not specified, one will be generated for you. DefaultValue: 20, Summary:
Default Value: 20, + ParameterName: limit, ArgumentName: limit } ], @@ -2137,6 +2234,7 @@ If a seed is not specified, one will be generated for you. ParameterExplode: false, Summary:
Example: ft-AF1WoRqd3aJAHsqc9NY7iL8F, + ParameterName: fineTuningJobId, ArgumentName: fineTuningJobId } ], @@ -2171,6 +2269,7 @@ If a seed is not specified, one will be generated for you. ParameterExplode: false, Summary:
Example: ft-AF1WoRqd3aJAHsqc9NY7iL8F, + ParameterName: fineTuningJobId, ArgumentName: fineTuningJobId }, { @@ -2188,6 +2287,7 @@ If a seed is not specified, one will be generated for you. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -2207,6 +2307,7 @@ If a seed is not specified, one will be generated for you. DefaultValue: 20, Summary:
Default Value: 20, + ParameterName: limit, ArgumentName: limit } ], @@ -2241,6 +2342,7 @@ If a seed is not specified, one will be generated for you. ParameterExplode: false, Summary:
Example: ft-AF1WoRqd3aJAHsqc9NY7iL8F, + ParameterName: fineTuningJobId, ArgumentName: fineTuningJobId } ], @@ -2276,6 +2378,7 @@ If a seed is not specified, one will be generated for you. ParameterExplode: false, Summary:
Example: ft-AF1WoRqd3aJAHsqc9NY7iL8F, + ParameterName: fineTuningJobId, ArgumentName: fineTuningJobId }, { @@ -2293,6 +2396,7 @@ If a seed is not specified, one will be generated for you. ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -2312,6 +2416,7 @@ If a seed is not specified, one will be generated for you. DefaultValue: 10, Summary:
Default Value: 10, + ParameterName: limit, ArgumentName: limit } ], @@ -2361,6 +2466,7 @@ If a seed is not specified, one will be generated for you. ParameterExplode: false, Summary:
Example: gpt-3.5-turbo, + ParameterName: model, ArgumentName: model } ], @@ -2395,6 +2501,7 @@ If a seed is not specified, one will be generated for you. ParameterExplode: false, Summary:
Example: ft:gpt-3.5-turbo:acemeco:suffix:abc123, + ParameterName: model, ArgumentName: model } ], @@ -2426,6 +2533,7 @@ If a seed is not specified, one will be generated for you. }, IsRequired: true, Summary: The input text to classify, + ParameterName: input, ArgumentName: input }, { @@ -2447,6 +2555,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove
Default Value: text-moderation-latest
Example: text-moderation-stable, + ParameterName: model, ArgumentName: model } ], @@ -2483,6 +2592,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove DefaultValue: 20, Summary:
Default Value: 20, + ParameterName: limit, ArgumentName: limit }, { @@ -2508,6 +2618,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -2525,6 +2636,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -2542,6 +2654,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before } ], @@ -2575,6 +2688,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.
Example: gpt-4-turbo, + ParameterName: model, ArgumentName: model }, { @@ -2591,6 +2705,7 @@ ID of the model to use. You can use the [List models](/docs/api-reference/models Summary: The name of the assistant. The maximum length is 256 characters. , + ParameterName: name, ArgumentName: name }, { @@ -2607,6 +2722,7 @@ The name of the assistant. The maximum length is 256 characters. Summary: The description of the assistant. The maximum length is 512 characters. , + ParameterName: description, ArgumentName: description }, { @@ -2623,6 +2739,7 @@ The description of the assistant. The maximum length is 512 characters. Summary: The system instructions that the assistant uses. The maximum length is 256,000 characters. , + ParameterName: instructions, ArgumentName: instructions }, { @@ -2641,6 +2758,7 @@ The system instructions that the assistant uses. The maximum length is 256,000 c A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.
Default Value: [], + ParameterName: tools, ArgumentName: tools }, { @@ -2657,6 +2775,7 @@ A list of tool enabled on the assistant. There can be a maximum of 128 tools per Summary: A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. , + ParameterName: toolResources, ArgumentName: toolResources }, { @@ -2673,6 +2792,7 @@ A set of resources that are used by the assistant's tools. The resources are spe Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata }, { @@ -2692,6 +2812,7 @@ What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -2713,6 +2834,7 @@ We generally recommend altering this or temperature but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -2733,6 +2855,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. , + ParameterName: responseFormat, ArgumentName: responseFormat } ], @@ -2767,6 +2890,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: assistantId, ArgumentName: assistantId } ], @@ -2800,6 +2924,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: assistantId, ArgumentName: assistantId }, { @@ -2817,6 +2942,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m Summary: ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. , + ParameterName: model, ArgumentName: model }, { @@ -2833,6 +2959,7 @@ ID of the model to use. You can use the [List models](/docs/api-reference/models Summary: The name of the assistant. The maximum length is 256 characters. , + ParameterName: name, ArgumentName: name }, { @@ -2849,6 +2976,7 @@ The name of the assistant. The maximum length is 256 characters. Summary: The description of the assistant. The maximum length is 512 characters. , + ParameterName: description, ArgumentName: description }, { @@ -2865,6 +2993,7 @@ The description of the assistant. The maximum length is 512 characters. Summary: The system instructions that the assistant uses. The maximum length is 256,000 characters. , + ParameterName: instructions, ArgumentName: instructions }, { @@ -2883,6 +3012,7 @@ The system instructions that the assistant uses. The maximum length is 256,000 c A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.
Default Value: [], + ParameterName: tools, ArgumentName: tools }, { @@ -2899,6 +3029,7 @@ A list of tool enabled on the assistant. There can be a maximum of 128 tools per Summary: A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. , + ParameterName: toolResources, ArgumentName: toolResources }, { @@ -2915,6 +3046,7 @@ A set of resources that are used by the assistant's tools. The resources are spe Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata }, { @@ -2934,6 +3066,7 @@ What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -2955,6 +3088,7 @@ We generally recommend altering this or temperature but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -2975,6 +3109,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. , + ParameterName: responseFormat, ArgumentName: responseFormat } ], @@ -3009,6 +3144,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: assistantId, ArgumentName: assistantId } ], @@ -3040,6 +3176,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: A list of [messages](/docs/api-reference/messages) to start the thread with., + ParameterName: messages, ArgumentName: messages }, { @@ -3056,6 +3193,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m Summary: A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. , + ParameterName: toolResources, ArgumentName: toolResources }, { @@ -3072,6 +3210,7 @@ A set of resources that are made available to the assistant's tools in this thre Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -3106,6 +3245,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId } ], @@ -3139,6 +3279,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -3155,6 +3296,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. , + ParameterName: toolResources, ArgumentName: toolResources }, { @@ -3171,6 +3313,7 @@ A set of resources that are made available to the assistant's tools in this thre Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -3205,6 +3348,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId } ], @@ -3239,6 +3383,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -3258,6 +3403,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful DefaultValue: 20, Summary:
Default Value: 20, + ParameterName: limit, ArgumentName: limit }, { @@ -3283,6 +3429,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -3300,6 +3447,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -3317,6 +3465,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -3334,6 +3483,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -3367,6 +3517,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -3391,6 +3542,7 @@ The role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. , + ParameterName: role, ArgumentName: role }, { @@ -3405,6 +3557,7 @@ The role of the entity that is creating the message. Allowed values include: }, IsRequired: true, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -3419,6 +3572,7 @@ The role of the entity that is creating the message. Allowed values include: }, IsRequired: false, Summary: A list of files attached to the message, and the tools they should be added to., + ParameterName: attachments, ArgumentName: attachments }, { @@ -3435,6 +3589,7 @@ The role of the entity that is creating the message. Allowed values include: Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -3469,6 +3624,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -3486,6 +3642,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: messageId, ArgumentName: messageId } ], @@ -3519,6 +3676,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -3536,6 +3694,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: messageId, ArgumentName: messageId }, { @@ -3552,6 +3711,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -3586,6 +3746,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -3603,6 +3764,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: messageId, ArgumentName: messageId } ], @@ -3634,6 +3796,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run., + ParameterName: assistantId, ArgumentName: assistantId }, { @@ -3652,6 +3815,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: thread, ArgumentName: thread }, { @@ -3669,6 +3833,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.
Example: gpt-4-turbo, + ParameterName: model, ArgumentName: model }, { @@ -3683,6 +3848,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run }, IsRequired: false, Summary: Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis., + ParameterName: instructions, ArgumentName: instructions }, { @@ -3697,6 +3863,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run }, IsRequired: false, Summary: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis., + ParameterName: tools, ArgumentName: tools }, { @@ -3713,6 +3880,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run Summary: A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. , + ParameterName: toolResources, ArgumentName: toolResources }, { @@ -3729,6 +3897,7 @@ A set of resources that are used by the assistant's tools. The resources are spe Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata }, { @@ -3748,6 +3917,7 @@ What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -3769,6 +3939,7 @@ We generally recommend altering this or temperature but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -3785,6 +3956,7 @@ We generally recommend altering this or temperature but not both. Summary: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. , + ParameterName: stream, ArgumentName: stream }, { @@ -3801,6 +3973,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent Summary: The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. , + ParameterName: maxPromptTokens, ArgumentName: maxPromptTokens }, { @@ -3817,6 +3990,7 @@ The maximum number of prompt tokens that may be used over the course of the run. Summary: The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. , + ParameterName: maxCompletionTokens, ArgumentName: maxCompletionTokens }, { @@ -3834,6 +4008,7 @@ The maximum number of completion tokens that may be used over the course of the }, IsRequired: false, Summary: Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run., + ParameterName: truncationStrategy, ArgumentName: truncationStrategy }, { @@ -3854,6 +4029,7 @@ Controls which (if any) tool is called by the model. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. , + ParameterName: toolChoice, ArgumentName: toolChoice }, { @@ -3874,6 +4050,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. , + ParameterName: responseFormat, ArgumentName: responseFormat } ], @@ -3908,6 +4085,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -3927,6 +4105,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m DefaultValue: 20, Summary:
Default Value: 20, + ParameterName: limit, ArgumentName: limit }, { @@ -3952,6 +4131,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -3969,6 +4149,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -3986,6 +4167,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before } ], @@ -4019,6 +4201,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -4033,6 +4216,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: true, Summary: The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run., + ParameterName: assistantId, ArgumentName: assistantId }, { @@ -4050,6 +4234,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m Summary: The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.
Example: gpt-4-turbo, + ParameterName: model, ArgumentName: model }, { @@ -4064,6 +4249,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run }, IsRequired: false, Summary: Overrides the [instructions](/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis., + ParameterName: instructions, ArgumentName: instructions }, { @@ -4078,6 +4264,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run }, IsRequired: false, Summary: Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions., + ParameterName: additionalInstructions, ArgumentName: additionalInstructions }, { @@ -4092,6 +4279,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run }, IsRequired: false, Summary: Adds additional messages to the thread before creating the run., + ParameterName: additionalMessages, ArgumentName: additionalMessages }, { @@ -4106,6 +4294,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run }, IsRequired: false, Summary: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis., + ParameterName: tools, ArgumentName: tools }, { @@ -4122,6 +4311,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata }, { @@ -4141,6 +4331,7 @@ What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -4162,6 +4353,7 @@ We generally recommend altering this or temperature but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -4178,6 +4370,7 @@ We generally recommend altering this or temperature but not both. Summary: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. , + ParameterName: stream, ArgumentName: stream }, { @@ -4194,6 +4387,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent Summary: The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. , + ParameterName: maxPromptTokens, ArgumentName: maxPromptTokens }, { @@ -4210,6 +4404,7 @@ The maximum number of prompt tokens that may be used over the course of the run. Summary: The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. , + ParameterName: maxCompletionTokens, ArgumentName: maxCompletionTokens }, { @@ -4227,6 +4422,7 @@ The maximum number of completion tokens that may be used over the course of the }, IsRequired: false, Summary: Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run., + ParameterName: truncationStrategy, ArgumentName: truncationStrategy }, { @@ -4247,6 +4443,7 @@ Controls which (if any) tool is called by the model. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. , + ParameterName: toolChoice, ArgumentName: toolChoice }, { @@ -4267,6 +4464,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. , + ParameterName: responseFormat, ArgumentName: responseFormat } ], @@ -4301,6 +4499,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -4318,6 +4517,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -4351,6 +4551,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -4368,6 +4569,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -4384,6 +4586,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -4418,6 +4621,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -4435,6 +4639,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -4449,6 +4654,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: A list of tools for which the outputs are being submitted., + ParameterName: toolOutputs, ArgumentName: toolOutputs }, { @@ -4465,6 +4671,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. , + ParameterName: stream, ArgumentName: stream } ], @@ -4499,6 +4706,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -4516,6 +4724,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId } ], @@ -4550,6 +4759,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -4567,6 +4777,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -4586,6 +4797,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent DefaultValue: 20, Summary:
Default Value: 20, + ParameterName: limit, ArgumentName: limit }, { @@ -4611,6 +4823,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -4628,6 +4841,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -4645,6 +4859,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before } ], @@ -4678,6 +4893,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: threadId, ArgumentName: threadId }, { @@ -4695,6 +4911,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: runId, ArgumentName: runId }, { @@ -4712,6 +4929,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: stepId, ArgumentName: stepId } ], @@ -4747,6 +4965,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent DefaultValue: 20, Summary:
Default Value: 20, + ParameterName: limit, ArgumentName: limit }, { @@ -4772,6 +4991,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -4789,6 +5009,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -4806,6 +5027,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before } ], @@ -4836,6 +5058,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: false, Summary: A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files., + ParameterName: fileIds, ArgumentName: fileIds }, { @@ -4850,6 +5073,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: false, Summary: The name of the vector store., + ParameterName: name, ArgumentName: name }, { @@ -4867,6 +5091,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: false, Summary: The expiration policy for a vector store., + ParameterName: expiresAfter, ArgumentName: expiresAfter }, { @@ -4883,6 +5108,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -4917,6 +5143,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: vectorStoreId, ArgumentName: vectorStoreId } ], @@ -4950,6 +5177,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: vectorStoreId, ArgumentName: vectorStoreId }, { @@ -4964,6 +5192,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The name of the vector store., + ParameterName: name, ArgumentName: name }, { @@ -4981,6 +5210,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The expiration policy for a vector store., + ParameterName: expiresAfter, ArgumentName: expiresAfter }, { @@ -4997,6 +5227,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -5031,6 +5262,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: vectorStoreId, ArgumentName: vectorStoreId } ], @@ -5065,6 +5297,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: vectorStoreId, ArgumentName: vectorStoreId }, { @@ -5084,6 +5317,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful DefaultValue: 20, Summary:
Default Value: 20, + ParameterName: limit, ArgumentName: limit }, { @@ -5109,6 +5343,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -5126,6 +5361,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -5143,6 +5379,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -5170,6 +5407,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: filter, ArgumentName: filter } ], @@ -5204,6 +5442,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterExplode: false, Summary:
Example: vs_abc123, + ParameterName: vectorStoreId, ArgumentName: vectorStoreId }, { @@ -5218,6 +5457,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files., + ParameterName: fileId, ArgumentName: fileId } ], @@ -5253,6 +5493,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterExplode: false, Summary:
Example: vs_abc123, + ParameterName: vectorStoreId, ArgumentName: vectorStoreId }, { @@ -5271,6 +5512,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterExplode: false, Summary:
Example: file-abc123, + ParameterName: fileId, ArgumentName: fileId } ], @@ -5304,6 +5546,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: vectorStoreId, ArgumentName: vectorStoreId }, { @@ -5321,6 +5564,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: fileId, ArgumentName: fileId } ], @@ -5356,6 +5600,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterExplode: false, Summary:
Example: vs_abc123, + ParameterName: vectorStoreId, ArgumentName: vectorStoreId }, { @@ -5370,6 +5615,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files., + ParameterName: fileIds, ArgumentName: fileIds } ], @@ -5405,6 +5651,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterExplode: false, Summary:
Example: vs_abc123, + ParameterName: vectorStoreId, ArgumentName: vectorStoreId }, { @@ -5423,6 +5670,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterExplode: false, Summary:
Example: vsfb_abc123, + ParameterName: batchId, ArgumentName: batchId } ], @@ -5456,6 +5704,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: vectorStoreId, ArgumentName: vectorStoreId }, { @@ -5473,6 +5722,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: batchId, ArgumentName: batchId } ], @@ -5507,6 +5757,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: vectorStoreId, ArgumentName: vectorStoreId }, { @@ -5524,6 +5775,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: batchId, ArgumentName: batchId }, { @@ -5543,6 +5795,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful DefaultValue: 20, Summary:
Default Value: 20, + ParameterName: limit, ArgumentName: limit }, { @@ -5568,6 +5821,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful DefaultValue: Order.Desc, Summary:
Default Value: desc, + ParameterName: order, ArgumentName: order }, { @@ -5585,6 +5839,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -5602,6 +5857,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: before, ArgumentName: before }, { @@ -5629,6 +5885,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: filter, ArgumentName: filter } ], @@ -5665,6 +5922,7 @@ See [upload file](/docs/api-reference/files/create) for how to upload a file. Your input file must be formatted as a [JSONL file](/docs/api-reference/batch/requestInput), and must be uploaded with the purpose `batch`. , + ParameterName: inputFileId, ArgumentName: inputFileId }, { @@ -5685,6 +5943,7 @@ Your input file must be formatted as a [JSONL file](/docs/api-reference/batch/re }, IsRequired: true, Summary: The endpoint to be used for all requests in the batch. Currently `/v1/chat/completions` and `/v1/embeddings` are supported., + ParameterName: endpoint, ArgumentName: endpoint }, { @@ -5703,6 +5962,7 @@ Your input file must be formatted as a [JSONL file](/docs/api-reference/batch/re }, IsRequired: true, Summary: The time frame within which the batch should be processed. Currently only `24h` is supported., + ParameterName: completionWindow, ArgumentName: completionWindow }, { @@ -5717,6 +5977,7 @@ Your input file must be formatted as a [JSONL file](/docs/api-reference/batch/re }, IsRequired: false, Summary: Optional custom metadata for the batch., + ParameterName: metadata, ArgumentName: metadata } ], @@ -5751,6 +6012,7 @@ Your input file must be formatted as a [JSONL file](/docs/api-reference/batch/re ParameterStyle: Form, ParameterExplode: true, Summary: , + ParameterName: after, ArgumentName: after }, { @@ -5770,6 +6032,7 @@ Your input file must be formatted as a [JSONL file](/docs/api-reference/batch/re DefaultValue: 20, Summary:
Default Value: 20, + ParameterName: limit, ArgumentName: limit } ], @@ -5803,6 +6066,7 @@ Your input file must be formatted as a [JSONL file](/docs/api-reference/batch/re ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: batchId, ArgumentName: batchId } ], @@ -5836,6 +6100,7 @@ Your input file must be formatted as a [JSONL file](/docs/api-reference/batch/re ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: batchId, ArgumentName: batchId } ], diff --git a/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/Replicate/_.verified.txt b/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/Replicate/_.verified.txt index 10d03f1d1a..938f7908fe 100644 --- a/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/Replicate/_.verified.txt +++ b/src/tests/OpenApiGenerator.UnitTests/Snapshots/Clients/Replicate/_.verified.txt @@ -52,6 +52,7 @@ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: collectionSlug, ArgumentName: collectionSlug } ], @@ -97,6 +98,7 @@ }, IsRequired: true, Summary: The SKU for the hardware used to run the model. Possible values can be retrieved from the `hardware.list` endpoint., + ParameterName: hardware, ArgumentName: hardware }, { @@ -111,6 +113,7 @@ }, IsRequired: true, Summary: The maximum number of instances for scaling., + ParameterName: maxInstances, ArgumentName: maxInstances }, { @@ -125,6 +128,7 @@ }, IsRequired: true, Summary: The minimum number of instances for scaling., + ParameterName: minInstances, ArgumentName: minInstances }, { @@ -139,6 +143,7 @@ }, IsRequired: true, Summary: The full name of the model that you want to deploy e.g. stability-ai/sdxl., + ParameterName: model, ArgumentName: model }, { @@ -153,6 +158,7 @@ }, IsRequired: true, Summary: The name of the deployment., + ParameterName: name, ArgumentName: name }, { @@ -167,6 +173,7 @@ }, IsRequired: true, Summary: The 64-character string ID of the model version that you want to deploy., + ParameterName: version, ArgumentName: version } ], @@ -201,6 +208,7 @@ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentOwner, ArgumentName: deploymentOwner }, { @@ -218,6 +226,7 @@ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentName, ArgumentName: deploymentName } ], @@ -252,6 +261,7 @@ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentOwner, ArgumentName: deploymentOwner }, { @@ -269,6 +279,7 @@ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentName, ArgumentName: deploymentName } ], @@ -302,6 +313,7 @@ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentOwner, ArgumentName: deploymentOwner }, { @@ -319,6 +331,7 @@ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentName, ArgumentName: deploymentName }, { @@ -333,6 +346,7 @@ }, IsRequired: false, Summary: The SKU for the hardware used to run the model. Possible values can be retrieved from the `hardware.list` endpoint., + ParameterName: hardware, ArgumentName: hardware }, { @@ -347,6 +361,7 @@ }, IsRequired: false, Summary: The maximum number of instances for scaling., + ParameterName: maxInstances, ArgumentName: maxInstances }, { @@ -361,6 +376,7 @@ }, IsRequired: false, Summary: The minimum number of instances for scaling., + ParameterName: minInstances, ArgumentName: minInstances }, { @@ -375,6 +391,7 @@ }, IsRequired: false, Summary: The ID of the model version that you want to deploy, + ParameterName: version, ArgumentName: version } ], @@ -409,6 +426,7 @@ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentOwner, ArgumentName: deploymentOwner }, { @@ -426,6 +444,7 @@ ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: deploymentName, ArgumentName: deploymentName }, { @@ -456,6 +475,7 @@ Use a data URL when: - you don't want to upload and host the file somewhere - you don't need to use the file again (Replicate will not store it) , + ParameterName: input, ArgumentName: input }, { @@ -474,6 +494,7 @@ Request a URL to receive streaming output using [server-sent events (SSE)](https If the requested model version supports streaming, the returned prediction will have a `stream` entry in its `urls` property with an HTTPS URL that you can use to construct an [`EventSource`](https://developer.mozilla.org/en-US/docs/Web/API/EventSource). , + ParameterName: stream, ArgumentName: stream }, { @@ -490,6 +511,7 @@ If the requested model version supports streaming, the returned prediction will Summary: An HTTPS URL for receiving a webhook when the prediction has new output. The webhook will be a POST request where the request body is the same as the response body of the [get prediction](#predictions.get) operation. If there are network problems, we will retry the webhook a few times, so make sure it can be safely called more than once. Replicate will not follow redirects when sending webhook requests to your service, so be sure to specify a URL that will resolve without redirecting. , + ParameterName: webhook, ArgumentName: webhook }, { @@ -525,6 +547,7 @@ For example, if you only wanted requests to be sent at the start and end of the Requests for event types `output` and `logs` will be sent at most once every 500ms. If you request `start` and `completed` webhooks, then they'll always be sent regardless of throttling. , + ParameterName: webhookEventsFilter, ArgumentName: webhookEventsFilter } ], @@ -586,6 +609,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 }, IsRequired: false, Summary: A URL for the model's cover image. This should be an image file., + ParameterName: coverImageUrl, ArgumentName: coverImageUrl }, { @@ -600,6 +624,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 }, IsRequired: false, Summary: A description of the model., + ParameterName: description, ArgumentName: description }, { @@ -614,6 +639,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 }, IsRequired: false, Summary: A URL for the model's source code on GitHub., + ParameterName: githubUrl, ArgumentName: githubUrl }, { @@ -628,6 +654,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 }, IsRequired: true, Summary: The SKU for the hardware used to run the model. Possible values can be retrieved from the `hardware.list` endpoint., + ParameterName: hardware, ArgumentName: hardware }, { @@ -642,6 +669,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 }, IsRequired: false, Summary: A URL for the model's license., + ParameterName: licenseUrl, ArgumentName: licenseUrl }, { @@ -656,6 +684,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 }, IsRequired: true, Summary: The name of the model. This must be unique among all models owned by the user or organization., + ParameterName: name, ArgumentName: name }, { @@ -670,6 +699,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 }, IsRequired: true, Summary: The name of the user or organization that will own the model. This must be the same as the user or organization that is making the API request. In other words, the API token used in the request must belong to this user or organization., + ParameterName: owner, ArgumentName: owner }, { @@ -684,6 +714,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 }, IsRequired: false, Summary: A URL for the model's paper., + ParameterName: paperUrl, ArgumentName: paperUrl }, { @@ -704,6 +735,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 }, IsRequired: true, Summary: Whether the model should be public or private. A public model can be viewed and run by anyone, whereas a private model can be viewed and run only by the user or organization members that own the model., + ParameterName: visibility, ArgumentName: visibility } ], @@ -738,6 +770,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelOwner, ArgumentName: modelOwner }, { @@ -755,6 +788,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelName, ArgumentName: modelName } ], @@ -789,6 +823,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelOwner, ArgumentName: modelOwner }, { @@ -806,6 +841,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelName, ArgumentName: modelName } ], @@ -839,6 +875,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelOwner, ArgumentName: modelOwner }, { @@ -856,6 +893,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelName, ArgumentName: modelName }, { @@ -886,6 +924,7 @@ Use a data URL when: - you don't want to upload and host the file somewhere - you don't need to use the file again (Replicate will not store it) , + ParameterName: input, ArgumentName: input }, { @@ -904,6 +943,7 @@ Request a URL to receive streaming output using [server-sent events (SSE)](https If the requested model version supports streaming, the returned prediction will have a `stream` entry in its `urls` property with an HTTPS URL that you can use to construct an [`EventSource`](https://developer.mozilla.org/en-US/docs/Web/API/EventSource). , + ParameterName: stream, ArgumentName: stream }, { @@ -920,6 +960,7 @@ If the requested model version supports streaming, the returned prediction will Summary: An HTTPS URL for receiving a webhook when the prediction has new output. The webhook will be a POST request where the request body is the same as the response body of the [get prediction](#predictions.get) operation. If there are network problems, we will retry the webhook a few times, so make sure it can be safely called more than once. Replicate will not follow redirects when sending webhook requests to your service, so be sure to specify a URL that will resolve without redirecting. , + ParameterName: webhook, ArgumentName: webhook }, { @@ -955,6 +996,7 @@ For example, if you only wanted requests to be sent at the start and end of the Requests for event types `output` and `logs` will be sent at most once every 500ms. If you request `start` and `completed` webhooks, then they'll always be sent regardless of throttling. , + ParameterName: webhookEventsFilter, ArgumentName: webhookEventsFilter } ], @@ -989,6 +1031,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelOwner, ArgumentName: modelOwner }, { @@ -1006,6 +1049,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelName, ArgumentName: modelName } ], @@ -1039,6 +1083,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelOwner, ArgumentName: modelOwner }, { @@ -1056,6 +1101,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelName, ArgumentName: modelName }, { @@ -1073,6 +1119,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: versionId, ArgumentName: versionId } ], @@ -1107,6 +1154,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelOwner, ArgumentName: modelOwner }, { @@ -1124,6 +1172,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelName, ArgumentName: modelName }, { @@ -1141,6 +1190,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: versionId, ArgumentName: versionId } ], @@ -1174,6 +1224,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelOwner, ArgumentName: modelOwner }, { @@ -1191,6 +1242,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: modelName, ArgumentName: modelName }, { @@ -1208,6 +1260,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: versionId, ArgumentName: versionId }, { @@ -1224,6 +1277,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 Summary: A string representing the desired model to push to in the format `{destination_model_owner}/{destination_model_name}`. This should be an existing model owned by the user or organization making the API request. If the destination is invalid, the server will return an appropriate 4XX response. , + ParameterName: destination, ArgumentName: destination }, { @@ -1240,6 +1294,7 @@ A string representing the desired model to push to in the format `{destination_m Summary: An object containing inputs to the Cog model's `train()` function. , + ParameterName: input, ArgumentName: input }, { @@ -1254,6 +1309,7 @@ An object containing inputs to the Cog model's `train()` function. }, IsRequired: false, Summary: An HTTPS URL for receiving a webhook when the training completes. The webhook will be a POST request where the request body is the same as the response body of the [get training](#trainings.get) operation. If there are network problems, we will retry the webhook a few times, so make sure it can be safely called more than once. Replicate will not follow redirects when sending webhook requests to your service, so be sure to specify a URL that will resolve without redirecting., + ParameterName: webhook, ArgumentName: webhook }, { @@ -1290,6 +1346,7 @@ For example, if you only wanted requests to be sent at the start and end of the Requests for event types `output` and `logs` will be sent at most once every 500ms. If you request `start` and `completed` webhooks, then they'll always be sent regardless of throttling. , + ParameterName: webhookEventsFilter, ArgumentName: webhookEventsFilter } ], @@ -1352,6 +1409,7 @@ Use a data URL when: - you don't want to upload and host the file somewhere - you don't need to use the file again (Replicate will not store it) , + ParameterName: input, ArgumentName: input }, { @@ -1370,6 +1428,7 @@ Request a URL to receive streaming output using [server-sent events (SSE)](https If the requested model version supports streaming, the returned prediction will have a `stream` entry in its `urls` property with an HTTPS URL that you can use to construct an [`EventSource`](https://developer.mozilla.org/en-US/docs/Web/API/EventSource). , + ParameterName: stream, ArgumentName: stream }, { @@ -1384,6 +1443,7 @@ If the requested model version supports streaming, the returned prediction will }, IsRequired: true, Summary: The ID of the model version that you want to run., + ParameterName: version, ArgumentName: version }, { @@ -1400,6 +1460,7 @@ If the requested model version supports streaming, the returned prediction will Summary: An HTTPS URL for receiving a webhook when the prediction has new output. The webhook will be a POST request where the request body is the same as the response body of the [get prediction](#predictions.get) operation. If there are network problems, we will retry the webhook a few times, so make sure it can be safely called more than once. Replicate will not follow redirects when sending webhook requests to your service, so be sure to specify a URL that will resolve without redirecting. , + ParameterName: webhook, ArgumentName: webhook }, { @@ -1436,6 +1497,7 @@ For example, if you only wanted requests to be sent at the start and end of the Requests for event types `output` and `logs` will be sent at most once every 500ms. If you request `start` and `completed` webhooks, then they'll always be sent regardless of throttling. , + ParameterName: webhookEventsFilter, ArgumentName: webhookEventsFilter } ], @@ -1470,6 +1532,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: predictionId, ArgumentName: predictionId } ], @@ -1503,6 +1566,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: predictionId, ArgumentName: predictionId } ], @@ -1552,6 +1616,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: trainingId, ArgumentName: trainingId } ], @@ -1585,6 +1650,7 @@ Requests for event types `output` and `logs` will be sent at most once every 500 ParameterStyle: Simple, ParameterExplode: false, Summary: , + ParameterName: trainingId, ArgumentName: trainingId } ], diff --git a/src/tests/OpenApiGenerator.UnitTests/Snapshots/LangSmith/_.verified.txt b/src/tests/OpenApiGenerator.UnitTests/Snapshots/LangSmith/_.verified.txt index 4778a412a3..a384fefda8 100644 --- a/src/tests/OpenApiGenerator.UnitTests/Snapshots/LangSmith/_.verified.txt +++ b/src/tests/OpenApiGenerator.UnitTests/Snapshots/LangSmith/_.verified.txt @@ -19,6 +19,7 @@ }, IsRequired: false, Summary: , + ParameterName: endTime, ArgumentName: endTime }, { @@ -33,6 +34,7 @@ }, IsRequired: false, Summary: , + ParameterName: error, ArgumentName: error }, { @@ -48,6 +50,7 @@ IsRequired: false, DefaultValue: , Summary: , + ParameterName: inputs, ArgumentName: inputs }, { @@ -63,6 +66,7 @@ IsRequired: false, DefaultValue: , Summary: , + ParameterName: outputs, ArgumentName: outputs }, { @@ -77,6 +81,7 @@ }, IsRequired: false, Summary: , + ParameterName: events, ArgumentName: events } ], @@ -158,6 +163,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: model, ArgumentName: model }, { @@ -174,6 +180,7 @@ DefaultValue: , Summary:
Default Value: [], + ParameterName: messages, ArgumentName: messages }, { @@ -190,6 +197,7 @@ DefaultValue: , Summary:
Default Value: [], + ParameterName: functions, ArgumentName: functions }, { @@ -204,6 +212,7 @@ }, IsRequired: false, Summary: , + ParameterName: temperature, ArgumentName: temperature }, { @@ -218,6 +227,7 @@ }, IsRequired: false, Summary: , + ParameterName: topP, ArgumentName: topP }, { @@ -232,6 +242,7 @@ }, IsRequired: false, Summary: , + ParameterName: n, ArgumentName: n }, { @@ -246,6 +257,7 @@ }, IsRequired: false, Summary: , + ParameterName: stream, ArgumentName: stream }, { @@ -261,6 +273,7 @@ IsRequired: false, DefaultValue: , Summary: , + ParameterName: stop, ArgumentName: stop }, { @@ -275,6 +288,7 @@ }, IsRequired: false, Summary: , + ParameterName: maxTokens, ArgumentName: maxTokens }, { @@ -289,6 +303,7 @@ }, IsRequired: false, Summary: , + ParameterName: presencePenalty, ArgumentName: presencePenalty }, { @@ -303,6 +318,7 @@ }, IsRequired: false, Summary: , + ParameterName: frequencyPenalty, ArgumentName: frequencyPenalty }, { @@ -317,6 +333,7 @@ }, IsRequired: false, Summary: , + ParameterName: logitBias, ArgumentName: logitBias } ], @@ -366,6 +383,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: role, ArgumentName: role }, { @@ -380,6 +398,7 @@ }, IsRequired: false, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -394,6 +413,7 @@ }, IsRequired: false, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -411,6 +431,7 @@ }, IsRequired: false, Summary: , + ParameterName: functionCall, ArgumentName: functionCall } ], @@ -444,6 +465,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: name, ArgumentName: name }, { @@ -460,6 +482,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: arguments, ArgumentName: arguments } ], @@ -493,6 +516,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: name, ArgumentName: name }, { @@ -509,6 +533,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: description, ArgumentName: description }, { @@ -526,6 +551,7 @@ }, IsRequired: false, Summary: , + ParameterName: parameters, ArgumentName: parameters } ], @@ -559,6 +585,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: type, ArgumentName: type }, { @@ -575,6 +602,7 @@ DefaultValue: , Summary:
Default Value: , + ParameterName: properties, ArgumentName: properties } ], @@ -623,6 +651,7 @@ }, IsRequired: true, Summary: , + ParameterName: model, ArgumentName: model }, { @@ -637,6 +666,7 @@ }, IsRequired: true, Summary: , + ParameterName: prompt, ArgumentName: prompt }, { @@ -651,6 +681,7 @@ }, IsRequired: false, Summary: , + ParameterName: suffix, ArgumentName: suffix }, { @@ -665,6 +696,7 @@ }, IsRequired: false, Summary: , + ParameterName: maxTokens, ArgumentName: maxTokens }, { @@ -679,6 +711,7 @@ }, IsRequired: false, Summary: , + ParameterName: temperature, ArgumentName: temperature }, { @@ -693,6 +726,7 @@ }, IsRequired: false, Summary: , + ParameterName: topP, ArgumentName: topP }, { @@ -707,6 +741,7 @@ }, IsRequired: false, Summary: , + ParameterName: n, ArgumentName: n }, { @@ -721,6 +756,7 @@ }, IsRequired: false, Summary: , + ParameterName: stream, ArgumentName: stream }, { @@ -735,6 +771,7 @@ }, IsRequired: false, Summary: , + ParameterName: logprobs, ArgumentName: logprobs }, { @@ -749,6 +786,7 @@ }, IsRequired: false, Summary: , + ParameterName: echo, ArgumentName: echo }, { @@ -764,6 +802,7 @@ IsRequired: false, DefaultValue: , Summary: , + ParameterName: stop, ArgumentName: stop }, { @@ -778,6 +817,7 @@ }, IsRequired: false, Summary: , + ParameterName: presencePenalty, ArgumentName: presencePenalty }, { @@ -792,6 +832,7 @@ }, IsRequired: false, Summary: , + ParameterName: frequencyPenalty, ArgumentName: frequencyPenalty }, { @@ -806,6 +847,7 @@ }, IsRequired: false, Summary: , + ParameterName: bestOf, ArgumentName: bestOf }, { @@ -820,6 +862,7 @@ }, IsRequired: false, Summary: , + ParameterName: logitBias, ArgumentName: logitBias }, { @@ -834,6 +877,7 @@ }, IsRequired: false, Summary: , + ParameterName: user, ArgumentName: user } ], @@ -899,6 +943,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: id, ArgumentName: id }, { @@ -915,6 +960,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: object, ArgumentName: object }, { @@ -931,6 +977,7 @@ DefaultValue: 0, Summary:
Default Value: 0, + ParameterName: created, ArgumentName: created }, { @@ -947,6 +994,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: model, ArgumentName: model }, { @@ -963,6 +1011,7 @@ DefaultValue: , Summary:
Default Value: [], + ParameterName: choices, ArgumentName: choices }, { @@ -981,6 +1030,7 @@ }, IsRequired: false, Summary: , + ParameterName: usage, ArgumentName: usage } ], @@ -1014,6 +1064,7 @@ DefaultValue: 0, Summary:
Default Value: 0, + ParameterName: index, ArgumentName: index }, { @@ -1032,6 +1083,7 @@ }, IsRequired: false, Summary: , + ParameterName: message, ArgumentName: message }, { @@ -1048,6 +1100,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: finishReason, ArgumentName: finishReason } ], @@ -1081,6 +1134,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: role, ArgumentName: role }, { @@ -1095,6 +1149,7 @@ }, IsRequired: false, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -1112,6 +1167,7 @@ }, IsRequired: false, Summary: , + ParameterName: functionCall, ArgumentName: functionCall } ], @@ -1145,6 +1201,7 @@ DefaultValue: 0, Summary:
Default Value: 0, + ParameterName: promptTokens, ArgumentName: promptTokens }, { @@ -1161,6 +1218,7 @@ DefaultValue: 0, Summary:
Default Value: 0, + ParameterName: completionTokens, ArgumentName: completionTokens }, { @@ -1177,6 +1235,7 @@ DefaultValue: 0, Summary:
Default Value: 0, + ParameterName: totalTokens, ArgumentName: totalTokens } ], @@ -1208,6 +1267,7 @@ }, IsRequired: false, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -1222,6 +1282,7 @@ }, IsRequired: false, Summary: , + ParameterName: object, ArgumentName: object }, { @@ -1236,6 +1297,7 @@ }, IsRequired: false, Summary: , + ParameterName: created, ArgumentName: created }, { @@ -1250,6 +1312,7 @@ }, IsRequired: false, Summary: , + ParameterName: model, ArgumentName: model }, { @@ -1266,6 +1329,7 @@ DefaultValue: , Summary:
Default Value: [], + ParameterName: choices, ArgumentName: choices }, { @@ -1284,6 +1348,7 @@ }, IsRequired: false, Summary: , + ParameterName: usage, ArgumentName: usage } ], @@ -1317,6 +1382,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: text, ArgumentName: text }, { @@ -1333,6 +1399,7 @@ DefaultValue: 0, Summary:
Default Value: 0, + ParameterName: index, ArgumentName: index }, { @@ -1352,6 +1419,7 @@ }, IsRequired: false, Summary: , + ParameterName: logprobs, ArgumentName: logprobs }, { @@ -1368,6 +1436,7 @@ DefaultValue: "", Summary:
Default Value: , + ParameterName: finishReason, ArgumentName: finishReason } ], @@ -1401,6 +1470,7 @@ DefaultValue: , Summary:
Default Value: [], + ParameterName: tokens, ArgumentName: tokens }, { @@ -1417,6 +1487,7 @@ DefaultValue: , Summary:
Default Value: [], + ParameterName: tokenLogprobs, ArgumentName: tokenLogprobs }, { @@ -1433,6 +1504,7 @@ DefaultValue: , Summary:
Default Value: [], + ParameterName: topLogprobs, ArgumentName: topLogprobs }, { @@ -1449,6 +1521,7 @@ DefaultValue: , Summary:
Default Value: [], + ParameterName: textOffset, ArgumentName: textOffset } ], @@ -1496,6 +1569,7 @@ }, IsRequired: false, Summary: , + ParameterName: detail, ArgumentName: detail } ], @@ -1527,6 +1601,7 @@ }, IsRequired: true, Summary: , + ParameterName: loc, ArgumentName: loc }, { @@ -1541,6 +1616,7 @@ }, IsRequired: true, Summary: , + ParameterName: msg, ArgumentName: msg }, { @@ -1555,6 +1631,7 @@ }, IsRequired: true, Summary: , + ParameterName: type, ArgumentName: type } ], @@ -1586,6 +1663,7 @@ }, IsRequired: true, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -1601,6 +1679,7 @@ IsRequired: false, DefaultValue: , Summary: , + ParameterName: inputs, ArgumentName: inputs }, { @@ -1631,6 +1710,7 @@ }, IsRequired: true, Summary: Enum for run types., + ParameterName: runType, ArgumentName: runType }, { @@ -1645,6 +1725,7 @@ }, IsRequired: false, Summary: , + ParameterName: startTime, ArgumentName: startTime }, { @@ -1659,6 +1740,7 @@ }, IsRequired: false, Summary: , + ParameterName: endTime, ArgumentName: endTime }, { @@ -1673,6 +1755,7 @@ }, IsRequired: false, Summary: , + ParameterName: extra, ArgumentName: extra }, { @@ -1687,6 +1770,7 @@ }, IsRequired: false, Summary: , + ParameterName: error, ArgumentName: error }, { @@ -1703,6 +1787,7 @@ DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: executionOrder, ArgumentName: executionOrder }, { @@ -1717,6 +1802,7 @@ }, IsRequired: false, Summary: , + ParameterName: serialized, ArgumentName: serialized }, { @@ -1732,6 +1818,7 @@ IsRequired: false, DefaultValue: , Summary: , + ParameterName: outputs, ArgumentName: outputs }, { @@ -1746,6 +1833,7 @@ }, IsRequired: false, Summary: , + ParameterName: parentRunId, ArgumentName: parentRunId }, { @@ -1760,6 +1848,7 @@ }, IsRequired: false, Summary: , + ParameterName: manifestId, ArgumentName: manifestId }, { @@ -1774,6 +1863,7 @@ }, IsRequired: false, Summary: , + ParameterName: events, ArgumentName: events }, { @@ -1788,6 +1878,7 @@ }, IsRequired: false, Summary: , + ParameterName: tags, ArgumentName: tags }, { @@ -1802,6 +1893,7 @@ }, IsRequired: false, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -1816,6 +1908,7 @@ }, IsRequired: false, Summary: , + ParameterName: sessionId, ArgumentName: sessionId }, { @@ -1830,6 +1923,7 @@ }, IsRequired: false, Summary: , + ParameterName: sessionName, ArgumentName: sessionName }, { @@ -1844,6 +1938,7 @@ }, IsRequired: false, Summary: , + ParameterName: childRuns, ArgumentName: childRuns }, { @@ -1858,6 +1953,7 @@ }, IsRequired: false, Summary: , + ParameterName: referenceExampleId, ArgumentName: referenceExampleId } ], @@ -1970,6 +2066,7 @@ }, IsRequired: false, Summary: , + ParameterName: tool, ArgumentName: tool }, { @@ -1984,6 +2081,7 @@ }, IsRequired: false, Summary: , + ParameterName: chain, ArgumentName: chain }, { @@ -1998,6 +2096,7 @@ }, IsRequired: false, Summary: , + ParameterName: llm, ArgumentName: llm }, { @@ -2012,6 +2111,7 @@ }, IsRequired: false, Summary: , + ParameterName: retriever, ArgumentName: retriever }, { @@ -2026,6 +2126,7 @@ }, IsRequired: false, Summary: , + ParameterName: embedding, ArgumentName: embedding }, { @@ -2040,6 +2141,7 @@ }, IsRequired: false, Summary: , + ParameterName: prompt, ArgumentName: prompt }, { @@ -2054,6 +2156,7 @@ }, IsRequired: false, Summary: , + ParameterName: parser, ArgumentName: parser } ], @@ -2101,6 +2204,7 @@ }, IsRequired: true, Summary: , + ParameterName: name, ArgumentName: name }, { @@ -2115,6 +2219,7 @@ }, IsRequired: false, Summary: , + ParameterName: inputs, ArgumentName: inputs }, { @@ -2145,6 +2250,7 @@ }, IsRequired: true, Summary: Enum for run types., + ParameterName: runType, ArgumentName: runType }, { @@ -2159,6 +2265,7 @@ }, IsRequired: false, Summary: , + ParameterName: startTime, ArgumentName: startTime }, { @@ -2173,6 +2280,7 @@ }, IsRequired: false, Summary: , + ParameterName: endTime, ArgumentName: endTime }, { @@ -2187,6 +2295,7 @@ }, IsRequired: false, Summary: , + ParameterName: extra, ArgumentName: extra }, { @@ -2201,6 +2310,7 @@ }, IsRequired: false, Summary: , + ParameterName: error, ArgumentName: error }, { @@ -2217,6 +2327,7 @@ DefaultValue: 1, Summary:
Default Value: 1, + ParameterName: executionOrder, ArgumentName: executionOrder }, { @@ -2231,6 +2342,7 @@ }, IsRequired: false, Summary: , + ParameterName: serialized, ArgumentName: serialized }, { @@ -2245,6 +2357,7 @@ }, IsRequired: false, Summary: , + ParameterName: outputs, ArgumentName: outputs }, { @@ -2259,6 +2372,7 @@ }, IsRequired: false, Summary: , + ParameterName: parentRunId, ArgumentName: parentRunId }, { @@ -2273,6 +2387,7 @@ }, IsRequired: false, Summary: , + ParameterName: manifestId, ArgumentName: manifestId }, { @@ -2287,6 +2402,7 @@ }, IsRequired: false, Summary: , + ParameterName: events, ArgumentName: events }, { @@ -2301,6 +2417,7 @@ }, IsRequired: false, Summary: , + ParameterName: tags, ArgumentName: tags }, { @@ -2315,6 +2432,7 @@ }, IsRequired: false, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -2329,6 +2447,7 @@ }, IsRequired: false, Summary: , + ParameterName: sessionId, ArgumentName: sessionId }, { @@ -2343,6 +2462,7 @@ }, IsRequired: false, Summary: , + ParameterName: sessionName, ArgumentName: sessionName }, { @@ -2357,6 +2477,7 @@ }, IsRequired: false, Summary: , + ParameterName: childRuns, ArgumentName: childRuns }, { @@ -2371,6 +2492,7 @@ }, IsRequired: false, Summary: , + ParameterName: referenceExampleId, ArgumentName: referenceExampleId } ], @@ -2483,6 +2605,7 @@ }, IsRequired: false, Summary: , + ParameterName: tool, ArgumentName: tool }, { @@ -2497,6 +2620,7 @@ }, IsRequired: false, Summary: , + ParameterName: chain, ArgumentName: chain }, { @@ -2511,6 +2635,7 @@ }, IsRequired: false, Summary: , + ParameterName: llm, ArgumentName: llm }, { @@ -2525,6 +2650,7 @@ }, IsRequired: false, Summary: , + ParameterName: retriever, ArgumentName: retriever }, { @@ -2539,6 +2665,7 @@ }, IsRequired: false, Summary: , + ParameterName: embedding, ArgumentName: embedding }, { @@ -2553,6 +2680,7 @@ }, IsRequired: false, Summary: , + ParameterName: prompt, ArgumentName: prompt }, { @@ -2567,6 +2695,7 @@ }, IsRequired: false, Summary: , + ParameterName: parser, ArgumentName: parser } ], diff --git a/src/tests/OpenApiGenerator.UnitTests/Snapshots/Ollama/_.verified.txt b/src/tests/OpenApiGenerator.UnitTests/Snapshots/Ollama/_.verified.txt index 99f321885f..ef0053a97a 100644 --- a/src/tests/OpenApiGenerator.UnitTests/Snapshots/Ollama/_.verified.txt +++ b/src/tests/OpenApiGenerator.UnitTests/Snapshots/Ollama/_.verified.txt @@ -24,6 +24,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: model, ArgumentName: model }, { @@ -40,6 +41,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a Summary: The prompt to generate a response.
Example: Why is the sky blue?, + ParameterName: prompt, ArgumentName: prompt }, { @@ -54,6 +56,7 @@ The prompt to generate a response. }, IsRequired: false, Summary: (optional) a list of Base64-encoded images to include in the message (for multimodal models such as llava), + ParameterName: images, ArgumentName: images }, { @@ -68,6 +71,7 @@ The prompt to generate a response. }, IsRequired: false, Summary: The system prompt to (overrides what is defined in the Modelfile)., + ParameterName: system, ArgumentName: system }, { @@ -82,6 +86,7 @@ The prompt to generate a response. }, IsRequired: false, Summary: The full prompt or prompt template (overrides what is defined in the Modelfile)., + ParameterName: template, ArgumentName: template }, { @@ -96,6 +101,7 @@ The prompt to generate a response. }, IsRequired: false, Summary: The context parameter returned from a previous request to [generateCompletion], this can be used to keep a short conversational memory., + ParameterName: context, ArgumentName: context }, { @@ -144,6 +150,7 @@ The prompt to generate a response. }, IsRequired: false, Summary: Additional model parameters listed in the documentation for the Modelfile such as `temperature`., + ParameterName: options, ArgumentName: options }, { @@ -168,6 +175,7 @@ Enable JSON mode by setting the format parameter to json. This will structure th Note: it's important to instruct the model to use JSON in the prompt. Otherwise, the model may generate large amounts whitespace. , + ParameterName: format, ArgumentName: format }, { @@ -186,6 +194,7 @@ If `true` no formatting will be applied to the prompt and no context will be ret You may choose to use the `raw` parameter if you are specifying a full templated prompt in your request to the API, and are managing history yourself. , + ParameterName: raw, ArgumentName: raw }, { @@ -204,6 +213,7 @@ You may choose to use the `raw` parameter if you are specifying a full templated If `false` the response will be returned as a single response object, otherwise the response will be streamed as a series of objects.
Default Value: false, + ParameterName: stream, ArgumentName: stream }, { @@ -225,6 +235,7 @@ How long (in minutes) to keep the model loaded in memory. - If set to 0, the model will be unloaded immediately once finished. - If not set, the model will stay loaded for 5 minutes by default , + ParameterName: keepAlive, ArgumentName: keepAlive } ], @@ -257,6 +268,7 @@ How long (in minutes) to keep the model loaded in memory. }, IsRequired: false, Summary: , + ParameterName: json, ArgumentName: json } ], @@ -296,6 +308,7 @@ Note: it's important to instruct the model to use JSON in the prompt. Otherwise, Summary: Number of tokens to keep from the prompt. , + ParameterName: numKeep, ArgumentName: numKeep }, { @@ -312,6 +325,7 @@ Number of tokens to keep from the prompt. Summary: Sets the random number seed to use for generation. Setting this to a specific number will make the model generate the same text for the same prompt. (Default: 0) , + ParameterName: seed, ArgumentName: seed }, { @@ -328,6 +342,7 @@ Sets the random number seed to use for generation. Setting this to a specific nu Summary: Maximum number of tokens to predict when generating text. (Default: 128, -1 = infinite generation, -2 = fill context) , + ParameterName: numPredict, ArgumentName: numPredict }, { @@ -344,6 +359,7 @@ Maximum number of tokens to predict when generating text. (Default: 128, -1 = in Summary: Reduces the probability of generating nonsense. A higher value (e.g. 100) will give more diverse answers, while a lower value (e.g. 10) will be more conservative. (Default: 40) , + ParameterName: topK, ArgumentName: topK }, { @@ -360,6 +376,7 @@ Reduces the probability of generating nonsense. A higher value (e.g. 100) will g Summary: Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse text, while a lower value (e.g., 0.5) will generate more focused and conservative text. (Default: 0.9) , + ParameterName: topP, ArgumentName: topP }, { @@ -376,6 +393,7 @@ Works together with top-k. A higher value (e.g., 0.95) will lead to more diverse Summary: Tail free sampling is used to reduce the impact of less probable tokens from the output. A higher value (e.g., 2.0) will reduce the impact more, while a value of 1.0 disables this setting. (default: 1) , + ParameterName: tfsZ, ArgumentName: tfsZ }, { @@ -392,6 +410,7 @@ Tail free sampling is used to reduce the impact of less probable tokens from the Summary: Typical p is used to reduce the impact of less probable tokens from the output. , + ParameterName: typicalP, ArgumentName: typicalP }, { @@ -408,6 +427,7 @@ Typical p is used to reduce the impact of less probable tokens from the output. Summary: Sets how far back for the model to look back to prevent repetition. (Default: 64, 0 = disabled, -1 = num_ctx) , + ParameterName: repeatLastN, ArgumentName: repeatLastN }, { @@ -424,6 +444,7 @@ Sets how far back for the model to look back to prevent repetition. (Default: 64 Summary: The temperature of the model. Increasing the temperature will make the model answer more creatively. (Default: 0.8) , + ParameterName: temperature, ArgumentName: temperature }, { @@ -440,6 +461,7 @@ The temperature of the model. Increasing the temperature will make the model ans Summary: Sets how strongly to penalize repetitions. A higher value (e.g., 1.5) will penalize repetitions more strongly, while a lower value (e.g., 0.9) will be more lenient. (Default: 1.1) , + ParameterName: repeatPenalty, ArgumentName: repeatPenalty }, { @@ -456,6 +478,7 @@ Sets how strongly to penalize repetitions. A higher value (e.g., 1.5) will penal Summary: Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. , + ParameterName: presencePenalty, ArgumentName: presencePenalty }, { @@ -472,6 +495,7 @@ Positive values penalize new tokens based on whether they appear in the text so Summary: Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. , + ParameterName: frequencyPenalty, ArgumentName: frequencyPenalty }, { @@ -488,6 +512,7 @@ Positive values penalize new tokens based on their existing frequency in the tex Summary: Enable Mirostat sampling for controlling perplexity. (default: 0, 0 = disabled, 1 = Mirostat, 2 = Mirostat 2.0) , + ParameterName: mirostat, ArgumentName: mirostat }, { @@ -504,6 +529,7 @@ Enable Mirostat sampling for controlling perplexity. (default: 0, 0 = disabled, Summary: Controls the balance between coherence and diversity of the output. A lower value will result in more focused and coherent text. (Default: 5.0) , + ParameterName: mirostatTau, ArgumentName: mirostatTau }, { @@ -520,6 +546,7 @@ Controls the balance between coherence and diversity of the output. A lower valu Summary: Influences how quickly the algorithm responds to feedback from the generated text. A lower learning rate will result in slower adjustments, while a higher learning rate will make the algorithm more responsive. (Default: 0.1) , + ParameterName: mirostatEta, ArgumentName: mirostatEta }, { @@ -536,6 +563,7 @@ Influences how quickly the algorithm responds to feedback from the generated tex Summary: Penalize newlines in the output. (Default: false) , + ParameterName: penalizeNewline, ArgumentName: penalizeNewline }, { @@ -550,6 +578,7 @@ Penalize newlines in the output. (Default: false) }, IsRequired: false, Summary: Sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence., + ParameterName: stop, ArgumentName: stop }, { @@ -566,6 +595,7 @@ Penalize newlines in the output. (Default: false) Summary: Enable NUMA support. (Default: false) , + ParameterName: numa, ArgumentName: numa }, { @@ -582,6 +612,7 @@ Enable NUMA support. (Default: false) Summary: Sets the size of the context window used to generate the next token. , + ParameterName: numCtx, ArgumentName: numCtx }, { @@ -598,6 +629,7 @@ Sets the size of the context window used to generate the next token. Summary: Sets the number of batches to use for generation. (Default: 1) , + ParameterName: numBatch, ArgumentName: numBatch }, { @@ -614,6 +646,7 @@ Sets the number of batches to use for generation. (Default: 1) Summary: The number of GQA groups in the transformer layer. Required for some models, for example it is 8 for `llama2:70b`. , + ParameterName: numGqa, ArgumentName: numGqa }, { @@ -630,6 +663,7 @@ The number of GQA groups in the transformer layer. Required for some models, for Summary: The number of layers to send to the GPU(s). On macOS it defaults to 1 to enable metal support, 0 to disable. , + ParameterName: numGpu, ArgumentName: numGpu }, { @@ -646,6 +680,7 @@ The number of layers to send to the GPU(s). On macOS it defaults to 1 to enable Summary: The GPU to use for the main model. Default is 0. , + ParameterName: mainGpu, ArgumentName: mainGpu }, { @@ -662,6 +697,7 @@ The GPU to use for the main model. Default is 0. Summary: Enable low VRAM mode. (Default: false) , + ParameterName: lowVram, ArgumentName: lowVram }, { @@ -678,6 +714,7 @@ Enable low VRAM mode. (Default: false) Summary: Enable f16 key/value. (Default: false) , + ParameterName: f16Kv, ArgumentName: f16Kv }, { @@ -694,6 +731,7 @@ Enable f16 key/value. (Default: false) Summary: Enable logits all. (Default: false) , + ParameterName: logitsAll, ArgumentName: logitsAll }, { @@ -710,6 +748,7 @@ Enable logits all. (Default: false) Summary: Enable vocab only. (Default: false) , + ParameterName: vocabOnly, ArgumentName: vocabOnly }, { @@ -726,6 +765,7 @@ Enable vocab only. (Default: false) Summary: Enable mmap. (Default: false) , + ParameterName: useMmap, ArgumentName: useMmap }, { @@ -742,6 +782,7 @@ Enable mmap. (Default: false) Summary: Enable mlock. (Default: false) , + ParameterName: useMlock, ArgumentName: useMlock }, { @@ -758,6 +799,7 @@ Enable mlock. (Default: false) Summary: Enable embedding only. (Default: false) , + ParameterName: embeddingOnly, ArgumentName: embeddingOnly }, { @@ -774,6 +816,7 @@ Enable embedding only. (Default: false) Summary: The base of the rope frequency scale. (Default: 1.0) , + ParameterName: ropeFrequencyBase, ArgumentName: ropeFrequencyBase }, { @@ -790,6 +833,7 @@ The base of the rope frequency scale. (Default: 1.0) Summary: The scale of the rope frequency. (Default: 1.0) , + ParameterName: ropeFrequencyScale, ArgumentName: ropeFrequencyScale }, { @@ -806,6 +850,7 @@ The scale of the rope frequency. (Default: 1.0) Summary: Sets the number of threads to use during computation. By default, Ollama will detect this for optimal performance. It is recommended to set this value to the number of physical CPU cores your system has (as opposed to the logical number of cores). , + ParameterName: numThread, ArgumentName: numThread } ], @@ -864,6 +909,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: model, ArgumentName: model }, { @@ -880,6 +926,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a Summary: Date on which a model was created.
Example: , + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -896,6 +943,7 @@ Date on which a model was created. Summary: The response for a given prompt with a provided model.
Example: The sky appears blue because of a phenomenon called Rayleigh scattering., + ParameterName: response, ArgumentName: response }, { @@ -912,6 +960,7 @@ The response for a given prompt with a provided model. Summary: Whether the response has completed.
Example: true, + ParameterName: done, ArgumentName: done }, { @@ -929,6 +978,7 @@ Whether the response has completed. An encoding of the conversation used in this response, this can be sent in the next request to keep a conversational memory.
Example: [1, 2, 3], + ParameterName: context, ArgumentName: context }, { @@ -945,6 +995,7 @@ An encoding of the conversation used in this response, this can be sent in the n Summary: Time spent generating the response.
Example: 5589157167, + ParameterName: totalDuration, ArgumentName: totalDuration }, { @@ -961,6 +1012,7 @@ Time spent generating the response. Summary: Time spent in nanoseconds loading the model.
Example: 3013701500, + ParameterName: loadDuration, ArgumentName: loadDuration }, { @@ -977,6 +1029,7 @@ Time spent in nanoseconds loading the model. Summary: Number of tokens in the prompt.
Example: 46, + ParameterName: promptEvalCount, ArgumentName: promptEvalCount }, { @@ -993,6 +1046,7 @@ Number of tokens in the prompt. Summary: Time spent in nanoseconds evaluating the prompt.
Example: 1160282000, + ParameterName: promptEvalDuration, ArgumentName: promptEvalDuration }, { @@ -1009,6 +1063,7 @@ Time spent in nanoseconds evaluating the prompt. Summary: Number of tokens the response.
Example: 113, + ParameterName: evalCount, ArgumentName: evalCount }, { @@ -1025,6 +1080,7 @@ Number of tokens the response. Summary: Time in nanoseconds spent generating the response.
Example: 1325948000, + ParameterName: evalDuration, ArgumentName: evalDuration } ], @@ -1061,6 +1117,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: model, ArgumentName: model }, { @@ -1075,6 +1132,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a }, IsRequired: true, Summary: The messages of the chat, this can be used to keep a chat memory, + ParameterName: messages, ArgumentName: messages }, { @@ -1099,6 +1157,7 @@ Enable JSON mode by setting the format parameter to json. This will structure th Note: it's important to instruct the model to use JSON in the prompt. Otherwise, the model may generate large amounts whitespace. , + ParameterName: format, ArgumentName: format }, { @@ -1147,6 +1206,7 @@ Note: it's important to instruct the model to use JSON in the prompt. Otherwise, }, IsRequired: false, Summary: Additional model parameters listed in the documentation for the Modelfile such as `temperature`., + ParameterName: options, ArgumentName: options }, { @@ -1165,6 +1225,7 @@ Note: it's important to instruct the model to use JSON in the prompt. Otherwise, If `false` the response will be returned as a single response object, otherwise the response will be streamed as a series of objects.
Default Value: false, + ParameterName: stream, ArgumentName: stream }, { @@ -1186,6 +1247,7 @@ How long (in minutes) to keep the model loaded in memory. - If set to 0, the model will be unloaded immediately once finished. - If not set, the model will stay loaded for 5 minutes by default , + ParameterName: keepAlive, ArgumentName: keepAlive } ], @@ -1218,6 +1280,7 @@ How long (in minutes) to keep the model loaded in memory. }, IsRequired: false, Summary: , + ParameterName: json, ArgumentName: json } ], @@ -1259,6 +1322,7 @@ Note: it's important to instruct the model to use JSON in the prompt. Otherwise, }, IsRequired: false, Summary: A message in the chat endpoint, + ParameterName: message, ArgumentName: message }, { @@ -1278,6 +1342,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: model, ArgumentName: model }, { @@ -1294,6 +1359,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a Summary: Date on which a model was created.
Example: , + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -1310,6 +1376,7 @@ Date on which a model was created. Summary: Whether the response has completed.
Example: true, + ParameterName: done, ArgumentName: done }, { @@ -1326,6 +1393,7 @@ Whether the response has completed. Summary: Time spent generating the response.
Example: 5589157167, + ParameterName: totalDuration, ArgumentName: totalDuration }, { @@ -1342,6 +1410,7 @@ Time spent generating the response. Summary: Time spent in nanoseconds loading the model.
Example: 3013701500, + ParameterName: loadDuration, ArgumentName: loadDuration }, { @@ -1358,6 +1427,7 @@ Time spent in nanoseconds loading the model. Summary: Number of tokens in the prompt.
Example: 46, + ParameterName: promptEvalCount, ArgumentName: promptEvalCount }, { @@ -1374,6 +1444,7 @@ Number of tokens in the prompt. Summary: Time spent in nanoseconds evaluating the prompt.
Example: 1160282000, + ParameterName: promptEvalDuration, ArgumentName: promptEvalDuration }, { @@ -1390,6 +1461,7 @@ Time spent in nanoseconds evaluating the prompt. Summary: Number of tokens the response.
Example: 113, + ParameterName: evalCount, ArgumentName: evalCount }, { @@ -1406,6 +1478,7 @@ Number of tokens the response. Summary: Time in nanoseconds spent generating the response.
Example: 1325948000, + ParameterName: evalDuration, ArgumentName: evalDuration } ], @@ -1445,6 +1518,7 @@ Time in nanoseconds spent generating the response. }, IsRequired: true, Summary: The role of the message, + ParameterName: role, ArgumentName: role }, { @@ -1461,6 +1535,7 @@ Time in nanoseconds spent generating the response. Summary: The content of the message
Example: Why is the sky blue?, + ParameterName: content, ArgumentName: content }, { @@ -1475,6 +1550,7 @@ The content of the message }, IsRequired: false, Summary: (optional) a list of Base64-encoded images to include in the message (for multimodal models such as llava), + ParameterName: images, ArgumentName: images } ], @@ -1507,6 +1583,7 @@ The content of the message }, IsRequired: false, Summary: , + ParameterName: system, ArgumentName: system }, { @@ -1521,6 +1598,7 @@ The content of the message }, IsRequired: false, Summary: , + ParameterName: user, ArgumentName: user }, { @@ -1535,6 +1613,7 @@ The content of the message }, IsRequired: false, Summary: , + ParameterName: assistant, ArgumentName: assistant } ], @@ -1571,6 +1650,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: model, ArgumentName: model }, { @@ -1587,6 +1667,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a Summary: Text to generate embeddings for.
Example: Here is an article about llamas..., + ParameterName: prompt, ArgumentName: prompt }, { @@ -1635,6 +1716,7 @@ Text to generate embeddings for. }, IsRequired: false, Summary: Additional model parameters listed in the documentation for the Modelfile such as `temperature`., + ParameterName: options, ArgumentName: options } ], @@ -1668,6 +1750,7 @@ Text to generate embeddings for. Summary: The embedding for the prompt.
Example: [0.5670403838157654, 0.009260174818336964, ...], + ParameterName: embedding, ArgumentName: embedding } ], @@ -1704,6 +1787,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: mario, + ParameterName: name, ArgumentName: name }, { @@ -1720,6 +1804,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a Summary: The contents of the Modelfile.
Example: FROM llama2\nSYSTEM You are mario from Super Mario Bros., + ParameterName: modelfile, ArgumentName: modelfile }, { @@ -1738,6 +1823,7 @@ The contents of the Modelfile. If `false` the response will be returned as a single response object, otherwise the response will be streamed as a series of objects.
Default Value: false, + ParameterName: stream, ArgumentName: stream } ], @@ -1777,6 +1863,7 @@ If `false` the response will be returned as a single response object, otherwise }, IsRequired: false, Summary: Status creating the model, + ParameterName: status, ArgumentName: status } ], @@ -1809,6 +1896,7 @@ If `false` the response will be returned as a single response object, otherwise }, IsRequired: false, Summary: , + ParameterName: creatingSystemLayer, ArgumentName: creatingSystemLayer }, { @@ -1823,6 +1911,7 @@ If `false` the response will be returned as a single response object, otherwise }, IsRequired: false, Summary: , + ParameterName: parsingModelfile, ArgumentName: parsingModelfile }, { @@ -1837,6 +1926,7 @@ If `false` the response will be returned as a single response object, otherwise }, IsRequired: false, Summary: , + ParameterName: success, ArgumentName: success } ], @@ -1884,6 +1974,7 @@ If `false` the response will be returned as a single response object, otherwise }, IsRequired: false, Summary: List of models available locally., + ParameterName: models, ArgumentName: models } ], @@ -1920,6 +2011,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: name, ArgumentName: name }, { @@ -1936,6 +2028,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a Summary: Model modification date.
Example: , + ParameterName: modifiedAt, ArgumentName: modifiedAt }, { @@ -1952,6 +2045,7 @@ Model modification date. Summary: Size of the model on disk.
Example: 7323310500, + ParameterName: size, ArgumentName: size } ], @@ -1988,6 +2082,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: name, ArgumentName: name } ], @@ -2021,6 +2116,7 @@ Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` a Summary: The model's license.
Example: <contents of license block>, + ParameterName: license, ArgumentName: license }, { @@ -2037,6 +2133,7 @@ The model's license. Summary: The modelfile associated with the model.
Example: Modelfile generated by \"ollama show\"\n# To build a new Modelfile based on this one, replace the FROM line with:\n# FROM llama2:latest\n\nFROM /Users/username/.ollama/models/blobs/sha256:8daa9615cce30c259a9555b1cc250d461d1bc69980a274b44d7eda0be78076d8\nTEMPLATE \"\"\"[INST] {{ if and .First .System }}<<SYS>>{{ .System }}<</SYS>>\n\n{{ end }}{{ .Prompt }} [/INST] \"\"\"\nSYSTEM \"\"\"\"\"\"\nPARAMETER stop [INST]\nPARAMETER stop [/INST]\nPARAMETER stop <<SYS>>\nPARAMETER stop <</SYS>>\n", + ParameterName: modelfile, ArgumentName: modelfile }, { @@ -2053,6 +2150,7 @@ The modelfile associated with the model. Summary: The model parameters.
Example: stop [INST]\nstop [/INST]\nstop <<SYS>>\nstop <</SYS>>, + ParameterName: parameters, ArgumentName: parameters }, { @@ -2069,6 +2167,7 @@ The model parameters. Summary: The prompt template for the model.
Example: [INST] {{ if and .First .System }}<<SYS>>{{ .System }}<</SYS>>\n\n{{ end }}{{ .Prompt }} [/INST], + ParameterName: template, ArgumentName: template } ], @@ -2102,6 +2201,7 @@ The prompt template for the model. Summary: Name of the model to copy.
Example: llama2:7b, + ParameterName: source, ArgumentName: source }, { @@ -2118,6 +2218,7 @@ Name of the model to copy. Summary: Name of the new model.
Example: llama2-backup, + ParameterName: destination, ArgumentName: destination } ], @@ -2154,6 +2255,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:13b, + ParameterName: name, ArgumentName: name } ], @@ -2190,6 +2292,7 @@ The model name. Model names follow a `model:tag` format. Some examples are `orca-mini:3b-q4_1` and `llama2:70b`. The tag is optional and, if not provided, will default to `latest`. The tag is used to identify a specific version.
Example: llama2:7b, + ParameterName: name, ArgumentName: name }, { @@ -2210,6 +2313,7 @@ Allow insecure connections to the library. Only use this if you are pulling from your own library during development.
Default Value: false, + ParameterName: insecure, ArgumentName: insecure }, { @@ -2228,6 +2332,7 @@ Only use this if you are pulling from your own library during development. If `false` the response will be returned as a single response object, otherwise the response will be streamed as a series of objects.
Default Value: false, + ParameterName: stream, ArgumentName: stream } ], @@ -2275,6 +2380,7 @@ If `false` the response will be returned as a single response object, otherwise Summary: Status pulling the model.
Example: pulling manifest, + ParameterName: status, ArgumentName: status }, { @@ -2291,6 +2397,7 @@ Status pulling the model. Summary: The model's digest.
Example: sha256:bc07c81de745696fdf5afca05e065818a8149fb0c77266fb584d9b2cba3711a, + ParameterName: digest, ArgumentName: digest }, { @@ -2307,6 +2414,7 @@ The model's digest. Summary: Total size of the model.
Example: 2142590208, + ParameterName: total, ArgumentName: total }, { @@ -2323,6 +2431,7 @@ Total size of the model. Summary: Total bytes transferred.
Example: 2142590208, + ParameterName: completed, ArgumentName: completed } ], @@ -2361,6 +2470,7 @@ The number of files to be downloaded depends on the number of layers specified i }, IsRequired: false, Summary: , + ParameterName: pullingManifest, ArgumentName: pullingManifest }, { @@ -2375,6 +2485,7 @@ The number of files to be downloaded depends on the number of layers specified i }, IsRequired: false, Summary: , + ParameterName: downloadingDigestname, ArgumentName: downloadingDigestname }, { @@ -2389,6 +2500,7 @@ The number of files to be downloaded depends on the number of layers specified i }, IsRequired: false, Summary: , + ParameterName: verifyingSha256Digest, ArgumentName: verifyingSha256Digest }, { @@ -2403,6 +2515,7 @@ The number of files to be downloaded depends on the number of layers specified i }, IsRequired: false, Summary: , + ParameterName: writingManifest, ArgumentName: writingManifest }, { @@ -2417,6 +2530,7 @@ The number of files to be downloaded depends on the number of layers specified i }, IsRequired: false, Summary: , + ParameterName: removingAnyUnusedLayers, ArgumentName: removingAnyUnusedLayers }, { @@ -2431,6 +2545,7 @@ The number of files to be downloaded depends on the number of layers specified i }, IsRequired: false, Summary: , + ParameterName: success, ArgumentName: success } ], @@ -2484,6 +2599,7 @@ Status pulling the model. Summary: The name of the model to push in the form of <namespace>/<model>:<tag>.
Example: mattw/pygmalion:latest, + ParameterName: name, ArgumentName: name }, { @@ -2504,6 +2620,7 @@ Allow insecure connections to the library. Only use this if you are pushing to your library during development.
Default Value: false, + ParameterName: insecure, ArgumentName: insecure }, { @@ -2522,6 +2639,7 @@ Only use this if you are pushing to your library during development. If `false` the response will be returned as a single response object, otherwise the response will be streamed as a series of objects.
Default Value: false, + ParameterName: stream, ArgumentName: stream } ], @@ -2563,6 +2681,7 @@ If `false` the response will be returned as a single response object, otherwise }, IsRequired: false, Summary: Status pushing the model., + ParameterName: status, ArgumentName: status }, { @@ -2579,6 +2698,7 @@ If `false` the response will be returned as a single response object, otherwise Summary: the model's digest
Example: sha256:bc07c81de745696fdf5afca05e065818a8149fb0c77266fb584d9b2cba3711a, + ParameterName: digest, ArgumentName: digest }, { @@ -2595,6 +2715,7 @@ the model's digest Summary: total size of the model
Example: 2142590208, + ParameterName: total, ArgumentName: total } ], @@ -2627,6 +2748,7 @@ total size of the model }, IsRequired: false, Summary: , + ParameterName: retrievingManifest, ArgumentName: retrievingManifest }, { @@ -2641,6 +2763,7 @@ total size of the model }, IsRequired: false, Summary: , + ParameterName: startingUpload, ArgumentName: startingUpload }, { @@ -2655,6 +2778,7 @@ total size of the model }, IsRequired: false, Summary: , + ParameterName: pushingManifest, ArgumentName: pushingManifest }, { @@ -2669,6 +2793,7 @@ total size of the model }, IsRequired: false, Summary: , + ParameterName: success, ArgumentName: success } ], diff --git a/src/tests/OpenApiGenerator.UnitTests/Snapshots/OpenAi/_.verified.txt b/src/tests/OpenApiGenerator.UnitTests/Snapshots/OpenAi/_.verified.txt index af4578794f..80523bb73e 100644 --- a/src/tests/OpenApiGenerator.UnitTests/Snapshots/OpenAi/_.verified.txt +++ b/src/tests/OpenApiGenerator.UnitTests/Snapshots/OpenAi/_.verified.txt @@ -19,6 +19,7 @@ }, IsRequired: true, Summary: , + ParameterName: code, ArgumentName: code }, { @@ -33,6 +34,7 @@ }, IsRequired: true, Summary: , + ParameterName: message, ArgumentName: message }, { @@ -47,6 +49,7 @@ }, IsRequired: true, Summary: , + ParameterName: param, ArgumentName: param }, { @@ -61,6 +64,7 @@ }, IsRequired: true, Summary: , + ParameterName: type, ArgumentName: type } ], @@ -97,6 +101,7 @@ }, IsRequired: true, Summary: , + ParameterName: error, ArgumentName: error } ], @@ -132,6 +137,7 @@ }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object }, { @@ -146,6 +152,7 @@ }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data } ], @@ -178,6 +185,7 @@ }, IsRequired: false, Summary: , + ParameterName: list, ArgumentName: list } ], @@ -209,6 +217,7 @@ }, IsRequired: true, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -223,6 +232,7 @@ }, IsRequired: true, Summary: , + ParameterName: deleted, ArgumentName: deleted }, { @@ -237,6 +247,7 @@ }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object } ], @@ -270,6 +281,7 @@ Summary: ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. , + ParameterName: model, ArgumentName: model }, { @@ -290,6 +302,7 @@ The prompt(s) to generate completions for, encoded as a string, array of strings Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.
Default Value: <|endoftext|>, + ParameterName: prompt, ArgumentName: prompt }, { @@ -312,6 +325,7 @@ When used with `n`, `best_of` controls the number of candidate completions and ` **Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.
Default Value: 1, + ParameterName: bestOf, ArgumentName: bestOf }, { @@ -330,6 +344,7 @@ When used with `n`, `best_of` controls the number of candidate completions and ` Echo back the prompt in addition to the completion
Default Value: false, + ParameterName: echo, ArgumentName: echo }, { @@ -350,6 +365,7 @@ Number between -2.0 and 2.0. Positive values penalize new tokens based on their [See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)
Default Value: 0, + ParameterName: frequencyPenalty, ArgumentName: frequencyPenalty }, { @@ -371,6 +387,7 @@ Accepts a JSON object that maps tokens (specified by their token ID in the GPT t As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> token from being generated.
Default Value: , + ParameterName: logitBias, ArgumentName: logitBias }, { @@ -390,6 +407,7 @@ Include the log probabilities on the `logprobs` most likely output tokens, as we The maximum value for `logprobs` is 5.
Default Value: , + ParameterName: logprobs, ArgumentName: logprobs }, { @@ -411,6 +429,7 @@ The token count of your prompt plus `max_tokens` cannot exceed the model's conte
Default Value: 16
Example: 16, + ParameterName: maxTokens, ArgumentName: maxTokens }, { @@ -432,6 +451,7 @@ How many completions to generate for each prompt.
Default Value: 1
Example: 1, + ParameterName: n, ArgumentName: n }, { @@ -452,6 +472,7 @@ Number between -2.0 and 2.0. Positive values penalize new tokens based on whethe [See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)
Default Value: 0, + ParameterName: presencePenalty, ArgumentName: presencePenalty }, { @@ -470,6 +491,7 @@ If specified, our system will make a best effort to sample deterministically, su Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. , + ParameterName: seed, ArgumentName: seed }, { @@ -488,6 +510,7 @@ Determinism is not guaranteed, and you should refer to the `system_fingerprint` Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.
Default Value: , + ParameterName: stop, ArgumentName: stop }, { @@ -506,6 +529,7 @@ Up to 4 sequences where the API will stop generating further tokens. The returne Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
Default Value: false, + ParameterName: stream, ArgumentName: stream }, { @@ -525,6 +549,7 @@ Whether to stream back partial progress. If set, tokens will be sent as data-onl Options for streaming response. Only set this when you set `stream: true`.
Default Value: , + ParameterName: streamOptions, ArgumentName: streamOptions }, { @@ -545,6 +570,7 @@ This parameter is only supported for `gpt-3.5-turbo-instruct`.
Default Value:
Example: test., + ParameterName: suffix, ArgumentName: suffix }, { @@ -566,6 +592,7 @@ We generally recommend altering this or `top_p` but not both.
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -587,6 +614,7 @@ We generally recommend altering this or `temperature` but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -604,6 +632,7 @@ We generally recommend altering this or `temperature` but not both. A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
Example: user-1234, + ParameterName: user, ArgumentName: user } ], @@ -659,6 +688,7 @@ As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> }, IsRequired: false, Summary: , + ParameterName: gpt35TurboInstruct, ArgumentName: gpt35TurboInstruct }, { @@ -673,6 +703,7 @@ As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> }, IsRequired: false, Summary: , + ParameterName: davinci002, ArgumentName: davinci002 }, { @@ -687,6 +718,7 @@ As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> }, IsRequired: false, Summary: , + ParameterName: babbage002, ArgumentName: babbage002 } ], @@ -718,6 +750,7 @@ As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> }, IsRequired: true, Summary: A unique identifier for the completion., + ParameterName: id, ArgumentName: id }, { @@ -732,6 +765,7 @@ As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> }, IsRequired: true, Summary: The list of completion choices the model generated for the input prompt., + ParameterName: choices, ArgumentName: choices }, { @@ -746,6 +780,7 @@ As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> }, IsRequired: true, Summary: The Unix timestamp (in seconds) of when the completion was created., + ParameterName: created, ArgumentName: created }, { @@ -760,6 +795,7 @@ As an example, you can pass `{"50256": -100}` to prevent the <|endoftext|> }, IsRequired: true, Summary: The model used for completion., + ParameterName: model, ArgumentName: model }, { @@ -778,6 +814,7 @@ This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. , + ParameterName: systemFingerprint, ArgumentName: systemFingerprint }, { @@ -796,6 +833,7 @@ Can be used in conjunction with the `seed` request parameter to understand when }, IsRequired: true, Summary: The object type, which is always "text_completion", + ParameterName: object, ArgumentName: object }, { @@ -814,6 +852,7 @@ Can be used in conjunction with the `seed` request parameter to understand when }, IsRequired: false, Summary: Usage statistics for the completion request., + ParameterName: usage, ArgumentName: usage } ], @@ -859,6 +898,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model `length` if the maximum number of tokens specified in the request was reached, or `content_filter` if content was omitted due to a flag from our content filters. , + ParameterName: finishReason, ArgumentName: finishReason }, { @@ -873,6 +913,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: true, Summary: , + ParameterName: index, ArgumentName: index }, { @@ -887,6 +928,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: true, Summary: , + ParameterName: logprobs, ArgumentName: logprobs }, { @@ -901,6 +943,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: true, Summary: , + ParameterName: text, ArgumentName: text } ], @@ -932,6 +975,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: false, Summary: , + ParameterName: textOffset, ArgumentName: textOffset }, { @@ -946,6 +990,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: false, Summary: , + ParameterName: tokenLogprobs, ArgumentName: tokenLogprobs }, { @@ -960,6 +1005,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: false, Summary: , + ParameterName: tokens, ArgumentName: tokens }, { @@ -974,6 +1020,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: false, Summary: , + ParameterName: topLogprobs, ArgumentName: topLogprobs } ], @@ -1022,6 +1069,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: false, Summary: , + ParameterName: stop, ArgumentName: stop }, { @@ -1036,6 +1084,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: false, Summary: , + ParameterName: length, ArgumentName: length }, { @@ -1050,6 +1099,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: false, Summary: , + ParameterName: contentFilter, ArgumentName: contentFilter } ], @@ -1086,6 +1136,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: false, Summary: , + ParameterName: textCompletion, ArgumentName: textCompletion } ], @@ -1137,6 +1188,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: true, Summary: The type of the content part., + ParameterName: type, ArgumentName: type }, { @@ -1151,6 +1203,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: true, Summary: , + ParameterName: imageUrl, ArgumentName: imageUrl } ], @@ -1182,6 +1235,7 @@ or `content_filter` if content was omitted due to a flag from our content filter }, IsRequired: true, Summary: Either a URL of the image or the base64 encoded image data., + ParameterName: url, ArgumentName: url }, { @@ -1207,6 +1261,7 @@ or `content_filter` if content was omitted due to a flag from our content filter Summary: Specifies the detail level of the image. Learn more in the [Vision guide](/docs/guides/vision/low-or-high-fidelity-image-understanding).
Default Value: auto, + ParameterName: detail, ArgumentName: detail } ], @@ -1239,6 +1294,7 @@ Specifies the detail level of the image. Learn more in the [Vision guide](/docs/ }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto }, { @@ -1253,6 +1309,7 @@ Specifies the detail level of the image. Learn more in the [Vision guide](/docs/ }, IsRequired: false, Summary: , + ParameterName: low, ArgumentName: low }, { @@ -1267,6 +1324,7 @@ Specifies the detail level of the image. Learn more in the [Vision guide](/docs/ }, IsRequired: false, Summary: , + ParameterName: high, ArgumentName: high } ], @@ -1301,6 +1359,7 @@ Specifies the detail level of the image. Learn more in the [Vision guide](/docs/ }, IsRequired: false, Summary: , + ParameterName: imageUrl, ArgumentName: imageUrl } ], @@ -1336,6 +1395,7 @@ Specifies the detail level of the image. Learn more in the [Vision guide](/docs/ }, IsRequired: true, Summary: The type of the content part., + ParameterName: type, ArgumentName: type }, { @@ -1350,6 +1410,7 @@ Specifies the detail level of the image. Learn more in the [Vision guide](/docs/ }, IsRequired: true, Summary: The text content., + ParameterName: text, ArgumentName: text } ], @@ -1382,6 +1443,7 @@ Specifies the detail level of the image. Learn more in the [Vision guide](/docs/ }, IsRequired: false, Summary: , + ParameterName: text, ArgumentName: text } ], @@ -1429,6 +1491,7 @@ Specifies the detail level of the image. Learn more in the [Vision guide](/docs/ }, IsRequired: true, Summary: The contents of the system message., + ParameterName: content, ArgumentName: content }, { @@ -1447,6 +1510,7 @@ Specifies the detail level of the image. Learn more in the [Vision guide](/docs/ }, IsRequired: true, Summary: The role of the messages author, in this case `system`., + ParameterName: role, ArgumentName: role }, { @@ -1461,6 +1525,7 @@ Specifies the detail level of the image. Learn more in the [Vision guide](/docs/ }, IsRequired: false, Summary: An optional name for the participant. Provides the model information to differentiate between participants of the same role., + ParameterName: name, ArgumentName: name } ], @@ -1493,6 +1558,7 @@ Specifies the detail level of the image. Learn more in the [Vision guide](/docs/ }, IsRequired: false, Summary: , + ParameterName: system, ArgumentName: system } ], @@ -1526,6 +1592,7 @@ Specifies the detail level of the image. Learn more in the [Vision guide](/docs/ Summary: The contents of the user message. , + ParameterName: content, ArgumentName: content }, { @@ -1544,6 +1611,7 @@ The contents of the user message. }, IsRequired: true, Summary: The role of the messages author, in this case `user`., + ParameterName: role, ArgumentName: role }, { @@ -1558,6 +1626,7 @@ The contents of the user message. }, IsRequired: false, Summary: An optional name for the participant. Provides the model information to differentiate between participants of the same role., + ParameterName: name, ArgumentName: name } ], @@ -1590,6 +1659,7 @@ The contents of the user message. }, IsRequired: false, Summary: , + ParameterName: user, ArgumentName: user } ], @@ -1623,6 +1693,7 @@ The contents of the user message. Summary: The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified. , + ParameterName: content, ArgumentName: content }, { @@ -1641,6 +1712,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: true, Summary: The role of the messages author, in this case `assistant`., + ParameterName: role, ArgumentName: role }, { @@ -1655,6 +1727,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: false, Summary: An optional name for the participant. Provides the model information to differentiate between participants of the same role., + ParameterName: name, ArgumentName: name }, { @@ -1669,6 +1742,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: false, Summary: The tool calls generated by the model, such as function calls., + ParameterName: toolCalls, ArgumentName: toolCalls }, { @@ -1683,6 +1757,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: false, Summary: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model., + ParameterName: functionCall, ArgumentName: functionCall } ], @@ -1714,6 +1789,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: true, Summary: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function., + ParameterName: arguments, ArgumentName: arguments }, { @@ -1728,6 +1804,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: true, Summary: The name of the function to call., + ParameterName: name, ArgumentName: name } ], @@ -1760,6 +1837,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: false, Summary: , + ParameterName: assistant, ArgumentName: assistant } ], @@ -1795,6 +1873,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: true, Summary: The role of the messages author, in this case `tool`., + ParameterName: role, ArgumentName: role }, { @@ -1809,6 +1888,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: true, Summary: The contents of the tool message., + ParameterName: content, ArgumentName: content }, { @@ -1823,6 +1903,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: true, Summary: Tool call that this message is responding to., + ParameterName: toolCallId, ArgumentName: toolCallId } ], @@ -1855,6 +1936,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: false, Summary: , + ParameterName: tool, ArgumentName: tool } ], @@ -1890,6 +1972,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: true, Summary: The role of the messages author, in this case `function`., + ParameterName: role, ArgumentName: role }, { @@ -1904,6 +1987,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: true, Summary: The contents of the function message., + ParameterName: content, ArgumentName: content }, { @@ -1918,6 +2002,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: true, Summary: The name of the function to call., + ParameterName: name, ArgumentName: name } ], @@ -1950,6 +2035,7 @@ The contents of the assistant message. Required unless `tool_calls` or `function }, IsRequired: false, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -2000,6 +2086,7 @@ Omitting `parameters` defines a function with an empty parameter list., }, IsRequired: false, Summary: A description of what the function does, used by the model to choose when and how to call the function., + ParameterName: description, ArgumentName: description }, { @@ -2014,6 +2101,7 @@ Omitting `parameters` defines a function with an empty parameter list., }, IsRequired: true, Summary: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64., + ParameterName: name, ArgumentName: name }, { @@ -2031,6 +2119,7 @@ Omitting `parameters` defines a function with an empty parameter list., The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list., + ParameterName: parameters, ArgumentName: parameters } ], @@ -2062,6 +2151,7 @@ Omitting `parameters` defines a function with an empty parameter list., }, IsRequired: true, Summary: The name of the function to call., + ParameterName: name, ArgumentName: name } ], @@ -2099,6 +2189,7 @@ Specifying a particular function via `{"name": "my_function"}` forces the model }, IsRequired: true, Summary: The type of the tool. Currently, only `function` is supported., + ParameterName: type, ArgumentName: type }, { @@ -2117,6 +2208,7 @@ Specifying a particular function via `{"name": "my_function"}` forces the model }, IsRequired: true, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -2149,6 +2241,7 @@ Specifying a particular function via `{"name": "my_function"}` forces the model }, IsRequired: false, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -2180,6 +2273,7 @@ Specifying a particular function via `{"name": "my_function"}` forces the model }, IsRequired: false, Summary: A description of what the function does, used by the model to choose when and how to call the function., + ParameterName: description, ArgumentName: description }, { @@ -2194,6 +2288,7 @@ Specifying a particular function via `{"name": "my_function"}` forces the model }, IsRequired: true, Summary: The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64., + ParameterName: name, ArgumentName: name }, { @@ -2211,6 +2306,7 @@ Specifying a particular function via `{"name": "my_function"}` forces the model The parameters the functions accepts, described as a JSON Schema object. See the [guide](/docs/guides/text-generation/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list., + ParameterName: parameters, ArgumentName: parameters } ], @@ -2270,6 +2366,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: true, Summary: The type of the tool. Currently, only `function` is supported., + ParameterName: type, ArgumentName: type }, { @@ -2284,6 +2381,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: true, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -2315,6 +2413,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: true, Summary: The name of the function to call., + ParameterName: name, ArgumentName: name } ], @@ -2347,6 +2446,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: false, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -2394,6 +2494,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: true, Summary: The ID of the tool call., + ParameterName: id, ArgumentName: id }, { @@ -2412,6 +2513,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: true, Summary: The type of the tool. Currently, only `function` is supported., + ParameterName: type, ArgumentName: type }, { @@ -2426,6 +2528,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: true, Summary: The function that the model called., + ParameterName: function, ArgumentName: function } ], @@ -2457,6 +2560,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: true, Summary: The name of the function to call., + ParameterName: name, ArgumentName: name }, { @@ -2471,6 +2575,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: true, Summary: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function., + ParameterName: arguments, ArgumentName: arguments } ], @@ -2503,6 +2608,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: false, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -2534,6 +2640,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: true, Summary: , + ParameterName: index, ArgumentName: index }, { @@ -2548,6 +2655,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: false, Summary: The ID of the tool call., + ParameterName: id, ArgumentName: id }, { @@ -2566,6 +2674,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: false, Summary: The type of the tool. Currently, only `function` is supported., + ParameterName: type, ArgumentName: type }, { @@ -2580,6 +2689,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: false, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -2611,6 +2721,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: false, Summary: The name of the function to call., + ParameterName: name, ArgumentName: name }, { @@ -2625,6 +2736,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: false, Summary: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function., + ParameterName: arguments, ArgumentName: arguments } ], @@ -2657,6 +2769,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ }, IsRequired: false, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -2706,6 +2819,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ Summary: If set, an additional chunk will be streamed before the `data: [DONE]` message. The `usage` field on this chunk shows the token usage statistics for the entire request, and the `choices` field will always be an empty array. All other chunks will also include a `usage` field, but with a null value. , + ParameterName: includeUsage, ArgumentName: includeUsage } ], @@ -2740,6 +2854,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: true, Summary: The contents of the message., + ParameterName: content, ArgumentName: content }, { @@ -2754,6 +2869,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: The tool calls generated by the model, such as function calls., + ParameterName: toolCalls, ArgumentName: toolCalls }, { @@ -2772,6 +2888,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: true, Summary: The role of the author of this message., + ParameterName: role, ArgumentName: role }, { @@ -2786,6 +2903,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model., + ParameterName: functionCall, ArgumentName: functionCall } ], @@ -2817,6 +2935,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: true, Summary: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function., + ParameterName: arguments, ArgumentName: arguments }, { @@ -2831,6 +2950,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: true, Summary: The name of the function to call., + ParameterName: name, ArgumentName: name } ], @@ -2863,6 +2983,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: , + ParameterName: assistant, ArgumentName: assistant } ], @@ -2894,6 +3015,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: The contents of the chunk message., + ParameterName: content, ArgumentName: content }, { @@ -2908,6 +3030,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model., + ParameterName: functionCall, ArgumentName: functionCall }, { @@ -2922,6 +3045,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: , + ParameterName: toolCalls, ArgumentName: toolCalls }, { @@ -2946,6 +3070,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: The role of the author of this message., + ParameterName: role, ArgumentName: role } ], @@ -2977,6 +3102,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function., + ParameterName: arguments, ArgumentName: arguments }, { @@ -2991,6 +3117,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: The name of the function to call., + ParameterName: name, ArgumentName: name } ], @@ -3023,6 +3150,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: , + ParameterName: system, ArgumentName: system }, { @@ -3037,6 +3165,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: , + ParameterName: user, ArgumentName: user }, { @@ -3051,6 +3180,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: , + ParameterName: assistant, ArgumentName: assistant }, { @@ -3065,6 +3195,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: false, Summary: , + ParameterName: tool, ArgumentName: tool } ], @@ -3096,6 +3227,7 @@ Options for streaming response. Only set this when you set `stream: true`. }, IsRequired: true, Summary: A list of messages comprising the conversation so far. [Example Python code](https://cookbook.openai.com/examples/how_to_format_inputs_to_chatgpt_models)., + ParameterName: messages, ArgumentName: messages }, { @@ -3112,6 +3244,7 @@ Options for streaming response. Only set this when you set `stream: true`. Summary: ID of the model to use. See the [model endpoint compatibility](/docs/models/model-endpoint-compatibility) table for details on which models work with the Chat API.
Example: gpt-4-turbo, + ParameterName: model, ArgumentName: model }, { @@ -3132,6 +3265,7 @@ Number between -2.0 and 2.0. Positive values penalize new tokens based on their [See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)
Default Value: 0, + ParameterName: frequencyPenalty, ArgumentName: frequencyPenalty }, { @@ -3151,6 +3285,7 @@ Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.
Default Value: , + ParameterName: logitBias, ArgumentName: logitBias }, { @@ -3168,6 +3303,7 @@ Accepts a JSON object that maps tokens (specified by their token ID in the token Summary: Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the `content` of `message`.
Default Value: false, + ParameterName: logprobs, ArgumentName: logprobs }, { @@ -3182,6 +3318,7 @@ Whether to return log probabilities of the output tokens or not. If true, return }, IsRequired: false, Summary: An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used., + ParameterName: topLogprobs, ArgumentName: topLogprobs }, { @@ -3200,6 +3337,7 @@ The maximum number of [tokens](/tokenizer) that can be generated in the chat com The total length of input tokens and generated tokens is limited by the model's context length. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens. , + ParameterName: maxTokens, ArgumentName: maxTokens }, { @@ -3218,6 +3356,7 @@ The total length of input tokens and generated tokens is limited by the model's How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep `n` as `1` to minimize costs.
Default Value: 1
Example: 1, + ParameterName: n, ArgumentName: n }, { @@ -3238,6 +3377,7 @@ Number between -2.0 and 2.0. Positive values penalize new tokens based on whethe [See more information about frequency and presence penalties.](/docs/guides/text-generation/parameter-details)
Default Value: 0, + ParameterName: presencePenalty, ArgumentName: presencePenalty }, { @@ -3258,6 +3398,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. , + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -3276,6 +3417,7 @@ This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result. Determinism is not guaranteed, and you should refer to the `system_fingerprint` response parameter to monitor changes in the backend. , + ParameterName: seed, ArgumentName: seed }, { @@ -3294,6 +3436,7 @@ Determinism is not guaranteed, and you should refer to the `system_fingerprint` Up to 4 sequences where the API will stop generating further tokens.
Default Value: , + ParameterName: stop, ArgumentName: stop }, { @@ -3312,6 +3455,7 @@ Up to 4 sequences where the API will stop generating further tokens. If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message. [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions).
Default Value: false, + ParameterName: stream, ArgumentName: stream }, { @@ -3331,6 +3475,7 @@ If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sen Options for streaming response. Only set this when you set `stream: true`.
Default Value: , + ParameterName: streamOptions, ArgumentName: streamOptions }, { @@ -3352,6 +3497,7 @@ We generally recommend altering this or `top_p` but not both.
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -3373,6 +3519,7 @@ We generally recommend altering this or `temperature` but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -3389,6 +3536,7 @@ We generally recommend altering this or `temperature` but not both. Summary: A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported. , + ParameterName: tools, ArgumentName: tools }, { @@ -3411,6 +3559,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ `none` is the default when no tools are present. `auto` is the default if tools are present. , + ParameterName: toolChoice, ArgumentName: toolChoice }, { @@ -3428,6 +3577,7 @@ Specifying a particular tool via `{"type": "function", "function": {"name": "my_ A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
Example: user-1234, + ParameterName: user, ArgumentName: user }, { @@ -3452,6 +3602,7 @@ Specifying a particular function via `{"name": "my_function"}` forces the model `none` is the default when no functions are present. `auto` is the default if functions are present. , + ParameterName: functionCall, ArgumentName: functionCall }, { @@ -3470,6 +3621,7 @@ Deprecated in favor of `tools`. A list of functions the model may generate JSON inputs for. , + ParameterName: functions, ArgumentName: functions } ], @@ -3532,6 +3684,7 @@ Accepts a JSON object that maps tokens (specified by their token ID in the token Must be one of `text` or `json_object`.
Default Value: text
Example: json_object, + ParameterName: type, ArgumentName: type } ], @@ -3570,6 +3723,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: text, ArgumentName: text }, { @@ -3584,6 +3738,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: jsonObject, ArgumentName: jsonObject } ], @@ -3619,6 +3774,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt4Turbo, ArgumentName: gpt4Turbo }, { @@ -3633,6 +3789,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt4Turbo20240409, ArgumentName: gpt4Turbo20240409 }, { @@ -3647,6 +3804,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt40125Preview, ArgumentName: gpt40125Preview }, { @@ -3661,6 +3819,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt4TurboPreview, ArgumentName: gpt4TurboPreview }, { @@ -3675,6 +3834,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt41106Preview, ArgumentName: gpt41106Preview }, { @@ -3689,6 +3849,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt4VisionPreview, ArgumentName: gpt4VisionPreview }, { @@ -3703,6 +3864,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt4, ArgumentName: gpt4 }, { @@ -3717,6 +3879,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt40314, ArgumentName: gpt40314 }, { @@ -3731,6 +3894,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt40613, ArgumentName: gpt40613 }, { @@ -3745,6 +3909,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt432k, ArgumentName: gpt432k }, { @@ -3759,6 +3924,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt432k0314, ArgumentName: gpt432k0314 }, { @@ -3773,6 +3939,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt432k0613, ArgumentName: gpt432k0613 }, { @@ -3787,6 +3954,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo, ArgumentName: gpt35Turbo }, { @@ -3801,6 +3969,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo16k, ArgumentName: gpt35Turbo16k }, { @@ -3815,6 +3984,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo0301, ArgumentName: gpt35Turbo0301 }, { @@ -3829,6 +3999,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo0613, ArgumentName: gpt35Turbo0613 }, { @@ -3843,6 +4014,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo1106, ArgumentName: gpt35Turbo1106 }, { @@ -3857,6 +4029,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo0125, ArgumentName: gpt35Turbo0125 }, { @@ -3871,6 +4044,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo16k0613, ArgumentName: gpt35Turbo16k0613 } ], @@ -3903,6 +4077,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: none, ArgumentName: none }, { @@ -3917,6 +4092,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto }, { @@ -3931,6 +4107,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: required, ArgumentName: required } ], @@ -3965,6 +4142,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: none, ArgumentName: none }, { @@ -3979,6 +4157,7 @@ Must be one of `text` or `json_object`. }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto } ], @@ -4012,6 +4191,7 @@ Must be one of `text` or `json_object`. }, IsRequired: true, Summary: A unique identifier for the chat completion., + ParameterName: id, ArgumentName: id }, { @@ -4026,6 +4206,7 @@ Must be one of `text` or `json_object`. }, IsRequired: true, Summary: A list of chat completion choices. Can be more than one if `n` is greater than 1., + ParameterName: choices, ArgumentName: choices }, { @@ -4040,6 +4221,7 @@ Must be one of `text` or `json_object`. }, IsRequired: true, Summary: The Unix timestamp (in seconds) of when the chat completion was created., + ParameterName: created, ArgumentName: created }, { @@ -4054,6 +4236,7 @@ Must be one of `text` or `json_object`. }, IsRequired: true, Summary: The model used for the chat completion., + ParameterName: model, ArgumentName: model }, { @@ -4072,6 +4255,7 @@ This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. , + ParameterName: systemFingerprint, ArgumentName: systemFingerprint }, { @@ -4090,6 +4274,7 @@ Can be used in conjunction with the `seed` request parameter to understand when }, IsRequired: true, Summary: The object type, which is always `chat.completion`., + ParameterName: object, ArgumentName: object }, { @@ -4108,6 +4293,7 @@ Can be used in conjunction with the `seed` request parameter to understand when }, IsRequired: false, Summary: Usage statistics for the completion request., + ParameterName: usage, ArgumentName: usage } ], @@ -4156,6 +4342,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. , + ParameterName: finishReason, ArgumentName: finishReason }, { @@ -4170,6 +4357,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: The index of the choice in the list of choices., + ParameterName: index, ArgumentName: index }, { @@ -4189,6 +4377,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: A chat completion message generated by the model., + ParameterName: message, ArgumentName: message }, { @@ -4203,6 +4392,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: Log probability information for the choice., + ParameterName: logprobs, ArgumentName: logprobs } ], @@ -4234,6 +4424,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: A list of message content tokens with log probability information., + ParameterName: content, ArgumentName: content } ], @@ -4266,6 +4457,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: stop, ArgumentName: stop }, { @@ -4280,6 +4472,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: length, ArgumentName: length }, { @@ -4294,6 +4487,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: toolCalls, ArgumentName: toolCalls }, { @@ -4308,6 +4502,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: contentFilter, ArgumentName: contentFilter }, { @@ -4322,6 +4517,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: functionCall, ArgumentName: functionCall } ], @@ -4359,6 +4555,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: chatcompletion, ArgumentName: chatcompletion } ], @@ -4390,6 +4587,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: A unique identifier for the chat completion., + ParameterName: id, ArgumentName: id }, { @@ -4404,6 +4602,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: A list of chat completion choices. Can be more than one if `n` is greater than 1., + ParameterName: choices, ArgumentName: choices }, { @@ -4418,6 +4617,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: The Unix timestamp (in seconds) of when the chat completion was created., + ParameterName: created, ArgumentName: created }, { @@ -4432,6 +4632,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: The model used for the chat completion., + ParameterName: model, ArgumentName: model }, { @@ -4450,6 +4651,7 @@ This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. , + ParameterName: systemFingerprint, ArgumentName: systemFingerprint }, { @@ -4468,6 +4670,7 @@ Can be used in conjunction with the `seed` request parameter to understand when }, IsRequired: true, Summary: The object type, which is always `chat.completion`., + ParameterName: object, ArgumentName: object }, { @@ -4486,6 +4689,7 @@ Can be used in conjunction with the `seed` request parameter to understand when }, IsRequired: false, Summary: Usage statistics for the completion request., + ParameterName: usage, ArgumentName: usage } ], @@ -4529,6 +4733,7 @@ Can be used in conjunction with the `seed` request parameter to understand when Summary: The reason the model stopped generating tokens. This will be `stop` if the model hit a natural stop point or a provided stop sequence, `length` if the maximum number of tokens specified in the request was reached, `content_filter` if content was omitted due to a flag from our content filters, or `function_call` if the model called a function. , + ParameterName: finishReason, ArgumentName: finishReason }, { @@ -4543,6 +4748,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: The index of the choice in the list of choices., + ParameterName: index, ArgumentName: index }, { @@ -4562,6 +4768,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: A chat completion message generated by the model., + ParameterName: message, ArgumentName: message } ], @@ -4594,6 +4801,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: stop, ArgumentName: stop }, { @@ -4608,6 +4816,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: length, ArgumentName: length }, { @@ -4622,6 +4831,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: functionCall, ArgumentName: functionCall }, { @@ -4636,6 +4846,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: contentFilter, ArgumentName: contentFilter } ], @@ -4670,6 +4881,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: chatcompletion, ArgumentName: chatcompletion } ], @@ -4701,6 +4913,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: The token., + ParameterName: token, ArgumentName: token }, { @@ -4715,6 +4928,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely., + ParameterName: logprob, ArgumentName: logprob }, { @@ -4729,6 +4943,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token., + ParameterName: bytes, ArgumentName: bytes }, { @@ -4743,6 +4958,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: List of the most likely tokens and their log probability, at this token position. In rare cases, there may be fewer than the number of requested `top_logprobs` returned., + ParameterName: topLogprobs, ArgumentName: topLogprobs } ], @@ -4774,6 +4990,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: The token., + ParameterName: token, ArgumentName: token }, { @@ -4788,6 +5005,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: The log probability of this token, if it is within the top 20 most likely tokens. Otherwise, the value `-9999.0` is used to signify that the token is very unlikely., + ParameterName: logprob, ArgumentName: logprob }, { @@ -4802,6 +5020,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: A list of integers representing the UTF-8 bytes representation of the token. Useful in instances where characters are represented by multiple tokens and their byte representations must be combined to generate the correct text representation. Can be `null` if there is no bytes representation for the token., + ParameterName: bytes, ArgumentName: bytes } ], @@ -4833,6 +5052,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data }, { @@ -4847,6 +5067,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: , + ParameterName: hasMore, ArgumentName: hasMore }, { @@ -4865,6 +5086,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object } ], @@ -4897,6 +5119,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: list, ArgumentName: list } ], @@ -4928,6 +5151,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: A unique identifier for the chat completion. Each chunk has the same ID., + ParameterName: id, ArgumentName: id }, { @@ -4945,6 +5169,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model A list of chat completion choices. Can contain more than one elements if `n` is greater than 1. Can also be empty for the last chunk if you set `stream_options: {"include_usage": true}`. , + ParameterName: choices, ArgumentName: choices }, { @@ -4959,6 +5184,7 @@ last chunk if you set `stream_options: {"include_usage": true}`. }, IsRequired: true, Summary: The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp., + ParameterName: created, ArgumentName: created }, { @@ -4973,6 +5199,7 @@ last chunk if you set `stream_options: {"include_usage": true}`. }, IsRequired: true, Summary: The model to generate the completion., + ParameterName: model, ArgumentName: model }, { @@ -4990,6 +5217,7 @@ last chunk if you set `stream_options: {"include_usage": true}`. This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism. , + ParameterName: systemFingerprint, ArgumentName: systemFingerprint }, { @@ -5008,6 +5236,7 @@ Can be used in conjunction with the `seed` request parameter to understand when }, IsRequired: true, Summary: The object type, which is always `chat.completion.chunk`., + ParameterName: object, ArgumentName: object }, { @@ -5025,6 +5254,7 @@ Can be used in conjunction with the `seed` request parameter to understand when An optional field that will only be present when you set `stream_options: {"include_usage": true}` in your request. When present, it contains a null value except for the last chunk which contains the token usage statistics for the entire request. , + ParameterName: usage, ArgumentName: usage } ], @@ -5056,6 +5286,7 @@ When present, it contains a null value except for the last chunk which contains }, IsRequired: true, Summary: Number of tokens in the generated completion., + ParameterName: completionTokens, ArgumentName: completionTokens }, { @@ -5070,6 +5301,7 @@ When present, it contains a null value except for the last chunk which contains }, IsRequired: true, Summary: Number of tokens in the prompt., + ParameterName: promptTokens, ArgumentName: promptTokens }, { @@ -5084,6 +5316,7 @@ When present, it contains a null value except for the last chunk which contains }, IsRequired: true, Summary: Total number of tokens used in the request (prompt + completion)., + ParameterName: totalTokens, ArgumentName: totalTokens } ], @@ -5123,6 +5356,7 @@ When present, it contains a null value except for the last chunk which contains }, IsRequired: true, Summary: A chat completion delta generated by streamed model responses., + ParameterName: delta, ArgumentName: delta }, { @@ -5137,6 +5371,7 @@ When present, it contains a null value except for the last chunk which contains }, IsRequired: false, Summary: Log probability information for the choice., + ParameterName: logprobs, ArgumentName: logprobs }, { @@ -5168,6 +5403,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model `content_filter` if content was omitted due to a flag from our content filters, `tool_calls` if the model called a tool, or `function_call` (deprecated) if the model called a function. , + ParameterName: finishReason, ArgumentName: finishReason }, { @@ -5182,6 +5418,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: The index of the choice in the list of choices., + ParameterName: index, ArgumentName: index } ], @@ -5213,6 +5450,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: true, Summary: A list of message content tokens with log probability information., + ParameterName: content, ArgumentName: content } ], @@ -5245,6 +5483,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: stop, ArgumentName: stop }, { @@ -5259,6 +5498,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: length, ArgumentName: length }, { @@ -5273,6 +5513,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: toolCalls, ArgumentName: toolCalls }, { @@ -5287,6 +5528,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: contentFilter, ArgumentName: contentFilter }, { @@ -5301,6 +5543,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: functionCall, ArgumentName: functionCall } ], @@ -5338,6 +5581,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model }, IsRequired: false, Summary: , + ParameterName: chatcompletionchunk, ArgumentName: chatcompletionchunk } ], @@ -5387,6 +5631,7 @@ The reason the model stopped generating tokens. This will be `stop` if the model Summary: A text description of the desired image(s). The maximum length is 1000 characters for `dall-e-2` and 4000 characters for `dall-e-3`.
Example: A cute baby sea otter, + ParameterName: prompt, ArgumentName: prompt }, { @@ -5405,6 +5650,7 @@ A text description of the desired image(s). The maximum length is 1000 character The model to use for image generation.
Default Value: dall-e-2
Example: dall-e-3, + ParameterName: model, ArgumentName: model }, { @@ -5423,6 +5669,7 @@ The model to use for image generation. The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.
Default Value: 1
Example: 1, + ParameterName: n, ArgumentName: n }, { @@ -5447,6 +5694,7 @@ The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only The quality of the image that will be generated. `hd` creates images with finer details and greater consistency across the image. This param is only supported for `dall-e-3`.
Default Value: standard
Example: standard, + ParameterName: quality, ArgumentName: quality }, { @@ -5471,6 +5719,7 @@ The quality of the image that will be generated. `hd` creates images with finer The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated.
Default Value: url
Example: url, + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -5501,6 +5750,7 @@ The format in which the generated images are returned. Must be one of `url` or ` The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024` for `dall-e-2`. Must be one of `1024x1024`, `1792x1024`, or `1024x1792` for `dall-e-3` models.
Default Value: 1024x1024
Example: 1024x1024, + ParameterName: size, ArgumentName: size }, { @@ -5525,6 +5775,7 @@ The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x The style of the generated images. Must be one of `vivid` or `natural`. Vivid causes the model to lean towards generating hyper-real and dramatic images. Natural causes the model to produce more natural, less hyper-real looking images. This param is only supported for `dall-e-3`.
Default Value: vivid
Example: vivid, + ParameterName: style, ArgumentName: style }, { @@ -5542,6 +5793,7 @@ The style of the generated images. Must be one of `vivid` or `natural`. Vivid ca A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
Example: user-1234, + ParameterName: user, ArgumentName: user } ], @@ -5574,6 +5826,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor }, IsRequired: false, Summary: , + ParameterName: standard, ArgumentName: standard }, { @@ -5588,6 +5841,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor }, IsRequired: false, Summary: , + ParameterName: hd, ArgumentName: hd } ], @@ -5623,6 +5877,7 @@ The quality of the image that will be generated. `hd` creates images with finer }, IsRequired: false, Summary: , + ParameterName: url, ArgumentName: url }, { @@ -5637,6 +5892,7 @@ The quality of the image that will be generated. `hd` creates images with finer }, IsRequired: false, Summary: , + ParameterName: b64Json, ArgumentName: b64Json } ], @@ -5672,6 +5928,7 @@ The format in which the generated images are returned. Must be one of `url` or ` }, IsRequired: false, Summary: , + ParameterName: _256x256, ArgumentName: _256x256 }, { @@ -5686,6 +5943,7 @@ The format in which the generated images are returned. Must be one of `url` or ` }, IsRequired: false, Summary: , + ParameterName: _512x512, ArgumentName: _512x512 }, { @@ -5700,6 +5958,7 @@ The format in which the generated images are returned. Must be one of `url` or ` }, IsRequired: false, Summary: , + ParameterName: _1024x1024, ArgumentName: _1024x1024 }, { @@ -5714,6 +5973,7 @@ The format in which the generated images are returned. Must be one of `url` or ` }, IsRequired: false, Summary: , + ParameterName: _1792x1024, ArgumentName: _1792x1024 }, { @@ -5728,6 +5988,7 @@ The format in which the generated images are returned. Must be one of `url` or ` }, IsRequired: false, Summary: , + ParameterName: _1024x1792, ArgumentName: _1024x1792 } ], @@ -5763,6 +6024,7 @@ The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x }, IsRequired: false, Summary: , + ParameterName: vivid, ArgumentName: vivid }, { @@ -5777,6 +6039,7 @@ The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x }, IsRequired: false, Summary: , + ParameterName: natural, ArgumentName: natural } ], @@ -5812,6 +6075,7 @@ The style of the generated images. Must be one of `vivid` or `natural`. Vivid ca }, IsRequired: false, Summary: , + ParameterName: dallE2, ArgumentName: dallE2 }, { @@ -5826,6 +6090,7 @@ The style of the generated images. Must be one of `vivid` or `natural`. Vivid ca }, IsRequired: false, Summary: , + ParameterName: dallE3, ArgumentName: dallE3 } ], @@ -5857,6 +6122,7 @@ The style of the generated images. Must be one of `vivid` or `natural`. Vivid ca }, IsRequired: true, Summary: , + ParameterName: created, ArgumentName: created }, { @@ -5871,6 +6137,7 @@ The style of the generated images. Must be one of `vivid` or `natural`. Vivid ca }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data } ], @@ -5902,6 +6169,7 @@ The style of the generated images. Must be one of `vivid` or `natural`. Vivid ca }, IsRequired: false, Summary: The base64-encoded JSON of the generated image, if `response_format` is `b64_json`., + ParameterName: b64Json, ArgumentName: b64Json }, { @@ -5916,6 +6184,7 @@ The style of the generated images. Must be one of `vivid` or `natural`. Vivid ca }, IsRequired: false, Summary: The URL of the generated image, if `response_format` is `url` (default)., + ParameterName: url, ArgumentName: url }, { @@ -5930,6 +6199,7 @@ The style of the generated images. Must be one of `vivid` or `natural`. Vivid ca }, IsRequired: false, Summary: The prompt that was used to generate the image, if there was any revision to the prompt., + ParameterName: revisedPrompt, ArgumentName: revisedPrompt } ], @@ -5961,6 +6231,7 @@ The style of the generated images. Must be one of `vivid` or `natural`. Vivid ca }, IsRequired: true, Summary: The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask., + ParameterName: image, ArgumentName: image }, { @@ -5977,6 +6248,7 @@ The style of the generated images. Must be one of `vivid` or `natural`. Vivid ca Summary: A text description of the desired image(s). The maximum length is 1000 characters.
Example: A cute baby sea otter wearing a beret, + ParameterName: prompt, ArgumentName: prompt }, { @@ -5991,6 +6263,7 @@ A text description of the desired image(s). The maximum length is 1000 character }, IsRequired: false, Summary: An additional image whose fully transparent areas (e.g. where alpha is zero) indicate where `image` should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions as `image`., + ParameterName: mask, ArgumentName: mask }, { @@ -6009,6 +6282,7 @@ A text description of the desired image(s). The maximum length is 1000 character The model to use for image generation. Only `dall-e-2` is supported at this time.
Default Value: dall-e-2
Example: dall-e-2, + ParameterName: model, ArgumentName: model }, { @@ -6027,6 +6301,7 @@ The model to use for image generation. Only `dall-e-2` is supported at this time The number of images to generate. Must be between 1 and 10.
Default Value: 1
Example: 1, + ParameterName: n, ArgumentName: n }, { @@ -6053,6 +6328,7 @@ The number of images to generate. Must be between 1 and 10. The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.
Default Value: 1024x1024
Example: 1024x1024, + ParameterName: size, ArgumentName: size }, { @@ -6077,6 +6353,7 @@ The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated.
Default Value: url
Example: url, + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -6094,6 +6371,7 @@ The format in which the generated images are returned. Must be one of `url` or ` A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
Example: user-1234, + ParameterName: user, ArgumentName: user } ], @@ -6126,6 +6404,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor }, IsRequired: false, Summary: , + ParameterName: _256x256, ArgumentName: _256x256 }, { @@ -6140,6 +6419,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor }, IsRequired: false, Summary: , + ParameterName: _512x512, ArgumentName: _512x512 }, { @@ -6154,6 +6434,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor }, IsRequired: false, Summary: , + ParameterName: _1024x1024, ArgumentName: _1024x1024 } ], @@ -6189,6 +6470,7 @@ The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x }, IsRequired: false, Summary: , + ParameterName: url, ArgumentName: url }, { @@ -6203,6 +6485,7 @@ The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x }, IsRequired: false, Summary: , + ParameterName: b64Json, ArgumentName: b64Json } ], @@ -6238,6 +6521,7 @@ The format in which the generated images are returned. Must be one of `url` or ` }, IsRequired: false, Summary: , + ParameterName: dallE2, ArgumentName: dallE2 } ], @@ -6269,6 +6553,7 @@ The format in which the generated images are returned. Must be one of `url` or ` }, IsRequired: true, Summary: The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square., + ParameterName: image, ArgumentName: image }, { @@ -6287,6 +6572,7 @@ The format in which the generated images are returned. Must be one of `url` or ` The model to use for image generation. Only `dall-e-2` is supported at this time.
Default Value: dall-e-2
Example: dall-e-2, + ParameterName: model, ArgumentName: model }, { @@ -6305,6 +6591,7 @@ The model to use for image generation. Only `dall-e-2` is supported at this time The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only `n=1` is supported.
Default Value: 1
Example: 1, + ParameterName: n, ArgumentName: n }, { @@ -6329,6 +6616,7 @@ The number of images to generate. Must be between 1 and 10. For `dall-e-3`, only The format in which the generated images are returned. Must be one of `url` or `b64_json`. URLs are only valid for 60 minutes after the image has been generated.
Default Value: url
Example: url, + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -6355,6 +6643,7 @@ The format in which the generated images are returned. Must be one of `url` or ` The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x1024`.
Default Value: 1024x1024
Example: 1024x1024, + ParameterName: size, ArgumentName: size }, { @@ -6372,6 +6661,7 @@ The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
Example: user-1234, + ParameterName: user, ArgumentName: user } ], @@ -6404,6 +6694,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor }, IsRequired: false, Summary: , + ParameterName: url, ArgumentName: url }, { @@ -6418,6 +6709,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor }, IsRequired: false, Summary: , + ParameterName: b64Json, ArgumentName: b64Json } ], @@ -6453,6 +6745,7 @@ The format in which the generated images are returned. Must be one of `url` or ` }, IsRequired: false, Summary: , + ParameterName: _256x256, ArgumentName: _256x256 }, { @@ -6467,6 +6760,7 @@ The format in which the generated images are returned. Must be one of `url` or ` }, IsRequired: false, Summary: , + ParameterName: _512x512, ArgumentName: _512x512 }, { @@ -6481,6 +6775,7 @@ The format in which the generated images are returned. Must be one of `url` or ` }, IsRequired: false, Summary: , + ParameterName: _1024x1024, ArgumentName: _1024x1024 } ], @@ -6516,6 +6811,7 @@ The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x }, IsRequired: false, Summary: , + ParameterName: dallE2, ArgumentName: dallE2 } ], @@ -6547,6 +6843,7 @@ The size of the generated images. Must be one of `256x256`, `512x512`, or `1024x }, IsRequired: true, Summary: The input text to classify, + ParameterName: input, ArgumentName: input }, { @@ -6568,6 +6865,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove
Default Value: text-moderation-latest
Example: text-moderation-stable, + ParameterName: model, ArgumentName: model } ], @@ -6600,6 +6898,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: false, Summary: , + ParameterName: textModerationLatest, ArgumentName: textModerationLatest }, { @@ -6614,6 +6913,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: false, Summary: , + ParameterName: textModerationStable, ArgumentName: textModerationStable } ], @@ -6645,6 +6945,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The unique identifier for the moderation request., + ParameterName: id, ArgumentName: id }, { @@ -6659,6 +6960,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The model used to generate the moderation results., + ParameterName: model, ArgumentName: model }, { @@ -6673,6 +6975,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: A list of moderation objects., + ParameterName: results, ArgumentName: results } ], @@ -6704,6 +7007,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: Whether any of the below categories are flagged., + ParameterName: flagged, ArgumentName: flagged }, { @@ -6718,6 +7022,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: A list of the categories, and whether they are flagged or not., + ParameterName: categories, ArgumentName: categories }, { @@ -6732,6 +7037,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: A list of the categories along with their scores as predicted by model., + ParameterName: categoryScores, ArgumentName: categoryScores } ], @@ -6763,6 +7069,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: Content that expresses, incites, or promotes hate based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste. Hateful content aimed at non-protected groups (e.g., chess players) is harassment., + ParameterName: hate, ArgumentName: hate }, { @@ -6777,6 +7084,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: Hateful content that also includes violence or serious harm towards the targeted group based on race, gender, ethnicity, religion, nationality, sexual orientation, disability status, or caste., + ParameterName: hateThreatening, ArgumentName: hateThreatening }, { @@ -6791,6 +7099,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: Content that expresses, incites, or promotes harassing language towards any target., + ParameterName: harassment, ArgumentName: harassment }, { @@ -6805,6 +7114,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: Harassment content that also includes violence or serious harm towards any target., + ParameterName: harassmentThreatening, ArgumentName: harassmentThreatening }, { @@ -6819,6 +7129,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: Content that promotes, encourages, or depicts acts of self-harm, such as suicide, cutting, and eating disorders., + ParameterName: selfHarm, ArgumentName: selfHarm }, { @@ -6833,6 +7144,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: Content where the speaker expresses that they are engaging or intend to engage in acts of self-harm, such as suicide, cutting, and eating disorders., + ParameterName: selfHarmIntent, ArgumentName: selfHarmIntent }, { @@ -6847,6 +7159,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: Content that encourages performing acts of self-harm, such as suicide, cutting, and eating disorders, or that gives instructions or advice on how to commit such acts., + ParameterName: selfHarmInstructions, ArgumentName: selfHarmInstructions }, { @@ -6861,6 +7174,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: Content meant to arouse sexual excitement, such as the description of sexual activity, or that promotes sexual services (excluding sex education and wellness)., + ParameterName: sexual, ArgumentName: sexual }, { @@ -6875,6 +7189,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: Sexual content that includes an individual who is under 18 years old., + ParameterName: sexualMinors, ArgumentName: sexualMinors }, { @@ -6889,6 +7204,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: Content that depicts death, violence, or physical injury., + ParameterName: violence, ArgumentName: violence }, { @@ -6903,6 +7219,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: Content that depicts death, violence, or physical injury in graphic detail., + ParameterName: violenceGraphic, ArgumentName: violenceGraphic } ], @@ -6934,6 +7251,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The score for the category 'hate'., + ParameterName: hate, ArgumentName: hate }, { @@ -6948,6 +7266,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The score for the category 'hate/threatening'., + ParameterName: hateThreatening, ArgumentName: hateThreatening }, { @@ -6962,6 +7281,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The score for the category 'harassment'., + ParameterName: harassment, ArgumentName: harassment }, { @@ -6976,6 +7296,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The score for the category 'harassment/threatening'., + ParameterName: harassmentThreatening, ArgumentName: harassmentThreatening }, { @@ -6990,6 +7311,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The score for the category 'self-harm'., + ParameterName: selfHarm, ArgumentName: selfHarm }, { @@ -7004,6 +7326,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The score for the category 'self-harm/intent'., + ParameterName: selfHarmIntent, ArgumentName: selfHarmIntent }, { @@ -7018,6 +7341,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The score for the category 'self-harm/instructions'., + ParameterName: selfHarmInstructions, ArgumentName: selfHarmInstructions }, { @@ -7032,6 +7356,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The score for the category 'sexual'., + ParameterName: sexual, ArgumentName: sexual }, { @@ -7046,6 +7371,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The score for the category 'sexual/minors'., + ParameterName: sexualMinors, ArgumentName: sexualMinors }, { @@ -7060,6 +7386,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The score for the category 'violence'., + ParameterName: violence, ArgumentName: violence }, { @@ -7074,6 +7401,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: The score for the category 'violence/graphic'., + ParameterName: violenceGraphic, ArgumentName: violenceGraphic } ], @@ -7105,6 +7433,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data }, { @@ -7123,6 +7452,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object } ], @@ -7155,6 +7485,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove }, IsRequired: false, Summary: , + ParameterName: list, ArgumentName: list } ], @@ -7188,6 +7519,7 @@ The default is `text-moderation-latest` which will be automatically upgraded ove Summary: The File object (not file name) to be uploaded. , + ParameterName: file, ArgumentName: file }, { @@ -7214,6 +7546,7 @@ The intended purpose of the uploaded file. Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Message](/docs/api-reference/messages) files, "vision" for Assistants image file inputs, "batch" for [Batch API](/docs/guides/batch), and "fine-tune" for [Fine-tuning](/docs/api-reference/fine-tuning). , + ParameterName: purpose, ArgumentName: purpose } ], @@ -7246,6 +7579,7 @@ Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Message]( }, IsRequired: false, Summary: , + ParameterName: assistants, ArgumentName: assistants }, { @@ -7260,6 +7594,7 @@ Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Message]( }, IsRequired: false, Summary: , + ParameterName: batch, ArgumentName: batch }, { @@ -7274,6 +7609,7 @@ Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Message]( }, IsRequired: false, Summary: , + ParameterName: fineTune, ArgumentName: fineTune } ], @@ -7309,6 +7645,7 @@ Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Message]( }, IsRequired: true, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -7327,6 +7664,7 @@ Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Message]( }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object }, { @@ -7341,6 +7679,7 @@ Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Message]( }, IsRequired: true, Summary: , + ParameterName: deleted, ArgumentName: deleted } ], @@ -7373,6 +7712,7 @@ Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Message]( }, IsRequired: false, Summary: , + ParameterName: file, ArgumentName: file } ], @@ -7408,6 +7748,7 @@ The name of the model to fine-tune. You can select one of the [supported models](/docs/guides/fine-tuning/what-models-can-be-fine-tuned).
Example: gpt-3.5-turbo, + ParameterName: model, ArgumentName: model }, { @@ -7431,6 +7772,7 @@ Your dataset must be formatted as a JSONL file. Additionally, you must upload yo See the [fine-tuning guide](/docs/guides/fine-tuning) for more details.
Example: file-abc123, + ParameterName: trainingFile, ArgumentName: trainingFile }, { @@ -7445,6 +7787,7 @@ See the [fine-tuning guide](/docs/guides/fine-tuning) for more details. }, IsRequired: false, Summary: The hyperparameters used for the fine-tuning job., + ParameterName: hyperparameters, ArgumentName: hyperparameters }, { @@ -7464,6 +7807,7 @@ A string of up to 18 characters that will be added to your fine-tuned model name For example, a `suffix` of "custom-model-name" would produce a model name like `ft:gpt-3.5-turbo:openai:custom-model-name:7p4lURel`.
Default Value: , + ParameterName: suffix, ArgumentName: suffix }, { @@ -7490,6 +7834,7 @@ Your dataset must be formatted as a JSONL file. You must upload your file with t See the [fine-tuning guide](/docs/guides/fine-tuning) for more details.
Example: file-abc123, + ParameterName: validationFile, ArgumentName: validationFile }, { @@ -7504,6 +7849,7 @@ See the [fine-tuning guide](/docs/guides/fine-tuning) for more details. }, IsRequired: false, Summary: A list of integrations to enable for your fine-tuning job., + ParameterName: integrations, ArgumentName: integrations }, { @@ -7522,6 +7868,7 @@ The seed controls the reproducibility of the job. Passing in the same seed and j If a seed is not specified, one will be generated for you.
Example: 42, + ParameterName: seed, ArgumentName: seed } ], @@ -7558,6 +7905,7 @@ Number of examples in each batch. A larger batch size means that model parameter are updated less frequently, but with lower variance.
Default Value: auto, + ParameterName: batchSize, ArgumentName: batchSize }, { @@ -7577,6 +7925,7 @@ Scaling factor for the learning rate. A smaller learning rate may be useful to a overfitting.
Default Value: auto, + ParameterName: learningRateMultiplier, ArgumentName: learningRateMultiplier }, { @@ -7596,6 +7945,7 @@ The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.
Default Value: auto, + ParameterName: nEpochs, ArgumentName: nEpochs } ], @@ -7628,6 +7978,7 @@ through the training dataset. }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto } ], @@ -7660,6 +8011,7 @@ through the training dataset. }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto } ], @@ -7692,6 +8044,7 @@ through the training dataset. }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto } ], @@ -7725,6 +8078,7 @@ through the training dataset. Summary: The type of integration to enable. Currently, only "wandb" (Weights and Biases) is supported. , + ParameterName: type, ArgumentName: type }, { @@ -7743,6 +8097,7 @@ The settings for your integration with Weights and Biases. This payload specifie metrics will be sent to. Optionally, you can set an explicit display name for your run, add tags to your run, and set a default entity (team, username, etc) to be associated with your run. , + ParameterName: wandb, ArgumentName: wandb } ], @@ -7777,6 +8132,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit The name of the project that the new run will be created under.
Example: my-wandb-project, + ParameterName: project, ArgumentName: project }, { @@ -7793,6 +8149,7 @@ The name of the project that the new run will be created under. Summary: A display name to set for the run. If not set, we will use the Job ID as the name. , + ParameterName: name, ArgumentName: name }, { @@ -7810,6 +8167,7 @@ A display name to set for the run. If not set, we will use the Job ID as the nam The entity to use for the run. This allows you to set the team or username of the WandB user that you would like associated with the run. If not set, the default entity for the registered WandB API key is used. , + ParameterName: entity, ArgumentName: entity }, { @@ -7827,6 +8185,7 @@ like associated with the run. If not set, the default entity for the registered A list of tags to be attached to the newly created run. These tags are passed through directly to WandB. Some default tags are generated by OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}". , + ParameterName: tags, ArgumentName: tags } ], @@ -7863,6 +8222,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: wandb, ArgumentName: wandb } ], @@ -7895,6 +8255,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: babbage002, ArgumentName: babbage002 }, { @@ -7909,6 +8270,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: davinci002, ArgumentName: davinci002 }, { @@ -7923,6 +8285,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo, ArgumentName: gpt35Turbo } ], @@ -7954,6 +8317,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data }, { @@ -7972,6 +8336,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object } ], @@ -8004,6 +8369,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: list, ArgumentName: list } ], @@ -8035,6 +8401,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data }, { @@ -8053,6 +8420,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object }, { @@ -8067,6 +8435,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: firstId, ArgumentName: firstId }, { @@ -8081,6 +8450,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: lastId, ArgumentName: lastId }, { @@ -8095,6 +8465,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: , + ParameterName: hasMore, ArgumentName: hasMore } ], @@ -8127,6 +8498,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: list, ArgumentName: list } ], @@ -8161,6 +8533,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for `text-embedding-ada-002`), cannot be an empty string, and any array must be 2048 dimensions or less. [Example Python code](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) for counting tokens.
Example: The quick brown fox jumped over the lazy dog, + ParameterName: input, ArgumentName: input }, { @@ -8178,6 +8551,7 @@ Input text to embed, encoded as a string or array of tokens. To embed multiple i ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.
Example: text-embedding-3-small, + ParameterName: model, ArgumentName: model }, { @@ -8202,6 +8576,7 @@ ID of the model to use. You can use the [List models](/docs/api-reference/models The format to return the embeddings in. Can be either `float` or [`base64`](https://pypi.org/project/pybase64/).
Default Value: float
Example: float, + ParameterName: encodingFormat, ArgumentName: encodingFormat }, { @@ -8218,6 +8593,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http Summary: The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. , + ParameterName: dimensions, ArgumentName: dimensions }, { @@ -8235,6 +8611,7 @@ The number of dimensions the resulting output embeddings should have. Only suppo A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).
Example: user-1234, + ParameterName: user, ArgumentName: user } ], @@ -8267,6 +8644,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor }, IsRequired: false, Summary: , + ParameterName: float, ArgumentName: float }, { @@ -8281,6 +8659,7 @@ A unique identifier representing your end-user, which can help OpenAI to monitor }, IsRequired: false, Summary: , + ParameterName: base64, ArgumentName: base64 } ], @@ -8316,6 +8695,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http }, IsRequired: false, Summary: , + ParameterName: textEmbeddingAda002, ArgumentName: textEmbeddingAda002 }, { @@ -8330,6 +8710,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http }, IsRequired: false, Summary: , + ParameterName: textEmbedding3Small, ArgumentName: textEmbedding3Small }, { @@ -8344,6 +8725,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http }, IsRequired: false, Summary: , + ParameterName: textEmbedding3Large, ArgumentName: textEmbedding3Large } ], @@ -8375,6 +8757,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http }, IsRequired: true, Summary: The list of embeddings generated by the model., + ParameterName: data, ArgumentName: data }, { @@ -8389,6 +8772,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http }, IsRequired: true, Summary: The name of the model used to generate the embedding., + ParameterName: model, ArgumentName: model }, { @@ -8407,6 +8791,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http }, IsRequired: true, Summary: The object type, which is always "list"., + ParameterName: object, ArgumentName: object }, { @@ -8421,6 +8806,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http }, IsRequired: true, Summary: The usage information for the request., + ParameterName: usage, ArgumentName: usage } ], @@ -8452,6 +8838,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http }, IsRequired: true, Summary: The number of tokens used by the prompt., + ParameterName: promptTokens, ArgumentName: promptTokens }, { @@ -8466,6 +8853,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http }, IsRequired: true, Summary: The total number of tokens used by the request., + ParameterName: totalTokens, ArgumentName: totalTokens } ], @@ -8498,6 +8886,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http }, IsRequired: false, Summary: , + ParameterName: list, ArgumentName: list } ], @@ -8531,6 +8920,7 @@ The format to return the embeddings in. Can be either `float` or [`base64`](http Summary: The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. , + ParameterName: file, ArgumentName: file }, { @@ -8548,6 +8938,7 @@ The audio file object (not file name) to transcribe, in one of these formats: fl ID of the model to use. Only `whisper-1` (which is powered by our open source Whisper V2 model) is currently available.
Example: whisper-1, + ParameterName: model, ArgumentName: model }, { @@ -8564,6 +8955,7 @@ ID of the model to use. Only `whisper-1` (which is powered by our open source Wh Summary: The language of the input audio. Supplying the input language in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format will improve accuracy and latency. , + ParameterName: language, ArgumentName: language }, { @@ -8580,6 +8972,7 @@ The language of the input audio. Supplying the input language in [ISO-639-1](htt Summary: An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should match the audio language. , + ParameterName: prompt, ArgumentName: prompt }, { @@ -8610,6 +9003,7 @@ An optional text to guide the model's style or continue a previous audio segment The format of the transcript output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`.
Default Value: json, + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -8628,6 +9022,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.
Default Value: 0, + ParameterName: temperature, ArgumentName: temperature } ], @@ -8660,6 +9055,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the }, IsRequired: false, Summary: , + ParameterName: json, ArgumentName: json }, { @@ -8674,6 +9070,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the }, IsRequired: false, Summary: , + ParameterName: text, ArgumentName: text }, { @@ -8688,6 +9085,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the }, IsRequired: false, Summary: , + ParameterName: srt, ArgumentName: srt }, { @@ -8702,6 +9100,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the }, IsRequired: false, Summary: , + ParameterName: verboseJson, ArgumentName: verboseJson }, { @@ -8716,6 +9115,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the }, IsRequired: false, Summary: , + ParameterName: vtt, ArgumentName: vtt } ], @@ -8751,6 +9151,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: false, Summary: , + ParameterName: whisper1, ArgumentName: whisper1 } ], @@ -8782,6 +9183,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: The transcribed text., + ParameterName: text, ArgumentName: text } ], @@ -8813,6 +9215,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: Unique identifier of the segment., + ParameterName: id, ArgumentName: id }, { @@ -8827,6 +9230,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: Seek offset of the segment., + ParameterName: seek, ArgumentName: seek }, { @@ -8841,6 +9245,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: Start time of the segment in seconds., + ParameterName: start, ArgumentName: start }, { @@ -8855,6 +9260,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: End time of the segment in seconds., + ParameterName: end, ArgumentName: end }, { @@ -8869,6 +9275,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: Text content of the segment., + ParameterName: text, ArgumentName: text }, { @@ -8883,6 +9290,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: Array of token IDs for the text content., + ParameterName: tokens, ArgumentName: tokens }, { @@ -8897,6 +9305,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: Temperature parameter used for generating the segment., + ParameterName: temperature, ArgumentName: temperature }, { @@ -8911,6 +9320,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: Average logprob of the segment. If the value is lower than -1, consider the logprobs failed., + ParameterName: avgLogprob, ArgumentName: avgLogprob }, { @@ -8925,6 +9335,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: Compression ratio of the segment. If the value is greater than 2.4, consider the compression failed., + ParameterName: compressionRatio, ArgumentName: compressionRatio }, { @@ -8939,6 +9350,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: Probability of no speech in the segment. If the value is higher than 1.0 and the `avg_logprob` is below -1, consider this segment silent., + ParameterName: noSpeechProb, ArgumentName: noSpeechProb } ], @@ -8970,6 +9382,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: The text content of the word., + ParameterName: word, ArgumentName: word }, { @@ -8984,6 +9397,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: Start time of the word in seconds., + ParameterName: start, ArgumentName: start }, { @@ -8998,6 +9412,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: End time of the word in seconds., + ParameterName: end, ArgumentName: end } ], @@ -9029,6 +9444,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: The language of the input audio., + ParameterName: language, ArgumentName: language }, { @@ -9043,6 +9459,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: The duration of the input audio., + ParameterName: duration, ArgumentName: duration }, { @@ -9057,6 +9474,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: true, Summary: The transcribed text., + ParameterName: text, ArgumentName: text }, { @@ -9071,6 +9489,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: false, Summary: Extracted words and their corresponding timestamps., + ParameterName: words, ArgumentName: words }, { @@ -9085,6 +9504,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s }, IsRequired: false, Summary: Segments of the transcribed text and their corresponding details., + ParameterName: segments, ArgumentName: segments } ], @@ -9118,6 +9538,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s Summary: The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. , + ParameterName: file, ArgumentName: file }, { @@ -9135,6 +9556,7 @@ The audio file object (not file name) translate, in one of these formats: flac, ID of the model to use. Only `whisper-1` (which is powered by our open source Whisper V2 model) is currently available.
Example: whisper-1, + ParameterName: model, ArgumentName: model }, { @@ -9151,6 +9573,7 @@ ID of the model to use. Only `whisper-1` (which is powered by our open source Wh Summary: An optional text to guide the model's style or continue a previous audio segment. The [prompt](/docs/guides/speech-to-text/prompting) should be in English. , + ParameterName: prompt, ArgumentName: prompt }, { @@ -9169,6 +9592,7 @@ An optional text to guide the model's style or continue a previous audio segment The format of the transcript output, in one of these options: `json`, `text`, `srt`, `verbose_json`, or `vtt`.
Default Value: json, + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -9187,6 +9611,7 @@ The format of the transcript output, in one of these options: `json`, `text`, `s The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit.
Default Value: 0, + ParameterName: temperature, ArgumentName: temperature } ], @@ -9219,6 +9644,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the }, IsRequired: false, Summary: , + ParameterName: whisper1, ArgumentName: whisper1 } ], @@ -9250,6 +9676,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the }, IsRequired: true, Summary: , + ParameterName: text, ArgumentName: text } ], @@ -9281,6 +9708,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the }, IsRequired: true, Summary: The language of the output translation (always `english`)., + ParameterName: language, ArgumentName: language }, { @@ -9295,6 +9723,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the }, IsRequired: true, Summary: The duration of the input audio., + ParameterName: duration, ArgumentName: duration }, { @@ -9309,6 +9738,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the }, IsRequired: true, Summary: The translated text., + ParameterName: text, ArgumentName: text }, { @@ -9323,6 +9753,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the }, IsRequired: false, Summary: Segments of the translated text and their corresponding details., + ParameterName: segments, ArgumentName: segments } ], @@ -9356,6 +9787,7 @@ The sampling temperature, between 0 and 1. Higher values like 0.8 will make the Summary: One of the available [TTS models](/docs/models/tts): `tts-1` or `tts-1-hd` , + ParameterName: model, ArgumentName: model }, { @@ -9370,6 +9802,7 @@ One of the available [TTS models](/docs/models/tts): `tts-1` or `tts-1-hd` }, IsRequired: true, Summary: The text to generate audio for. The maximum length is 4096 characters., + ParameterName: input, ArgumentName: input }, { @@ -9398,6 +9831,7 @@ One of the available [TTS models](/docs/models/tts): `tts-1` or `tts-1-hd` }, IsRequired: true, Summary: The voice to use when generating the audio. Supported voices are `alloy`, `echo`, `fable`, `onyx`, `nova`, and `shimmer`. Previews of the voices are available in the [Text to speech guide](/docs/guides/text-to-speech/voice-options)., + ParameterName: voice, ArgumentName: voice }, { @@ -9429,6 +9863,7 @@ One of the available [TTS models](/docs/models/tts): `tts-1` or `tts-1-hd` Summary: The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav`, and `pcm`.
Default Value: mp3, + ParameterName: responseFormat, ArgumentName: responseFormat }, { @@ -9446,6 +9881,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav Summary: The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is the default.
Default Value: 1, + ParameterName: speed, ArgumentName: speed } ], @@ -9478,6 +9914,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is }, IsRequired: false, Summary: , + ParameterName: alloy, ArgumentName: alloy }, { @@ -9492,6 +9929,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is }, IsRequired: false, Summary: , + ParameterName: echo, ArgumentName: echo }, { @@ -9506,6 +9944,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is }, IsRequired: false, Summary: , + ParameterName: fable, ArgumentName: fable }, { @@ -9520,6 +9959,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is }, IsRequired: false, Summary: , + ParameterName: onyx, ArgumentName: onyx }, { @@ -9534,6 +9974,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is }, IsRequired: false, Summary: , + ParameterName: nova, ArgumentName: nova }, { @@ -9548,6 +9989,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is }, IsRequired: false, Summary: , + ParameterName: shimmer, ArgumentName: shimmer } ], @@ -9580,6 +10022,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is }, IsRequired: false, Summary: , + ParameterName: mp3, ArgumentName: mp3 }, { @@ -9594,6 +10037,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is }, IsRequired: false, Summary: , + ParameterName: opus, ArgumentName: opus }, { @@ -9608,6 +10052,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is }, IsRequired: false, Summary: , + ParameterName: aac, ArgumentName: aac }, { @@ -9622,6 +10067,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is }, IsRequired: false, Summary: , + ParameterName: flac, ArgumentName: flac }, { @@ -9636,6 +10082,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is }, IsRequired: false, Summary: , + ParameterName: wav, ArgumentName: wav }, { @@ -9650,6 +10097,7 @@ The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is }, IsRequired: false, Summary: , + ParameterName: pcm, ArgumentName: pcm } ], @@ -9684,6 +10132,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: tts1, ArgumentName: tts1 }, { @@ -9698,6 +10147,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: tts1Hd, ArgumentName: tts1Hd } ], @@ -9729,6 +10179,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: true, Summary: The model identifier, which can be referenced in the API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -9743,6 +10194,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: true, Summary: The Unix timestamp (in seconds) when the model was created., + ParameterName: created, ArgumentName: created }, { @@ -9761,6 +10213,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: true, Summary: The object type, which is always "model"., + ParameterName: object, ArgumentName: object }, { @@ -9775,6 +10228,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: true, Summary: The organization that owns the model., + ParameterName: ownedBy, ArgumentName: ownedBy } ], @@ -9807,6 +10261,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: model, ArgumentName: model } ], @@ -9838,6 +10293,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: true, Summary: The file identifier, which can be referenced in the API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -9852,6 +10308,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: true, Summary: The size of the file, in bytes., + ParameterName: bytes, ArgumentName: bytes }, { @@ -9866,6 +10323,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the file was created., + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -9880,6 +10338,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: true, Summary: The name of the file., + ParameterName: filename, ArgumentName: filename }, { @@ -9898,6 +10357,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: true, Summary: The object type, which is always `file`., + ParameterName: object, ArgumentName: object }, { @@ -9928,6 +10388,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: true, Summary: The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results` and `vision`., + ParameterName: purpose, ArgumentName: purpose }, { @@ -9950,6 +10411,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: true, Summary: Deprecated. The current status of the file, which can be either `uploaded`, `processed`, or `error`., + ParameterName: status, ArgumentName: status }, { @@ -9964,6 +10426,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: Deprecated. For details on why a fine-tuning training file failed validation, see the `error` field on `fine_tuning.job`., + ParameterName: statusDetails, ArgumentName: statusDetails } ], @@ -9996,6 +10459,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: file, ArgumentName: file } ], @@ -10028,6 +10492,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: assistants, ArgumentName: assistants }, { @@ -10042,6 +10507,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: assistantsOutput, ArgumentName: assistantsOutput }, { @@ -10056,6 +10522,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: batch, ArgumentName: batch }, { @@ -10070,6 +10537,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: batchOutput, ArgumentName: batchOutput }, { @@ -10084,6 +10552,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: fineTune, ArgumentName: fineTune }, { @@ -10098,6 +10567,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: fineTuneResults, ArgumentName: fineTuneResults }, { @@ -10112,6 +10582,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: vision, ArgumentName: vision } ], @@ -10144,6 +10615,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: uploaded, ArgumentName: uploaded }, { @@ -10158,6 +10630,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: processed, ArgumentName: processed }, { @@ -10172,6 +10645,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: false, Summary: , + ParameterName: error, ArgumentName: error } ], @@ -10203,6 +10677,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav }, IsRequired: true, Summary: The index of the embedding in the list of embeddings., + ParameterName: index, ArgumentName: index }, { @@ -10219,6 +10694,7 @@ The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav Summary: The embedding vector, which is a list of floats. The length of vector depends on the model as listed in the [embedding guide](/docs/guides/embeddings). , + ParameterName: embedding1, ArgumentName: embedding1 }, { @@ -10237,6 +10713,7 @@ The embedding vector, which is a list of floats. The length of vector depends on }, IsRequired: true, Summary: The object type, which is always "embedding"., + ParameterName: object, ArgumentName: object } ], @@ -10271,6 +10748,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: false, Summary: , + ParameterName: embedding, ArgumentName: embedding } ], @@ -10302,6 +10780,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The object identifier, which can be referenced in the API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -10316,6 +10795,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the fine-tuning job was created., + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -10330,6 +10810,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: For fine-tuning jobs that have `failed`, this will contain more information on the cause of the failure., + ParameterName: error, ArgumentName: error }, { @@ -10344,6 +10825,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The name of the fine-tuned model that is being created. The value will be null if the fine-tuning job is still running., + ParameterName: fineTunedModel, ArgumentName: fineTunedModel }, { @@ -10358,6 +10840,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the fine-tuning job was finished. The value will be null if the fine-tuning job is still running., + ParameterName: finishedAt, ArgumentName: finishedAt }, { @@ -10372,6 +10855,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The hyperparameters used for the fine-tuning job. See the [fine-tuning guide](/docs/guides/fine-tuning) for more details., + ParameterName: hyperparameters, ArgumentName: hyperparameters }, { @@ -10386,6 +10870,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The base model that is being fine-tuned., + ParameterName: model, ArgumentName: model }, { @@ -10404,6 +10889,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The object type, which is always "fine_tuning.job"., + ParameterName: object, ArgumentName: object }, { @@ -10418,6 +10904,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The organization that owns the fine-tuning job., + ParameterName: organizationId, ArgumentName: organizationId }, { @@ -10432,6 +10919,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The compiled results file ID(s) for the fine-tuning job. You can retrieve the results with the [Files API](/docs/api-reference/files/retrieve-contents)., + ParameterName: resultFiles, ArgumentName: resultFiles }, { @@ -10460,6 +10948,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The current status of the fine-tuning job, which can be either `validating_files`, `queued`, `running`, `succeeded`, `failed`, or `cancelled`., + ParameterName: status, ArgumentName: status }, { @@ -10474,6 +10963,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The total number of billable tokens processed by this fine-tuning job. The value will be null if the fine-tuning job is still running., + ParameterName: trainedTokens, ArgumentName: trainedTokens }, { @@ -10488,6 +10978,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The file ID used for training. You can retrieve the training data with the [Files API](/docs/api-reference/files/retrieve-contents)., + ParameterName: trainingFile, ArgumentName: trainingFile }, { @@ -10502,6 +10993,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The file ID used for validation. You can retrieve the validation results with the [Files API](/docs/api-reference/files/retrieve-contents)., + ParameterName: validationFile, ArgumentName: validationFile }, { @@ -10516,6 +11008,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: false, Summary: A list of integrations to enable for this fine-tuning job., + ParameterName: integrations, ArgumentName: integrations }, { @@ -10530,6 +11023,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: true, Summary: The seed used for the fine-tuning job., + ParameterName: seed, ArgumentName: seed }, { @@ -10544,6 +11038,7 @@ Represents an embedding vector returned by embedding endpoint. }, IsRequired: false, Summary: The Unix timestamp (in seconds) for when the fine-tuning job is estimated to finish. The value will be null if the fine-tuning job is not running., + ParameterName: estimatedFinish, ArgumentName: estimatedFinish } ], @@ -10577,6 +11072,7 @@ The `fine_tuning.job` object represents a fine-tuning job that has been created }, IsRequired: true, Summary: A machine-readable error code., + ParameterName: code, ArgumentName: code }, { @@ -10591,6 +11087,7 @@ The `fine_tuning.job` object represents a fine-tuning job that has been created }, IsRequired: true, Summary: A human-readable error message., + ParameterName: message, ArgumentName: message }, { @@ -10605,6 +11102,7 @@ The `fine_tuning.job` object represents a fine-tuning job that has been created }, IsRequired: true, Summary: The parameter that was invalid, usually `training_file` or `validation_file`. This field will be null if the failure was not parameter-specific., + ParameterName: param, ArgumentName: param } ], @@ -10640,6 +11138,7 @@ The `fine_tuning.job` object represents a fine-tuning job that has been created The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset. "auto" decides the optimal number of epochs based on the size of the dataset. If setting the number manually, we support any number between 1 and 50 epochs.
Default Value: auto, + ParameterName: nEpochs, ArgumentName: nEpochs } ], @@ -10672,6 +11171,7 @@ The number of epochs to train the model for. An epoch refers to one full cycle t }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto } ], @@ -10704,6 +11204,7 @@ The number of epochs to train the model for. An epoch refers to one full cycle t }, IsRequired: false, Summary: , + ParameterName: fineTuningjob, ArgumentName: fineTuningjob } ], @@ -10736,6 +11237,7 @@ The number of epochs to train the model for. An epoch refers to one full cycle t }, IsRequired: false, Summary: , + ParameterName: validatingFiles, ArgumentName: validatingFiles }, { @@ -10750,6 +11252,7 @@ The number of epochs to train the model for. An epoch refers to one full cycle t }, IsRequired: false, Summary: , + ParameterName: queued, ArgumentName: queued }, { @@ -10764,6 +11267,7 @@ The number of epochs to train the model for. An epoch refers to one full cycle t }, IsRequired: false, Summary: , + ParameterName: running, ArgumentName: running }, { @@ -10778,6 +11282,7 @@ The number of epochs to train the model for. An epoch refers to one full cycle t }, IsRequired: false, Summary: , + ParameterName: succeeded, ArgumentName: succeeded }, { @@ -10792,6 +11297,7 @@ The number of epochs to train the model for. An epoch refers to one full cycle t }, IsRequired: false, Summary: , + ParameterName: failed, ArgumentName: failed }, { @@ -10806,6 +11312,7 @@ The number of epochs to train the model for. An epoch refers to one full cycle t }, IsRequired: false, Summary: , + ParameterName: cancelled, ArgumentName: cancelled } ], @@ -10841,6 +11348,7 @@ The number of epochs to train the model for. An epoch refers to one full cycle t }, IsRequired: true, Summary: The type of the integration being enabled for the fine-tuning job, + ParameterName: type, ArgumentName: type }, { @@ -10859,6 +11367,7 @@ The settings for your integration with Weights and Biases. This payload specifie metrics will be sent to. Optionally, you can set an explicit display name for your run, add tags to your run, and set a default entity (team, username, etc) to be associated with your run. , + ParameterName: wandb, ArgumentName: wandb } ], @@ -10893,6 +11402,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit The name of the project that the new run will be created under.
Example: my-wandb-project, + ParameterName: project, ArgumentName: project }, { @@ -10909,6 +11419,7 @@ The name of the project that the new run will be created under. Summary: A display name to set for the run. If not set, we will use the Job ID as the name. , + ParameterName: name, ArgumentName: name }, { @@ -10926,6 +11437,7 @@ A display name to set for the run. If not set, we will use the Job ID as the nam The entity to use for the run. This allows you to set the team or username of the WandB user that you would like associated with the run. If not set, the default entity for the registered WandB API key is used. , + ParameterName: entity, ArgumentName: entity }, { @@ -10943,6 +11455,7 @@ like associated with the run. If not set, the default entity for the registered A list of tags to be attached to the newly created run. These tags are passed through directly to WandB. Some default tags are generated by OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}". , + ParameterName: tags, ArgumentName: tags } ], @@ -10979,6 +11492,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: wandb, ArgumentName: wandb } ], @@ -11010,6 +11524,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -11024,6 +11539,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: , + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -11046,6 +11562,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: , + ParameterName: level, ArgumentName: level }, { @@ -11060,6 +11577,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: , + ParameterName: message, ArgumentName: message }, { @@ -11078,6 +11596,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object } ], @@ -11110,6 +11629,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: info, ArgumentName: info }, { @@ -11124,6 +11644,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: warn, ArgumentName: warn }, { @@ -11138,6 +11659,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: error, ArgumentName: error } ], @@ -11170,6 +11692,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: false, Summary: , + ParameterName: fineTuningjobevent, ArgumentName: fineTuningjobevent } ], @@ -11201,6 +11724,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: The checkpoint identifier, which can be referenced in the API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -11215,6 +11739,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the checkpoint was created., + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -11229,6 +11754,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: The name of the fine-tuned checkpoint model that is created., + ParameterName: fineTunedModelCheckpoint, ArgumentName: fineTunedModelCheckpoint }, { @@ -11243,6 +11769,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: The step number that the checkpoint was created at., + ParameterName: stepNumber, ArgumentName: stepNumber }, { @@ -11257,6 +11784,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: Metrics at the step number during the fine-tuning job., + ParameterName: metrics, ArgumentName: metrics }, { @@ -11271,6 +11799,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: The name of the fine-tuning job that this checkpoint was created from., + ParameterName: fineTuningJobId, ArgumentName: fineTuningJobId }, { @@ -11289,6 +11818,7 @@ to your run, and set a default entity (team, username, etc) to be associated wit }, IsRequired: true, Summary: The object type, which is always "fine_tuning.job.checkpoint"., + ParameterName: object, ArgumentName: object } ], @@ -11322,6 +11852,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: false, Summary: , + ParameterName: step, ArgumentName: step }, { @@ -11336,6 +11867,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: false, Summary: , + ParameterName: trainLoss, ArgumentName: trainLoss }, { @@ -11350,6 +11882,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: false, Summary: , + ParameterName: trainMeanTokenAccuracy, ArgumentName: trainMeanTokenAccuracy }, { @@ -11364,6 +11897,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: false, Summary: , + ParameterName: validLoss, ArgumentName: validLoss }, { @@ -11378,6 +11912,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: false, Summary: , + ParameterName: validMeanTokenAccuracy, ArgumentName: validMeanTokenAccuracy }, { @@ -11392,6 +11927,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: false, Summary: , + ParameterName: fullValidLoss, ArgumentName: fullValidLoss }, { @@ -11406,6 +11942,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: false, Summary: , + ParameterName: fullValidMeanTokenAccuracy, ArgumentName: fullValidMeanTokenAccuracy } ], @@ -11438,6 +11975,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: false, Summary: , + ParameterName: fineTuningjobcheckpoint, ArgumentName: fineTuningjobcheckpoint } ], @@ -11469,6 +12007,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: true, Summary: Number of tokens in the generated completion., + ParameterName: completionTokens, ArgumentName: completionTokens }, { @@ -11483,6 +12022,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: true, Summary: Number of tokens in the prompt., + ParameterName: promptTokens, ArgumentName: promptTokens }, { @@ -11497,6 +12037,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: true, Summary: Total number of tokens used in the request (prompt + completion)., + ParameterName: totalTokens, ArgumentName: totalTokens } ], @@ -11528,6 +12069,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: true, Summary: Number of completion tokens used over the course of the run., + ParameterName: completionTokens, ArgumentName: completionTokens }, { @@ -11542,6 +12084,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: true, Summary: Number of prompt tokens used over the course of the run., + ParameterName: promptTokens, ArgumentName: promptTokens }, { @@ -11556,6 +12099,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: true, Summary: Total number of tokens used (prompt + completion)., + ParameterName: totalTokens, ArgumentName: totalTokens } ], @@ -11587,6 +12131,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: true, Summary: Number of completion tokens used over the course of the run step., + ParameterName: completionTokens, ArgumentName: completionTokens }, { @@ -11601,6 +12146,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: true, Summary: Number of prompt tokens used over the course of the run step., + ParameterName: promptTokens, ArgumentName: promptTokens }, { @@ -11615,6 +12161,7 @@ The `fine_tuning.job.checkpoint` object represents a model checkpoint for a fine }, IsRequired: true, Summary: Total number of tokens used (prompt + completion)., + ParameterName: totalTokens, ArgumentName: totalTokens } ], @@ -11678,6 +12225,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m Must be one of `text` or `json_object`.
Default Value: text
Example: json_object, + ParameterName: type, ArgumentName: type } ], @@ -11712,6 +12260,7 @@ An object describing the expected output of the model. If `json_object` only `fu }, IsRequired: false, Summary: , + ParameterName: text, ArgumentName: text }, { @@ -11726,6 +12275,7 @@ An object describing the expected output of the model. If `json_object` only `fu }, IsRequired: false, Summary: , + ParameterName: jsonObject, ArgumentName: jsonObject } ], @@ -11760,6 +12310,7 @@ Must be one of `text` or `json_object`. }, IsRequired: true, Summary: The identifier, which can be referenced in API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -11778,6 +12329,7 @@ Must be one of `text` or `json_object`. }, IsRequired: true, Summary: The object type, which is always `assistant`., + ParameterName: object, ArgumentName: object }, { @@ -11792,6 +12344,7 @@ Must be one of `text` or `json_object`. }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the assistant was created., + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -11808,6 +12361,7 @@ Must be one of `text` or `json_object`. Summary: The name of the assistant. The maximum length is 256 characters. , + ParameterName: name, ArgumentName: name }, { @@ -11824,6 +12378,7 @@ The name of the assistant. The maximum length is 256 characters. Summary: The description of the assistant. The maximum length is 512 characters. , + ParameterName: description, ArgumentName: description }, { @@ -11840,6 +12395,7 @@ The description of the assistant. The maximum length is 512 characters. Summary: ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. , + ParameterName: model, ArgumentName: model }, { @@ -11856,6 +12412,7 @@ ID of the model to use. You can use the [List models](/docs/api-reference/models Summary: The system instructions that the assistant uses. The maximum length is 256,000 characters. , + ParameterName: instructions, ArgumentName: instructions }, { @@ -11874,6 +12431,7 @@ The system instructions that the assistant uses. The maximum length is 256,000 c A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.
Default Value: [], + ParameterName: tools, ArgumentName: tools }, { @@ -11890,6 +12448,7 @@ A list of tool enabled on the assistant. There can be a maximum of 128 tools per Summary: A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. , + ParameterName: toolResources, ArgumentName: toolResources }, { @@ -11906,6 +12465,7 @@ A set of resources that are used by the assistant's tools. The resources are spe Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata }, { @@ -11925,6 +12485,7 @@ What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -11946,6 +12507,7 @@ We generally recommend altering this or temperature but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -11966,6 +12528,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. , + ParameterName: responseFormat, ArgumentName: responseFormat } ], @@ -11997,6 +12560,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: codeInterpreter, ArgumentName: codeInterpreter }, { @@ -12011,6 +12575,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -12048,6 +12613,7 @@ A set of resources that are used by the assistant's tools. The resources are spe A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter`` tool. There can be a maximum of 20 files associated with the tool.
Default Value: [], + ParameterName: fileIds, ArgumentName: fileIds } ], @@ -12081,6 +12647,7 @@ A list of [file](/docs/api-reference/files) IDs made available to the `code_inte Summary: The ID of the [vector store](/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. , + ParameterName: vectorStoreIds, ArgumentName: vectorStoreIds } ], @@ -12131,6 +12698,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: assistant, ArgumentName: assistant } ], @@ -12163,6 +12731,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: none, ArgumentName: none }, { @@ -12177,6 +12746,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto } ], @@ -12213,6 +12783,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.
Example: gpt-4-turbo, + ParameterName: model, ArgumentName: model }, { @@ -12229,6 +12800,7 @@ ID of the model to use. You can use the [List models](/docs/api-reference/models Summary: The name of the assistant. The maximum length is 256 characters. , + ParameterName: name, ArgumentName: name }, { @@ -12245,6 +12817,7 @@ The name of the assistant. The maximum length is 256 characters. Summary: The description of the assistant. The maximum length is 512 characters. , + ParameterName: description, ArgumentName: description }, { @@ -12261,6 +12834,7 @@ The description of the assistant. The maximum length is 512 characters. Summary: The system instructions that the assistant uses. The maximum length is 256,000 characters. , + ParameterName: instructions, ArgumentName: instructions }, { @@ -12279,6 +12853,7 @@ The system instructions that the assistant uses. The maximum length is 256,000 c A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.
Default Value: [], + ParameterName: tools, ArgumentName: tools }, { @@ -12295,6 +12870,7 @@ A list of tool enabled on the assistant. There can be a maximum of 128 tools per Summary: A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. , + ParameterName: toolResources, ArgumentName: toolResources }, { @@ -12311,6 +12887,7 @@ A set of resources that are used by the assistant's tools. The resources are spe Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata }, { @@ -12330,6 +12907,7 @@ What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -12351,6 +12929,7 @@ We generally recommend altering this or temperature but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -12371,6 +12950,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. , + ParameterName: responseFormat, ArgumentName: responseFormat } ], @@ -12402,6 +12982,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: codeInterpreter, ArgumentName: codeInterpreter }, { @@ -12416,6 +12997,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -12453,6 +13035,7 @@ A set of resources that are used by the assistant's tools. The resources are spe A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.
Default Value: [], + ParameterName: fileIds, ArgumentName: fileIds } ], @@ -12486,6 +13069,7 @@ A list of [file](/docs/api-reference/files) IDs made available to the `code_inte Summary: The [vector store](/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. , + ParameterName: vectorStoreIds, ArgumentName: vectorStoreIds }, { @@ -12502,6 +13086,7 @@ The [vector store](/docs/api-reference/vector-stores/object) attached to this as Summary: A helper to create a [vector store](/docs/api-reference/vector-stores/object) with file_ids and attach it to this assistant. There can be a maximum of 1 vector store attached to the assistant. , + ParameterName: vectorStores, ArgumentName: vectorStores } ], @@ -12535,6 +13120,7 @@ A helper to create a [vector store](/docs/api-reference/vector-stores/object) wi Summary: A list of [file](/docs/api-reference/files) IDs to add to the vector store. There can be a maximum of 10000 files in a vector store. , + ParameterName: fileIds, ArgumentName: fileIds }, { @@ -12551,6 +13137,7 @@ A list of [file](/docs/api-reference/files) IDs to add to the vector store. Ther Summary: Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -12619,6 +13206,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4Turbo, ArgumentName: gpt4Turbo }, { @@ -12633,6 +13221,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4Turbo20240409, ArgumentName: gpt4Turbo20240409 }, { @@ -12647,6 +13236,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt40125Preview, ArgumentName: gpt40125Preview }, { @@ -12661,6 +13251,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4TurboPreview, ArgumentName: gpt4TurboPreview }, { @@ -12675,6 +13266,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt41106Preview, ArgumentName: gpt41106Preview }, { @@ -12689,6 +13281,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4VisionPreview, ArgumentName: gpt4VisionPreview }, { @@ -12703,6 +13296,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4, ArgumentName: gpt4 }, { @@ -12717,6 +13311,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt40314, ArgumentName: gpt40314 }, { @@ -12731,6 +13326,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt40613, ArgumentName: gpt40613 }, { @@ -12745,6 +13341,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt432k, ArgumentName: gpt432k }, { @@ -12759,6 +13356,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt432k0314, ArgumentName: gpt432k0314 }, { @@ -12773,6 +13371,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt432k0613, ArgumentName: gpt432k0613 }, { @@ -12787,6 +13386,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo, ArgumentName: gpt35Turbo }, { @@ -12801,6 +13401,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo16k, ArgumentName: gpt35Turbo16k }, { @@ -12815,6 +13416,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo0613, ArgumentName: gpt35Turbo0613 }, { @@ -12829,6 +13431,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo1106, ArgumentName: gpt35Turbo1106 }, { @@ -12843,6 +13446,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo0125, ArgumentName: gpt35Turbo0125 }, { @@ -12857,6 +13461,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo16k0613, ArgumentName: gpt35Turbo16k0613 } ], @@ -12889,6 +13494,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: none, ArgumentName: none }, { @@ -12903,6 +13509,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto } ], @@ -12939,6 +13546,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them. , + ParameterName: model, ArgumentName: model }, { @@ -12955,6 +13563,7 @@ ID of the model to use. You can use the [List models](/docs/api-reference/models Summary: The name of the assistant. The maximum length is 256 characters. , + ParameterName: name, ArgumentName: name }, { @@ -12971,6 +13580,7 @@ The name of the assistant. The maximum length is 256 characters. Summary: The description of the assistant. The maximum length is 512 characters. , + ParameterName: description, ArgumentName: description }, { @@ -12987,6 +13597,7 @@ The description of the assistant. The maximum length is 512 characters. Summary: The system instructions that the assistant uses. The maximum length is 256,000 characters. , + ParameterName: instructions, ArgumentName: instructions }, { @@ -13005,6 +13616,7 @@ The system instructions that the assistant uses. The maximum length is 256,000 c A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types `code_interpreter`, `file_search`, or `function`.
Default Value: [], + ParameterName: tools, ArgumentName: tools }, { @@ -13021,6 +13633,7 @@ A list of tool enabled on the assistant. There can be a maximum of 128 tools per Summary: A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. , + ParameterName: toolResources, ArgumentName: toolResources }, { @@ -13037,6 +13650,7 @@ A set of resources that are used by the assistant's tools. The resources are spe Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata }, { @@ -13056,6 +13670,7 @@ What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -13077,6 +13692,7 @@ We generally recommend altering this or temperature but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -13097,6 +13713,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. , + ParameterName: responseFormat, ArgumentName: responseFormat } ], @@ -13128,6 +13745,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: codeInterpreter, ArgumentName: codeInterpreter }, { @@ -13142,6 +13760,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -13179,6 +13798,7 @@ A set of resources that are used by the assistant's tools. The resources are spe Overrides the list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.
Default Value: [], + ParameterName: fileIds, ArgumentName: fileIds } ], @@ -13212,6 +13832,7 @@ Overrides the list of [file](/docs/api-reference/files) IDs made available to th Summary: Overrides the [vector store](/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. , + ParameterName: vectorStoreIds, ArgumentName: vectorStoreIds } ], @@ -13262,6 +13883,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: none, ArgumentName: none }, { @@ -13276,6 +13898,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto } ], @@ -13309,6 +13932,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -13323,6 +13947,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: deleted, ArgumentName: deleted }, { @@ -13341,6 +13966,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object } ], @@ -13373,6 +13999,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: assistantdeleted, ArgumentName: assistantdeleted } ], @@ -13405,6 +14032,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: list, + ParameterName: object, ArgumentName: object }, { @@ -13419,6 +14047,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data }, { @@ -13434,6 +14063,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: asst_abc123, + ParameterName: firstId, ArgumentName: firstId }, { @@ -13449,6 +14079,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: asst_abc456, + ParameterName: lastId, ArgumentName: lastId }, { @@ -13464,6 +14095,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: false, + ParameterName: hasMore, ArgumentName: hasMore } ], @@ -13499,6 +14131,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The type of tool being defined: `code_interpreter`, + ParameterName: type, ArgumentName: type } ], @@ -13531,6 +14164,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: codeInterpreter, ArgumentName: codeInterpreter } ], @@ -13566,6 +14200,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The type of tool being defined: `file_search`, + ParameterName: type, ArgumentName: type } ], @@ -13598,6 +14233,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -13633,6 +14269,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The type of tool being defined: `function`, + ParameterName: type, ArgumentName: type }, { @@ -13651,6 +14288,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -13683,6 +14321,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -13720,6 +14359,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The truncation strategy to use for the thread. The default is `auto`. If set to `last_messages`, the thread will be truncated to the n most recent messages in the thread. When set to `auto`, messages in the middle of the thread will be dropped to fit the context length of the model, `max_prompt_tokens`., + ParameterName: type, ArgumentName: type }, { @@ -13734,6 +14374,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The number of most recent messages from the thread when constructing the context for the run., + ParameterName: lastMessages, ArgumentName: lastMessages } ], @@ -13766,6 +14407,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto }, { @@ -13780,6 +14422,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: lastMessages, ArgumentName: lastMessages } ], @@ -13841,6 +14484,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The type of the tool. If type is `function`, the function name must be set, + ParameterName: type, ArgumentName: type }, { @@ -13855,6 +14499,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: false, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -13886,6 +14531,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The name of the function to call., + ParameterName: name, ArgumentName: name } ], @@ -13918,6 +14564,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: false, Summary: , + ParameterName: function, ArgumentName: function }, { @@ -13932,6 +14579,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: false, Summary: , + ParameterName: codeInterpreter, ArgumentName: codeInterpreter }, { @@ -13946,6 +14594,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: false, Summary: , + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -13977,6 +14626,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The identifier, which can be referenced in API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -13995,6 +14645,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The object type, which is always `thread.run`., + ParameterName: object, ArgumentName: object }, { @@ -14009,6 +14660,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the run was created., + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -14023,6 +14675,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The ID of the [thread](/docs/api-reference/threads) that was executed on as a part of this run., + ParameterName: threadId, ArgumentName: threadId }, { @@ -14037,6 +14690,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The ID of the [assistant](/docs/api-reference/assistants) used for execution of this run., + ParameterName: assistantId, ArgumentName: assistantId }, { @@ -14069,6 +14723,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The status of the run, which can be either `queued`, `in_progress`, `requires_action`, `cancelling`, `cancelled`, `failed`, `completed`, or `expired`., + ParameterName: status, ArgumentName: status }, { @@ -14083,6 +14738,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: Details on the action required to continue the run. Will be `null` if no action is required., + ParameterName: requiredAction, ArgumentName: requiredAction }, { @@ -14097,6 +14753,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The last error associated with this run. Will be `null` if there are no errors., + ParameterName: lastError, ArgumentName: lastError }, { @@ -14111,6 +14768,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the run will expire., + ParameterName: expiresAt, ArgumentName: expiresAt }, { @@ -14125,6 +14783,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the run was started., + ParameterName: startedAt, ArgumentName: startedAt }, { @@ -14139,6 +14798,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the run was cancelled., + ParameterName: cancelledAt, ArgumentName: cancelledAt }, { @@ -14153,6 +14813,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the run failed., + ParameterName: failedAt, ArgumentName: failedAt }, { @@ -14167,6 +14828,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the run was completed., + ParameterName: completedAt, ArgumentName: completedAt }, { @@ -14181,6 +14843,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: Details on why the run is incomplete. Will be `null` if the run is not incomplete., + ParameterName: incompleteDetails, ArgumentName: incompleteDetails }, { @@ -14195,6 +14858,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The model that the [assistant](/docs/api-reference/assistants) used for this run., + ParameterName: model, ArgumentName: model }, { @@ -14209,6 +14873,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi }, IsRequired: true, Summary: The instructions that the [assistant](/docs/api-reference/assistants) used for this run., + ParameterName: instructions, ArgumentName: instructions }, { @@ -14226,6 +14891,7 @@ Specifying a particular tool like `{"type": "file_search"}` or `{"type": "functi Summary: The list of tools that the [assistant](/docs/api-reference/assistants) used for this run.
Default Value: [], + ParameterName: tools, ArgumentName: tools }, { @@ -14242,6 +14908,7 @@ The list of tools that the [assistant](/docs/api-reference/assistants) used for Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata }, { @@ -14260,6 +14927,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: Usage statistics related to the run. This value will be `null` if the run is not in a terminal state (i.e. `in_progress`, `queued`, etc.)., + ParameterName: usage, ArgumentName: usage }, { @@ -14274,6 +14942,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The sampling temperature used for this run. If not set, defaults to 1., + ParameterName: temperature, ArgumentName: temperature }, { @@ -14288,6 +14957,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The nucleus sampling value used for this run. If not set, defaults to 1., + ParameterName: topP, ArgumentName: topP }, { @@ -14304,6 +14974,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: The maximum number of prompt tokens specified to have been used over the course of the run. , + ParameterName: maxPromptTokens, ArgumentName: maxPromptTokens }, { @@ -14320,6 +14991,7 @@ The maximum number of prompt tokens specified to have been used over the course Summary: The maximum number of completion tokens specified to have been used over the course of the run. , + ParameterName: maxCompletionTokens, ArgumentName: maxCompletionTokens }, { @@ -14337,6 +15009,7 @@ The maximum number of completion tokens specified to have been used over the cou }, IsRequired: true, Summary: Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run., + ParameterName: truncationStrategy, ArgumentName: truncationStrategy }, { @@ -14357,6 +15030,7 @@ Controls which (if any) tool is called by the model. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. , + ParameterName: toolChoice, ArgumentName: toolChoice }, { @@ -14377,6 +15051,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. , + ParameterName: responseFormat, ArgumentName: responseFormat } ], @@ -14412,6 +15087,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: true, Summary: For now, this is always `submit_tool_outputs`., + ParameterName: type, ArgumentName: type }, { @@ -14426,6 +15102,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: true, Summary: Details on the tool outputs needed for this run to continue., + ParameterName: submitToolOutputs, ArgumentName: submitToolOutputs } ], @@ -14457,6 +15134,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: true, Summary: A list of the relevant tool calls., + ParameterName: toolCalls, ArgumentName: toolCalls } ], @@ -14489,6 +15167,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: submitToolOutputs, ArgumentName: submitToolOutputs } ], @@ -14528,6 +15207,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: true, Summary: One of `server_error`, `rate_limit_exceeded`, or `invalid_prompt`., + ParameterName: code, ArgumentName: code }, { @@ -14542,6 +15222,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: true, Summary: A human-readable description of the error., + ParameterName: message, ArgumentName: message } ], @@ -14574,6 +15255,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: serverError, ArgumentName: serverError }, { @@ -14588,6 +15270,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: rateLimitExceeded, ArgumentName: rateLimitExceeded }, { @@ -14602,6 +15285,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: invalidPrompt, ArgumentName: invalidPrompt } ], @@ -14639,6 +15323,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: The reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run., + ParameterName: reason, ArgumentName: reason } ], @@ -14671,6 +15356,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: maxCompletionTokens, ArgumentName: maxCompletionTokens }, { @@ -14685,6 +15371,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: maxPromptTokens, ArgumentName: maxPromptTokens } ], @@ -14735,6 +15422,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: threadrun, ArgumentName: threadrun } ], @@ -14767,6 +15455,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: queued, ArgumentName: queued }, { @@ -14781,6 +15470,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: inProgress, ArgumentName: inProgress }, { @@ -14795,6 +15485,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: requiresAction, ArgumentName: requiresAction }, { @@ -14809,6 +15500,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: cancelling, ArgumentName: cancelling }, { @@ -14823,6 +15515,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: cancelled, ArgumentName: cancelled }, { @@ -14837,6 +15530,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: failed, ArgumentName: failed }, { @@ -14851,6 +15545,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: completed, ArgumentName: completed }, { @@ -14865,6 +15560,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: expired, ArgumentName: expired } ], @@ -14897,6 +15593,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: none, ArgumentName: none }, { @@ -14911,6 +15608,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto }, { @@ -14925,6 +15623,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: required, ArgumentName: required } ], @@ -14959,6 +15658,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: none, ArgumentName: none }, { @@ -14973,6 +15673,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto } ], @@ -15006,6 +15707,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run., + ParameterName: assistantId, ArgumentName: assistantId }, { @@ -15023,6 +15725,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.
Example: gpt-4-turbo, + ParameterName: model, ArgumentName: model }, { @@ -15037,6 +15740,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run }, IsRequired: false, Summary: Overrides the [instructions](/docs/api-reference/assistants/createAssistant) of the assistant. This is useful for modifying the behavior on a per-run basis., + ParameterName: instructions, ArgumentName: instructions }, { @@ -15051,6 +15755,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run }, IsRequired: false, Summary: Appends additional instructions at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions., + ParameterName: additionalInstructions, ArgumentName: additionalInstructions }, { @@ -15065,6 +15770,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run }, IsRequired: false, Summary: Adds additional messages to the thread before creating the run., + ParameterName: additionalMessages, ArgumentName: additionalMessages }, { @@ -15079,6 +15785,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run }, IsRequired: false, Summary: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis., + ParameterName: tools, ArgumentName: tools }, { @@ -15095,6 +15802,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata }, { @@ -15114,6 +15822,7 @@ What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -15135,6 +15844,7 @@ We generally recommend altering this or temperature but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -15151,6 +15861,7 @@ We generally recommend altering this or temperature but not both. Summary: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. , + ParameterName: stream, ArgumentName: stream }, { @@ -15167,6 +15878,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent Summary: The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. , + ParameterName: maxPromptTokens, ArgumentName: maxPromptTokens }, { @@ -15183,6 +15895,7 @@ The maximum number of prompt tokens that may be used over the course of the run. Summary: The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. , + ParameterName: maxCompletionTokens, ArgumentName: maxCompletionTokens }, { @@ -15200,6 +15913,7 @@ The maximum number of completion tokens that may be used over the course of the }, IsRequired: false, Summary: Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run., + ParameterName: truncationStrategy, ArgumentName: truncationStrategy }, { @@ -15220,6 +15934,7 @@ Controls which (if any) tool is called by the model. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. , + ParameterName: toolChoice, ArgumentName: toolChoice }, { @@ -15240,6 +15955,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. , + ParameterName: responseFormat, ArgumentName: responseFormat } ], @@ -15290,6 +16006,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4Turbo, ArgumentName: gpt4Turbo }, { @@ -15304,6 +16021,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4Turbo20240409, ArgumentName: gpt4Turbo20240409 }, { @@ -15318,6 +16036,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt40125Preview, ArgumentName: gpt40125Preview }, { @@ -15332,6 +16051,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4TurboPreview, ArgumentName: gpt4TurboPreview }, { @@ -15346,6 +16066,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt41106Preview, ArgumentName: gpt41106Preview }, { @@ -15360,6 +16081,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4VisionPreview, ArgumentName: gpt4VisionPreview }, { @@ -15374,6 +16096,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4, ArgumentName: gpt4 }, { @@ -15388,6 +16111,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt40314, ArgumentName: gpt40314 }, { @@ -15402,6 +16126,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt40613, ArgumentName: gpt40613 }, { @@ -15416,6 +16141,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt432k, ArgumentName: gpt432k }, { @@ -15430,6 +16156,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt432k0314, ArgumentName: gpt432k0314 }, { @@ -15444,6 +16171,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt432k0613, ArgumentName: gpt432k0613 }, { @@ -15458,6 +16186,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo, ArgumentName: gpt35Turbo }, { @@ -15472,6 +16201,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo16k, ArgumentName: gpt35Turbo16k }, { @@ -15486,6 +16216,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo0613, ArgumentName: gpt35Turbo0613 }, { @@ -15500,6 +16231,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo1106, ArgumentName: gpt35Turbo1106 }, { @@ -15514,6 +16246,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo0125, ArgumentName: gpt35Turbo0125 }, { @@ -15528,6 +16261,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo16k0613, ArgumentName: gpt35Turbo16k0613 } ], @@ -15560,6 +16294,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: none, ArgumentName: none }, { @@ -15574,6 +16309,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto }, { @@ -15588,6 +16324,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: required, ArgumentName: required } ], @@ -15622,6 +16359,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: none, ArgumentName: none }, { @@ -15636,6 +16374,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto } ], @@ -15670,6 +16409,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: list, + ParameterName: object, ArgumentName: object }, { @@ -15684,6 +16424,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data }, { @@ -15699,6 +16440,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: run_abc123, + ParameterName: firstId, ArgumentName: firstId }, { @@ -15714,6 +16456,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: run_abc456, + ParameterName: lastId, ArgumentName: lastId }, { @@ -15729,6 +16472,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: false, + ParameterName: hasMore, ArgumentName: hasMore } ], @@ -15762,6 +16506,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -15811,6 +16556,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: A list of tools for which the outputs are being submitted., + ParameterName: toolOutputs, ArgumentName: toolOutputs }, { @@ -15827,6 +16573,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. , + ParameterName: stream, ArgumentName: stream } ], @@ -15858,6 +16605,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: false, Summary: The ID of the tool call in the `required_action` object within the run object the output is being submitted for., + ParameterName: toolCallId, ArgumentName: toolCallId }, { @@ -15872,6 +16620,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: false, Summary: The output of the tool call to be submitted to continue the run., + ParameterName: output, ArgumentName: output } ], @@ -15903,6 +16652,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: true, Summary: The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the [Submit tool outputs to run](/docs/api-reference/runs/submitToolOutputs) endpoint., + ParameterName: id, ArgumentName: id }, { @@ -15921,6 +16671,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: true, Summary: The type of tool call the output is required for. For now, this is always `function`., + ParameterName: type, ArgumentName: type }, { @@ -15935,6 +16686,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: true, Summary: The function definition., + ParameterName: function, ArgumentName: function } ], @@ -15966,6 +16718,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: true, Summary: The name of the function., + ParameterName: name, ArgumentName: name }, { @@ -15980,6 +16733,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: true, Summary: The arguments that the model expects you to pass to the function., + ParameterName: arguments, ArgumentName: arguments } ], @@ -16012,6 +16766,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: false, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -16043,6 +16798,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: true, Summary: The ID of the [assistant](/docs/api-reference/assistants) to use to execute this run., + ParameterName: assistantId, ArgumentName: assistantId }, { @@ -16061,6 +16817,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent }, IsRequired: false, Summary: , + ParameterName: thread, ArgumentName: thread }, { @@ -16078,6 +16835,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent Summary: The ID of the [Model](/docs/api-reference/models) to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.
Example: gpt-4-turbo, + ParameterName: model, ArgumentName: model }, { @@ -16092,6 +16850,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run }, IsRequired: false, Summary: Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis., + ParameterName: instructions, ArgumentName: instructions }, { @@ -16106,6 +16865,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run }, IsRequired: false, Summary: Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis., + ParameterName: tools, ArgumentName: tools }, { @@ -16122,6 +16882,7 @@ The ID of the [Model](/docs/api-reference/models) to be used to execute this run Summary: A set of resources that are used by the assistant's tools. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. , + ParameterName: toolResources, ArgumentName: toolResources }, { @@ -16138,6 +16899,7 @@ A set of resources that are used by the assistant's tools. The resources are spe Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata }, { @@ -16157,6 +16919,7 @@ What sampling temperature to use, between 0 and 2. Higher values like 0.8 will m
Default Value: 1
Example: 1, + ParameterName: temperature, ArgumentName: temperature }, { @@ -16178,6 +16941,7 @@ We generally recommend altering this or temperature but not both.
Default Value: 1
Example: 1, + ParameterName: topP, ArgumentName: topP }, { @@ -16194,6 +16958,7 @@ We generally recommend altering this or temperature but not both. Summary: If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. , + ParameterName: stream, ArgumentName: stream }, { @@ -16210,6 +16975,7 @@ If `true`, returns a stream of events that happen during the Run as server-sent Summary: The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. , + ParameterName: maxPromptTokens, ArgumentName: maxPromptTokens }, { @@ -16226,6 +16992,7 @@ The maximum number of prompt tokens that may be used over the course of the run. Summary: The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. , + ParameterName: maxCompletionTokens, ArgumentName: maxCompletionTokens }, { @@ -16243,6 +17010,7 @@ The maximum number of completion tokens that may be used over the course of the }, IsRequired: false, Summary: Controls for how a thread will be truncated prior to the run. Use this to control the intial context window of the run., + ParameterName: truncationStrategy, ArgumentName: truncationStrategy }, { @@ -16263,6 +17031,7 @@ Controls which (if any) tool is called by the model. `required` means the model must call one or more tools before responding to the user. Specifying a particular tool like `{"type": "file_search"}` or `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool. , + ParameterName: toolChoice, ArgumentName: toolChoice }, { @@ -16283,6 +17052,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length. , + ParameterName: responseFormat, ArgumentName: responseFormat } ], @@ -16314,6 +17084,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: codeInterpreter, ArgumentName: codeInterpreter }, { @@ -16328,6 +17099,7 @@ Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the m }, IsRequired: false, Summary: , + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -16365,6 +17137,7 @@ A set of resources that are used by the assistant's tools. The resources are spe A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.
Default Value: [], + ParameterName: fileIds, ArgumentName: fileIds } ], @@ -16398,6 +17171,7 @@ A list of [file](/docs/api-reference/files) IDs made available to the `code_inte Summary: The ID of the [vector store](/docs/api-reference/vector-stores/object) attached to this assistant. There can be a maximum of 1 vector store attached to the assistant. , + ParameterName: vectorStoreIds, ArgumentName: vectorStoreIds } ], @@ -16448,6 +17222,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4Turbo, ArgumentName: gpt4Turbo }, { @@ -16462,6 +17237,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4Turbo20240409, ArgumentName: gpt4Turbo20240409 }, { @@ -16476,6 +17252,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt40125Preview, ArgumentName: gpt40125Preview }, { @@ -16490,6 +17267,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4TurboPreview, ArgumentName: gpt4TurboPreview }, { @@ -16504,6 +17282,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt41106Preview, ArgumentName: gpt41106Preview }, { @@ -16518,6 +17297,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4VisionPreview, ArgumentName: gpt4VisionPreview }, { @@ -16532,6 +17312,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt4, ArgumentName: gpt4 }, { @@ -16546,6 +17327,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt40314, ArgumentName: gpt40314 }, { @@ -16560,6 +17342,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt40613, ArgumentName: gpt40613 }, { @@ -16574,6 +17357,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt432k, ArgumentName: gpt432k }, { @@ -16588,6 +17372,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt432k0314, ArgumentName: gpt432k0314 }, { @@ -16602,6 +17387,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt432k0613, ArgumentName: gpt432k0613 }, { @@ -16616,6 +17402,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo, ArgumentName: gpt35Turbo }, { @@ -16630,6 +17417,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo16k, ArgumentName: gpt35Turbo16k }, { @@ -16644,6 +17432,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo0613, ArgumentName: gpt35Turbo0613 }, { @@ -16658,6 +17447,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo1106, ArgumentName: gpt35Turbo1106 }, { @@ -16672,6 +17462,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo0125, ArgumentName: gpt35Turbo0125 }, { @@ -16686,6 +17477,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: gpt35Turbo16k0613, ArgumentName: gpt35Turbo16k0613 } ], @@ -16718,6 +17510,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: none, ArgumentName: none }, { @@ -16732,6 +17525,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto }, { @@ -16746,6 +17540,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: required, ArgumentName: required } ], @@ -16780,6 +17575,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: none, ArgumentName: none }, { @@ -16794,6 +17590,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto } ], @@ -16827,6 +17624,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The identifier, which can be referenced in API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -16845,6 +17643,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The object type, which is always `thread`., + ParameterName: object, ArgumentName: object }, { @@ -16859,6 +17658,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the thread was created., + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -16875,6 +17675,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. , + ParameterName: toolResources, ArgumentName: toolResources }, { @@ -16891,6 +17692,7 @@ A set of resources that are made available to the assistant's tools in this thre Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -16922,6 +17724,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: codeInterpreter, ArgumentName: codeInterpreter }, { @@ -16936,6 +17739,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -16973,6 +17777,7 @@ A set of resources that are made available to the assistant's tools in this thre A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.
Default Value: [], + ParameterName: fileIds, ArgumentName: fileIds } ], @@ -17006,6 +17811,7 @@ A list of [file](/docs/api-reference/files) IDs made available to the `code_inte Summary: The [vector store](/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. , + ParameterName: vectorStoreIds, ArgumentName: vectorStoreIds } ], @@ -17056,6 +17862,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: thread, ArgumentName: thread } ], @@ -17087,6 +17894,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: A list of [messages](/docs/api-reference/messages) to start the thread with., + ParameterName: messages, ArgumentName: messages }, { @@ -17103,6 +17911,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. , + ParameterName: toolResources, ArgumentName: toolResources }, { @@ -17119,6 +17928,7 @@ A set of resources that are made available to the assistant's tools in this thre Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -17150,6 +17960,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: codeInterpreter, ArgumentName: codeInterpreter }, { @@ -17164,6 +17975,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -17201,6 +18013,7 @@ A set of resources that are made available to the assistant's tools in this thre A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.
Default Value: [], + ParameterName: fileIds, ArgumentName: fileIds } ], @@ -17234,6 +18047,7 @@ A list of [file](/docs/api-reference/files) IDs made available to the `code_inte Summary: The [vector store](/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. , + ParameterName: vectorStoreIds, ArgumentName: vectorStoreIds }, { @@ -17250,6 +18064,7 @@ The [vector store](/docs/api-reference/vector-stores/object) attached to this th Summary: A helper to create a [vector store](/docs/api-reference/vector-stores/object) with file_ids and attach it to this thread. There can be a maximum of 1 vector store attached to the thread. , + ParameterName: vectorStores, ArgumentName: vectorStores } ], @@ -17283,6 +18098,7 @@ A helper to create a [vector store](/docs/api-reference/vector-stores/object) wi Summary: A list of [file](/docs/api-reference/files) IDs to add to the vector store. There can be a maximum of 10000 files in a vector store. , + ParameterName: fileIds, ArgumentName: fileIds }, { @@ -17299,6 +18115,7 @@ A list of [file](/docs/api-reference/files) IDs to add to the vector store. Ther Summary: Set of 16 key-value pairs that can be attached to a vector store. This can be useful for storing additional information about the vector store in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -17368,6 +18185,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs. , + ParameterName: toolResources, ArgumentName: toolResources }, { @@ -17384,6 +18202,7 @@ A set of resources that are made available to the assistant's tools in this thre Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -17415,6 +18234,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: codeInterpreter, ArgumentName: codeInterpreter }, { @@ -17429,6 +18249,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -17466,6 +18287,7 @@ A set of resources that are made available to the assistant's tools in this thre A list of [file](/docs/api-reference/files) IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.
Default Value: [], + ParameterName: fileIds, ArgumentName: fileIds } ], @@ -17499,6 +18321,7 @@ A list of [file](/docs/api-reference/files) IDs made available to the `code_inte Summary: The [vector store](/docs/api-reference/vector-stores/object) attached to this thread. There can be a maximum of 1 vector store attached to the thread. , + ParameterName: vectorStoreIds, ArgumentName: vectorStoreIds } ], @@ -17548,6 +18371,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -17562,6 +18386,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: deleted, ArgumentName: deleted }, { @@ -17580,6 +18405,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object } ], @@ -17612,6 +18438,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: threaddeleted, ArgumentName: threaddeleted } ], @@ -17644,6 +18471,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: list, + ParameterName: object, ArgumentName: object }, { @@ -17658,6 +18486,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data }, { @@ -17673,6 +18502,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: asst_abc123, + ParameterName: firstId, ArgumentName: firstId }, { @@ -17688,6 +18518,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: asst_abc456, + ParameterName: lastId, ArgumentName: lastId }, { @@ -17703,6 +18534,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: false, + ParameterName: hasMore, ArgumentName: hasMore } ], @@ -17734,6 +18566,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The identifier, which can be referenced in API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -17752,6 +18585,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The object type, which is always `thread.message`., + ParameterName: object, ArgumentName: object }, { @@ -17766,6 +18600,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the message was created., + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -17780,6 +18615,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The [thread](/docs/api-reference/threads) ID that this message belongs to., + ParameterName: threadId, ArgumentName: threadId }, { @@ -17802,6 +18638,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The status of the message, which can be either `in_progress`, `incomplete`, or `completed`., + ParameterName: status, ArgumentName: status }, { @@ -17816,6 +18653,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: On an incomplete message, details about why the message is incomplete., + ParameterName: incompleteDetails, ArgumentName: incompleteDetails }, { @@ -17830,6 +18668,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the message was completed., + ParameterName: completedAt, ArgumentName: completedAt }, { @@ -17844,6 +18683,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the message was marked as incomplete., + ParameterName: incompleteAt, ArgumentName: incompleteAt }, { @@ -17864,6 +18704,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The entity that produced the message. One of `user` or `assistant`., + ParameterName: role, ArgumentName: role }, { @@ -17878,6 +18719,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The content of the message in array of text and/or images., + ParameterName: content, ArgumentName: content }, { @@ -17892,6 +18734,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: If applicable, the ID of the [assistant](/docs/api-reference/assistants) that authored this message., + ParameterName: assistantId, ArgumentName: assistantId }, { @@ -17906,6 +18749,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The ID of the [run](/docs/api-reference/runs) associated with the creation of this message. Value is `null` when messages are created manually using the create message or create thread endpoints., + ParameterName: runId, ArgumentName: runId }, { @@ -17920,6 +18764,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: A list of files attached to the message, and the tools they were added to., + ParameterName: attachments, ArgumentName: attachments }, { @@ -17936,6 +18781,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -17979,6 +18825,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The reason the message is incomplete., + ParameterName: reason, ArgumentName: reason } ], @@ -18011,6 +18858,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: contentFilter, ArgumentName: contentFilter }, { @@ -18025,6 +18873,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: maxTokens, ArgumentName: maxTokens }, { @@ -18039,6 +18888,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: runCancelled, ArgumentName: runCancelled }, { @@ -18053,6 +18903,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: runExpired, ArgumentName: runExpired }, { @@ -18067,6 +18918,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: runFailed, ArgumentName: runFailed } ], @@ -18116,6 +18968,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The ID of the file to attach to the message., + ParameterName: fileId, ArgumentName: fileId }, { @@ -18130,6 +18983,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The tools to add this file to., + ParameterName: tools, ArgumentName: tools } ], @@ -18162,6 +19016,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: threadmessage, ArgumentName: threadmessage } ], @@ -18194,6 +19049,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: inProgress, ArgumentName: inProgress }, { @@ -18208,6 +19064,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: incomplete, ArgumentName: incomplete }, { @@ -18222,6 +19079,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: completed, ArgumentName: completed } ], @@ -18254,6 +19112,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: user, ArgumentName: user }, { @@ -18268,6 +19127,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: assistant, ArgumentName: assistant } ], @@ -18299,6 +19159,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The identifier of the message, which can be referenced in API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -18317,6 +19178,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The object type, which is always `thread.message.delta`., + ParameterName: object, ArgumentName: object }, { @@ -18331,6 +19193,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The delta containing the fields that have changed on the Message., + ParameterName: delta, ArgumentName: delta } ], @@ -18370,6 +19233,7 @@ Represents a message delta i.e. any changed fields on a message during streaming }, IsRequired: false, Summary: The entity that produced the message. One of `user` or `assistant`., + ParameterName: role, ArgumentName: role }, { @@ -18384,6 +19248,7 @@ Represents a message delta i.e. any changed fields on a message during streaming }, IsRequired: false, Summary: The content of the message in array of text and/or images., + ParameterName: content, ArgumentName: content } ], @@ -18416,6 +19281,7 @@ Represents a message delta i.e. any changed fields on a message during streaming }, IsRequired: false, Summary: , + ParameterName: user, ArgumentName: user }, { @@ -18430,6 +19296,7 @@ Represents a message delta i.e. any changed fields on a message during streaming }, IsRequired: false, Summary: , + ParameterName: assistant, ArgumentName: assistant } ], @@ -18462,6 +19329,7 @@ Represents a message delta i.e. any changed fields on a message during streaming }, IsRequired: false, Summary: , + ParameterName: threadmessagedelta, ArgumentName: threadmessagedelta } ], @@ -18503,6 +19371,7 @@ The role of the entity that is creating the message. Allowed values include: - `user`: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages. - `assistant`: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation. , + ParameterName: role, ArgumentName: role }, { @@ -18517,6 +19386,7 @@ The role of the entity that is creating the message. Allowed values include: }, IsRequired: true, Summary: , + ParameterName: content, ArgumentName: content }, { @@ -18531,6 +19401,7 @@ The role of the entity that is creating the message. Allowed values include: }, IsRequired: false, Summary: A list of files attached to the message, and the tools they should be added to., + ParameterName: attachments, ArgumentName: attachments }, { @@ -18547,6 +19418,7 @@ The role of the entity that is creating the message. Allowed values include: Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -18596,6 +19468,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The ID of the file to attach to the message., + ParameterName: fileId, ArgumentName: fileId }, { @@ -18610,6 +19483,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The tools to add this file to., + ParameterName: tools, ArgumentName: tools } ], @@ -18642,6 +19516,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: user, ArgumentName: user }, { @@ -18656,6 +19531,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: assistant, ArgumentName: assistant } ], @@ -18693,6 +19569,7 @@ The role of the entity that is creating the message. Allowed values include: Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -18742,6 +19619,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -18756,6 +19634,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: deleted, ArgumentName: deleted }, { @@ -18774,6 +19653,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object } ], @@ -18806,6 +19686,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: threadmessagedeleted, ArgumentName: threadmessagedeleted } ], @@ -18838,6 +19719,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: list, + ParameterName: object, ArgumentName: object }, { @@ -18852,6 +19734,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data }, { @@ -18867,6 +19750,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: msg_abc123, + ParameterName: firstId, ArgumentName: firstId }, { @@ -18882,6 +19766,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: msg_abc123, + ParameterName: lastId, ArgumentName: lastId }, { @@ -18897,6 +19782,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: false, + ParameterName: hasMore, ArgumentName: hasMore } ], @@ -18932,6 +19818,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: Always `image_file`., + ParameterName: type, ArgumentName: type }, { @@ -18946,6 +19833,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: imageFile, ArgumentName: imageFile } ], @@ -18977,6 +19865,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The [File](/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content., + ParameterName: fileId, ArgumentName: fileId }, { @@ -19002,6 +19891,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.
Default Value: auto, + ParameterName: detail, ArgumentName: detail } ], @@ -19034,6 +19924,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto }, { @@ -19048,6 +19939,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: false, Summary: , + ParameterName: low, ArgumentName: low }, { @@ -19062,6 +19954,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: false, Summary: , + ParameterName: high, ArgumentName: high } ], @@ -19096,6 +19989,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: false, Summary: , + ParameterName: imageFile, ArgumentName: imageFile } ], @@ -19127,6 +20021,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: true, Summary: The index of the content part in the message., + ParameterName: index, ArgumentName: index }, { @@ -19145,6 +20040,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: true, Summary: Always `image_file`., + ParameterName: type, ArgumentName: type }, { @@ -19159,6 +20055,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: false, Summary: , + ParameterName: imageFile, ArgumentName: imageFile } ], @@ -19190,6 +20087,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: false, Summary: The [File](/docs/api-reference/files) ID of the image in the message content. Set `purpose="vision"` when uploading the File if you need to later display the file content., + ParameterName: fileId, ArgumentName: fileId }, { @@ -19215,6 +20113,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few Summary: Specifies the detail level of the image if specified by the user. `low` uses fewer tokens, you can opt in to high resolution using `high`.
Default Value: auto, + ParameterName: detail, ArgumentName: detail } ], @@ -19247,6 +20146,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto }, { @@ -19261,6 +20161,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: false, Summary: , + ParameterName: low, ArgumentName: low }, { @@ -19275,6 +20176,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: false, Summary: , + ParameterName: high, ArgumentName: high } ], @@ -19309,6 +20211,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: false, Summary: , + ParameterName: imageFile, ArgumentName: imageFile } ], @@ -19344,6 +20247,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: true, Summary: The type of the content part., + ParameterName: type, ArgumentName: type }, { @@ -19358,6 +20262,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: true, Summary: , + ParameterName: imageUrl, ArgumentName: imageUrl } ], @@ -19389,6 +20294,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few }, IsRequired: true, Summary: The external URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp., + ParameterName: url, ArgumentName: url }, { @@ -19414,6 +20320,7 @@ Specifies the detail level of the image if specified by the user. `low` uses few Summary: Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`. Default value is `auto`
Default Value: auto, + ParameterName: detail, ArgumentName: detail } ], @@ -19446,6 +20353,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto }, { @@ -19460,6 +20368,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: low, ArgumentName: low }, { @@ -19474,6 +20383,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: high, ArgumentName: high } ], @@ -19508,6 +20418,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: imageUrl, ArgumentName: imageUrl } ], @@ -19539,6 +20450,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The index of the content part in the message., + ParameterName: index, ArgumentName: index }, { @@ -19557,6 +20469,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: Always `image_url`., + ParameterName: type, ArgumentName: type }, { @@ -19571,6 +20484,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: imageUrl, ArgumentName: imageUrl } ], @@ -19602,6 +20516,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: The URL of the image, must be a supported image types: jpeg, jpg, png, gif, webp., + ParameterName: url, ArgumentName: url }, { @@ -19627,6 +20542,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in Summary: Specifies the detail level of the image. `low` uses fewer tokens, you can opt in to high resolution using `high`.
Default Value: auto, + ParameterName: detail, ArgumentName: detail } ], @@ -19659,6 +20575,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: auto, ArgumentName: auto }, { @@ -19673,6 +20590,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: low, ArgumentName: low }, { @@ -19687,6 +20605,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: high, ArgumentName: high } ], @@ -19721,6 +20640,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: imageUrl, ArgumentName: imageUrl } ], @@ -19756,6 +20676,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: Always `text`., + ParameterName: type, ArgumentName: type }, { @@ -19770,6 +20691,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: , + ParameterName: text, ArgumentName: text } ], @@ -19801,6 +20723,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The data that makes up the text., + ParameterName: value, ArgumentName: value }, { @@ -19815,6 +20738,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: , + ParameterName: annotations, ArgumentName: annotations } ], @@ -19847,6 +20771,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: text, ArgumentName: text } ], @@ -19882,6 +20807,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: Always `text`., + ParameterName: type, ArgumentName: type }, { @@ -19896,6 +20822,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: Text content to be sent to the model, + ParameterName: text, ArgumentName: text } ], @@ -19928,6 +20855,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: text, ArgumentName: text } ], @@ -19963,6 +20891,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: Always `file_citation`., + ParameterName: type, ArgumentName: type }, { @@ -19977,6 +20906,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The text in the message content that needs to be replaced., + ParameterName: text, ArgumentName: text }, { @@ -19991,6 +20921,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: , + ParameterName: fileCitation, ArgumentName: fileCitation }, { @@ -20005,6 +20936,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: , + ParameterName: startIndex, ArgumentName: startIndex }, { @@ -20019,6 +20951,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: , + ParameterName: endIndex, ArgumentName: endIndex } ], @@ -20050,6 +20983,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The ID of the specific File the citation is from., + ParameterName: fileId, ArgumentName: fileId }, { @@ -20064,6 +20998,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The specific quote in the file., + ParameterName: quote, ArgumentName: quote } ], @@ -20096,6 +21031,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: fileCitation, ArgumentName: fileCitation } ], @@ -20131,6 +21067,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: Always `file_path`., + ParameterName: type, ArgumentName: type }, { @@ -20145,6 +21082,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The text in the message content that needs to be replaced., + ParameterName: text, ArgumentName: text }, { @@ -20159,6 +21097,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: , + ParameterName: filePath, ArgumentName: filePath }, { @@ -20173,6 +21112,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: , + ParameterName: startIndex, ArgumentName: startIndex }, { @@ -20187,6 +21127,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: , + ParameterName: endIndex, ArgumentName: endIndex } ], @@ -20218,6 +21159,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The ID of the file that was generated., + ParameterName: fileId, ArgumentName: fileId } ], @@ -20250,6 +21192,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: filePath, ArgumentName: filePath } ], @@ -20281,6 +21224,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The index of the content part in the message., + ParameterName: index, ArgumentName: index }, { @@ -20299,6 +21243,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: Always `text`., + ParameterName: type, ArgumentName: type }, { @@ -20313,6 +21258,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: text, ArgumentName: text } ], @@ -20344,6 +21290,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: The data that makes up the text., + ParameterName: value, ArgumentName: value }, { @@ -20358,6 +21305,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: annotations, ArgumentName: annotations } ], @@ -20390,6 +21338,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: text, ArgumentName: text } ], @@ -20421,6 +21370,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The index of the annotation in the text content part., + ParameterName: index, ArgumentName: index }, { @@ -20439,6 +21389,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: Always `file_citation`., + ParameterName: type, ArgumentName: type }, { @@ -20453,6 +21404,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: The text in the message content that needs to be replaced., + ParameterName: text, ArgumentName: text }, { @@ -20467,6 +21419,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: fileCitation, ArgumentName: fileCitation }, { @@ -20481,6 +21434,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: startIndex, ArgumentName: startIndex }, { @@ -20495,6 +21449,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: endIndex, ArgumentName: endIndex } ], @@ -20526,6 +21481,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: The ID of the specific File the citation is from., + ParameterName: fileId, ArgumentName: fileId }, { @@ -20540,6 +21496,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: The specific quote in the file., + ParameterName: quote, ArgumentName: quote } ], @@ -20572,6 +21529,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: fileCitation, ArgumentName: fileCitation } ], @@ -20603,6 +21561,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The index of the annotation in the text content part., + ParameterName: index, ArgumentName: index }, { @@ -20621,6 +21580,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: Always `file_path`., + ParameterName: type, ArgumentName: type }, { @@ -20635,6 +21595,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: The text in the message content that needs to be replaced., + ParameterName: text, ArgumentName: text }, { @@ -20649,6 +21610,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: filePath, ArgumentName: filePath }, { @@ -20663,6 +21625,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: startIndex, ArgumentName: startIndex }, { @@ -20677,6 +21640,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: endIndex, ArgumentName: endIndex } ], @@ -20708,6 +21672,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: The ID of the file that was generated., + ParameterName: fileId, ArgumentName: fileId } ], @@ -20740,6 +21705,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: false, Summary: , + ParameterName: filePath, ArgumentName: filePath } ], @@ -20771,6 +21737,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The identifier of the run step, which can be referenced in API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -20789,6 +21756,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The object type, which is always `thread.run.step`., + ParameterName: object, ArgumentName: object }, { @@ -20803,6 +21771,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the run step was created., + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -20817,6 +21786,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The ID of the [assistant](/docs/api-reference/assistants) associated with the run step., + ParameterName: assistantId, ArgumentName: assistantId }, { @@ -20831,6 +21801,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The ID of the [thread](/docs/api-reference/threads) that was run., + ParameterName: threadId, ArgumentName: threadId }, { @@ -20845,6 +21816,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The ID of the [run](/docs/api-reference/runs) that this run step is a part of., + ParameterName: runId, ArgumentName: runId }, { @@ -20865,6 +21837,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The type of run step, which can be either `message_creation` or `tool_calls`., + ParameterName: type, ArgumentName: type }, { @@ -20891,6 +21864,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The status of the run step, which can be either `in_progress`, `cancelled`, `failed`, `completed`, or `expired`., + ParameterName: status, ArgumentName: status }, { @@ -20905,6 +21879,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The details of the run step., + ParameterName: stepDetails, ArgumentName: stepDetails }, { @@ -20919,6 +21894,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The last error associated with this run step. Will be `null` if there are no errors., + ParameterName: lastError, ArgumentName: lastError }, { @@ -20933,6 +21909,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the run step expired. A step is considered expired if the parent run is expired., + ParameterName: expiredAt, ArgumentName: expiredAt }, { @@ -20947,6 +21924,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the run step was cancelled., + ParameterName: cancelledAt, ArgumentName: cancelledAt }, { @@ -20961,6 +21939,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the run step failed., + ParameterName: failedAt, ArgumentName: failedAt }, { @@ -20975,6 +21954,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the run step completed., + ParameterName: completedAt, ArgumentName: completedAt }, { @@ -20991,6 +21971,7 @@ Specifies the detail level of the image. `low` uses fewer tokens, you can opt in Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata }, { @@ -21009,6 +21990,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: Usage statistics related to the run step. This value will be `null` while the run step's status is `in_progress`., + ParameterName: usage, ArgumentName: usage } ], @@ -21064,6 +22046,7 @@ Represents a step in execution of a run. }, IsRequired: true, Summary: One of `server_error` or `rate_limit_exceeded`., + ParameterName: code, ArgumentName: code }, { @@ -21078,6 +22061,7 @@ Represents a step in execution of a run. }, IsRequired: true, Summary: A human-readable description of the error., + ParameterName: message, ArgumentName: message } ], @@ -21110,6 +22094,7 @@ Represents a step in execution of a run. }, IsRequired: false, Summary: , + ParameterName: serverError, ArgumentName: serverError }, { @@ -21124,6 +22109,7 @@ Represents a step in execution of a run. }, IsRequired: false, Summary: , + ParameterName: rateLimitExceeded, ArgumentName: rateLimitExceeded } ], @@ -21174,6 +22160,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: threadrunstep, ArgumentName: threadrunstep } ], @@ -21206,6 +22193,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: messageCreation, ArgumentName: messageCreation }, { @@ -21220,6 +22208,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: toolCalls, ArgumentName: toolCalls } ], @@ -21252,6 +22241,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: inProgress, ArgumentName: inProgress }, { @@ -21266,6 +22256,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: cancelled, ArgumentName: cancelled }, { @@ -21280,6 +22271,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: failed, ArgumentName: failed }, { @@ -21294,6 +22286,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: completed, ArgumentName: completed }, { @@ -21308,6 +22301,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: expired, ArgumentName: expired } ], @@ -21339,6 +22333,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The identifier of the run step, which can be referenced in API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -21357,6 +22352,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The object type, which is always `thread.run.step.delta`., + ParameterName: object, ArgumentName: object }, { @@ -21371,6 +22367,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The delta containing the fields that have changed on the run step., + ParameterName: delta, ArgumentName: delta } ], @@ -21404,6 +22401,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami }, IsRequired: false, Summary: The details of the run step., + ParameterName: stepDetails, ArgumentName: stepDetails } ], @@ -21452,6 +22450,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami }, IsRequired: false, Summary: , + ParameterName: threadrunstepdelta, ArgumentName: threadrunstepdelta } ], @@ -21484,6 +22483,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami IsRequired: true, Summary:
Example: list, + ParameterName: object, ArgumentName: object }, { @@ -21498,6 +22498,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data }, { @@ -21513,6 +22514,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami IsRequired: true, Summary:
Example: step_abc123, + ParameterName: firstId, ArgumentName: firstId }, { @@ -21528,6 +22530,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami IsRequired: true, Summary:
Example: step_abc456, + ParameterName: lastId, ArgumentName: lastId }, { @@ -21543,6 +22546,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami IsRequired: true, Summary:
Example: false, + ParameterName: hasMore, ArgumentName: hasMore } ], @@ -21578,6 +22582,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami }, IsRequired: true, Summary: Always `message_creation`., + ParameterName: type, ArgumentName: type }, { @@ -21592,6 +22597,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami }, IsRequired: true, Summary: , + ParameterName: messageCreation, ArgumentName: messageCreation } ], @@ -21623,6 +22629,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami }, IsRequired: true, Summary: The ID of the message that was created by this run step., + ParameterName: messageId, ArgumentName: messageId } ], @@ -21655,6 +22662,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami }, IsRequired: false, Summary: , + ParameterName: messageCreation, ArgumentName: messageCreation } ], @@ -21690,6 +22698,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami }, IsRequired: true, Summary: Always `message_creation`., + ParameterName: type, ArgumentName: type }, { @@ -21704,6 +22713,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami }, IsRequired: false, Summary: , + ParameterName: messageCreation, ArgumentName: messageCreation } ], @@ -21735,6 +22745,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami }, IsRequired: false, Summary: The ID of the message that was created by this run step., + ParameterName: messageId, ArgumentName: messageId } ], @@ -21767,6 +22778,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami }, IsRequired: false, Summary: , + ParameterName: messageCreation, ArgumentName: messageCreation } ], @@ -21802,6 +22814,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami }, IsRequired: true, Summary: Always `tool_calls`., + ParameterName: type, ArgumentName: type }, { @@ -21818,6 +22831,7 @@ Represents a run step delta i.e. any changed fields on a run step during streami Summary: An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`. , + ParameterName: toolCalls, ArgumentName: toolCalls } ], @@ -21850,6 +22864,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: toolCalls, ArgumentName: toolCalls } ], @@ -21885,6 +22900,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: Always `tool_calls`., + ParameterName: type, ArgumentName: type }, { @@ -21901,6 +22917,7 @@ An array of tool calls the run step was involved in. These can be associated wit Summary: An array of tool calls the run step was involved in. These can be associated with one of three types of tools: `code_interpreter`, `file_search`, or `function`. , + ParameterName: toolCalls, ArgumentName: toolCalls } ], @@ -21933,6 +22950,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: toolCalls, ArgumentName: toolCalls } ], @@ -21964,6 +22982,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The ID of the tool call., + ParameterName: id, ArgumentName: id }, { @@ -21982,6 +23001,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The type of tool call. This is always going to be `code_interpreter` for this type of tool call., + ParameterName: type, ArgumentName: type }, { @@ -21996,6 +23016,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The Code Interpreter tool call definition., + ParameterName: codeInterpreter, ArgumentName: codeInterpreter } ], @@ -22027,6 +23048,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The input to the Code Interpreter tool call., + ParameterName: input, ArgumentName: input }, { @@ -22041,6 +23063,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type., + ParameterName: outputs, ArgumentName: outputs } ], @@ -22089,6 +23112,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: codeInterpreter, ArgumentName: codeInterpreter } ], @@ -22120,6 +23144,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The index of the tool call in the tool calls array., + ParameterName: index, ArgumentName: index }, { @@ -22134,6 +23159,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The ID of the tool call., + ParameterName: id, ArgumentName: id }, { @@ -22152,6 +23178,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The type of tool call. This is always going to be `code_interpreter` for this type of tool call., + ParameterName: type, ArgumentName: type }, { @@ -22166,6 +23193,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The Code Interpreter tool call definition., + ParameterName: codeInterpreter, ArgumentName: codeInterpreter } ], @@ -22197,6 +23225,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The input to the Code Interpreter tool call., + ParameterName: input, ArgumentName: input }, { @@ -22211,6 +23240,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The outputs from the Code Interpreter tool call. Code Interpreter can output one or more items, including text (`logs`) or images (`image`). Each of these are represented by a different object type., + ParameterName: outputs, ArgumentName: outputs } ], @@ -22259,6 +23289,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: codeInterpreter, ArgumentName: codeInterpreter } ], @@ -22294,6 +23325,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: Always `logs`., + ParameterName: type, ArgumentName: type }, { @@ -22308,6 +23340,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The text output from the Code Interpreter tool call., + ParameterName: logs, ArgumentName: logs } ], @@ -22340,6 +23373,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: logs, ArgumentName: logs } ], @@ -22371,6 +23405,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The index of the output in the outputs array., + ParameterName: index, ArgumentName: index }, { @@ -22389,6 +23424,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: Always `logs`., + ParameterName: type, ArgumentName: type }, { @@ -22403,6 +23439,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The text output from the Code Interpreter tool call., + ParameterName: logs, ArgumentName: logs } ], @@ -22435,6 +23472,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: logs, ArgumentName: logs } ], @@ -22470,6 +23508,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: Always `image`., + ParameterName: type, ArgumentName: type }, { @@ -22484,6 +23523,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: , + ParameterName: image, ArgumentName: image } ], @@ -22515,6 +23555,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The [file](/docs/api-reference/files) ID of the image., + ParameterName: fileId, ArgumentName: fileId } ], @@ -22547,6 +23588,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: image, ArgumentName: image } ], @@ -22578,6 +23620,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The index of the output in the outputs array., + ParameterName: index, ArgumentName: index }, { @@ -22596,6 +23639,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: Always `image`., + ParameterName: type, ArgumentName: type }, { @@ -22610,6 +23654,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: image, ArgumentName: image } ], @@ -22641,6 +23686,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The [file](/docs/api-reference/files) ID of the image., + ParameterName: fileId, ArgumentName: fileId } ], @@ -22673,6 +23719,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: image, ArgumentName: image } ], @@ -22704,6 +23751,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The ID of the tool call object., + ParameterName: id, ArgumentName: id }, { @@ -22722,6 +23770,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The type of tool call. This is always going to be `file_search` for this type of tool call., + ParameterName: type, ArgumentName: type }, { @@ -22736,6 +23785,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: For now, this is always going to be an empty object., + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -22784,6 +23834,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -22815,6 +23866,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The index of the tool call in the tool calls array., + ParameterName: index, ArgumentName: index }, { @@ -22829,6 +23881,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The ID of the tool call object., + ParameterName: id, ArgumentName: id }, { @@ -22847,6 +23900,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The type of tool call. This is always going to be `file_search` for this type of tool call., + ParameterName: type, ArgumentName: type }, { @@ -22861,6 +23915,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: For now, this is always going to be an empty object., + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -22909,6 +23964,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: fileSearch, ArgumentName: fileSearch } ], @@ -22940,6 +23996,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The ID of the tool call object., + ParameterName: id, ArgumentName: id }, { @@ -22958,6 +24015,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The type of tool call. This is always going to be `function` for this type of tool call., + ParameterName: type, ArgumentName: type }, { @@ -22972,6 +24030,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The definition of the function that was called., + ParameterName: function, ArgumentName: function } ], @@ -23003,6 +24062,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The name of the function., + ParameterName: name, ArgumentName: name }, { @@ -23017,6 +24077,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The arguments passed to the function., + ParameterName: arguments, ArgumentName: arguments }, { @@ -23031,6 +24092,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet., + ParameterName: output, ArgumentName: output } ], @@ -23063,6 +24125,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -23094,6 +24157,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The index of the tool call in the tool calls array., + ParameterName: index, ArgumentName: index }, { @@ -23108,6 +24172,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The ID of the tool call object., + ParameterName: id, ArgumentName: id }, { @@ -23126,6 +24191,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The type of tool call. This is always going to be `function` for this type of tool call., + ParameterName: type, ArgumentName: type }, { @@ -23140,6 +24206,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The definition of the function that was called., + ParameterName: function, ArgumentName: function } ], @@ -23171,6 +24238,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The name of the function., + ParameterName: name, ArgumentName: name }, { @@ -23185,6 +24253,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The arguments passed to the function., + ParameterName: arguments, ArgumentName: arguments }, { @@ -23199,6 +24268,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The output of the function. This will be `null` if the outputs have not been [submitted](/docs/api-reference/runs/submitToolOutputs) yet., + ParameterName: output, ArgumentName: output } ], @@ -23231,6 +24301,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: function, ArgumentName: function } ], @@ -23266,6 +24337,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: Anchor timestamp after which the expiration policy applies. Supported anchors: `last_active_at`., + ParameterName: anchor, ArgumentName: anchor }, { @@ -23280,6 +24352,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The number of days after the anchor time that the vector store will expire., + ParameterName: days, ArgumentName: days } ], @@ -23312,6 +24385,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: , + ParameterName: lastActiveAt, ArgumentName: lastActiveAt } ], @@ -23343,6 +24417,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The identifier, which can be referenced in API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -23361,6 +24436,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The object type, which is always `vector_store`., + ParameterName: object, ArgumentName: object }, { @@ -23375,6 +24451,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the vector store was created., + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -23389,6 +24466,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The name of the vector store., + ParameterName: name, ArgumentName: name }, { @@ -23403,6 +24481,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The total number of bytes used by the files in the vector store., + ParameterName: usageBytes, ArgumentName: usageBytes }, { @@ -23417,6 +24496,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: , + ParameterName: fileCounts, ArgumentName: fileCounts }, { @@ -23439,6 +24519,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use., + ParameterName: status, ArgumentName: status }, { @@ -23456,6 +24537,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The expiration policy for a vector store., + ParameterName: expiresAfter, ArgumentName: expiresAfter }, { @@ -23470,6 +24552,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: false, Summary: The Unix timestamp (in seconds) for when the vector store will expire., + ParameterName: expiresAt, ArgumentName: expiresAt }, { @@ -23484,6 +24567,7 @@ An array of tool calls the run step was involved in. These can be associated wit }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the vector store was last active., + ParameterName: lastActiveAt, ArgumentName: lastActiveAt }, { @@ -23500,6 +24584,7 @@ An array of tool calls the run step was involved in. These can be associated wit Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -23531,6 +24616,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The number of files that are currently being processed., + ParameterName: inProgress, ArgumentName: inProgress }, { @@ -23545,6 +24631,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The number of files that have been successfully processed., + ParameterName: completed, ArgumentName: completed }, { @@ -23559,6 +24646,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The number of files that have failed to process., + ParameterName: failed, ArgumentName: failed }, { @@ -23573,6 +24661,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The number of files that were cancelled., + ParameterName: cancelled, ArgumentName: cancelled }, { @@ -23587,6 +24676,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The total number of files., + ParameterName: total, ArgumentName: total } ], @@ -23637,6 +24727,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: vectorStore, ArgumentName: vectorStore } ], @@ -23669,6 +24760,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: expired, ArgumentName: expired }, { @@ -23683,6 +24775,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: inProgress, ArgumentName: inProgress }, { @@ -23697,6 +24790,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: completed, ArgumentName: completed } ], @@ -23728,6 +24822,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files., + ParameterName: fileIds, ArgumentName: fileIds }, { @@ -23742,6 +24837,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The name of the vector store., + ParameterName: name, ArgumentName: name }, { @@ -23759,6 +24855,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The expiration policy for a vector store., + ParameterName: expiresAfter, ArgumentName: expiresAfter }, { @@ -23775,6 +24872,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -23824,6 +24922,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The name of the vector store., + ParameterName: name, ArgumentName: name }, { @@ -23841,6 +24940,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The expiration policy for a vector store., + ParameterName: expiresAfter, ArgumentName: expiresAfter }, { @@ -23857,6 +24957,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -23907,6 +25008,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: list, + ParameterName: object, ArgumentName: object }, { @@ -23921,6 +25023,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data }, { @@ -23936,6 +25039,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: vs_abc123, + ParameterName: firstId, ArgumentName: firstId }, { @@ -23951,6 +25055,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: vs_abc456, + ParameterName: lastId, ArgumentName: lastId }, { @@ -23966,6 +25071,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: false, + ParameterName: hasMore, ArgumentName: hasMore } ], @@ -23997,6 +25103,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -24011,6 +25118,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: deleted, ArgumentName: deleted }, { @@ -24029,6 +25137,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object } ], @@ -24061,6 +25170,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: vectorStoredeleted, ArgumentName: vectorStoredeleted } ], @@ -24092,6 +25202,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The identifier, which can be referenced in API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -24110,6 +25221,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The object type, which is always `vector_store.file`., + ParameterName: object, ArgumentName: object }, { @@ -24124,6 +25236,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The total vector store usage in bytes. Note that this may be different from the original file size., + ParameterName: usageBytes, ArgumentName: usageBytes }, { @@ -24138,6 +25251,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the vector store file was created., + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -24152,6 +25266,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The ID of the [vector store](/docs/api-reference/vector-stores/object) that the [File](/docs/api-reference/files) is attached to., + ParameterName: vectorStoreId, ArgumentName: vectorStoreId }, { @@ -24176,6 +25291,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use., + ParameterName: status, ArgumentName: status }, { @@ -24190,6 +25306,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The last error associated with this vector store file. Will be `null` if there are no errors., + ParameterName: lastError, ArgumentName: lastError } ], @@ -24231,6 +25348,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: One of `server_error` or `rate_limit_exceeded`., + ParameterName: code, ArgumentName: code }, { @@ -24245,6 +25363,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: A human-readable description of the error., + ParameterName: message, ArgumentName: message } ], @@ -24277,6 +25396,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: internalError, ArgumentName: internalError }, { @@ -24291,6 +25411,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: fileNotFound, ArgumentName: fileNotFound }, { @@ -24305,6 +25426,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: parsingError, ArgumentName: parsingError }, { @@ -24319,6 +25441,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: unhandledMimeType, ArgumentName: unhandledMimeType } ], @@ -24351,6 +25474,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: vectorStorefile, ArgumentName: vectorStorefile } ], @@ -24383,6 +25507,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: inProgress, ArgumentName: inProgress }, { @@ -24397,6 +25522,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: completed, ArgumentName: completed }, { @@ -24411,6 +25537,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: cancelled, ArgumentName: cancelled }, { @@ -24425,6 +25552,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: failed, ArgumentName: failed } ], @@ -24456,6 +25584,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: A [File](/docs/api-reference/files) ID that the vector store should use. Useful for tools like `file_search` that can access files., + ParameterName: fileId, ArgumentName: fileId } ], @@ -24488,6 +25617,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: list, + ParameterName: object, ArgumentName: object }, { @@ -24502,6 +25632,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data }, { @@ -24517,6 +25648,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: file-abc123, + ParameterName: firstId, ArgumentName: firstId }, { @@ -24532,6 +25664,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: file-abc456, + ParameterName: lastId, ArgumentName: lastId }, { @@ -24547,6 +25680,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: true, Summary:
Example: false, + ParameterName: hasMore, ArgumentName: hasMore } ], @@ -24578,6 +25712,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -24592,6 +25727,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: deleted, ArgumentName: deleted }, { @@ -24610,6 +25746,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object } ], @@ -24642,6 +25779,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: vectorStorefiledeleted, ArgumentName: vectorStorefiledeleted } ], @@ -24673,6 +25811,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The identifier, which can be referenced in API endpoints., + ParameterName: id, ArgumentName: id }, { @@ -24691,6 +25830,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The object type, which is always `vector_store.file_batch`., + ParameterName: object, ArgumentName: object }, { @@ -24705,6 +25845,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the vector store files batch was created., + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -24719,6 +25860,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The ID of the [vector store](/docs/api-reference/vector-stores/object) that the [File](/docs/api-reference/files) is attached to., + ParameterName: vectorStoreId, ArgumentName: vectorStoreId }, { @@ -24743,6 +25885,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The status of the vector store files batch, which can be either `in_progress`, `completed`, `cancelled` or `failed`., + ParameterName: status, ArgumentName: status }, { @@ -24757,6 +25900,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: fileCounts, ArgumentName: fileCounts } ], @@ -24788,6 +25932,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The number of files that are currently being processed., + ParameterName: inProgress, ArgumentName: inProgress }, { @@ -24802,6 +25947,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The number of files that have been processed., + ParameterName: completed, ArgumentName: completed }, { @@ -24816,6 +25962,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The number of files that have failed to process., + ParameterName: failed, ArgumentName: failed }, { @@ -24830,6 +25977,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The number of files that where cancelled., + ParameterName: cancelled, ArgumentName: cancelled }, { @@ -24844,6 +25992,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: The total number of files., + ParameterName: total, ArgumentName: total } ], @@ -24876,6 +26025,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: vectorStorefilesBatch, ArgumentName: vectorStorefilesBatch } ], @@ -24908,6 +26058,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: inProgress, ArgumentName: inProgress }, { @@ -24922,6 +26073,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: completed, ArgumentName: completed }, { @@ -24936,6 +26088,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: cancelled, ArgumentName: cancelled }, { @@ -24950,6 +26103,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: failed, ArgumentName: failed } ], @@ -24981,6 +26135,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: A list of [File](/docs/api-reference/files) IDs that the vector store should use. Useful for tools like `file_search` that can access files., + ParameterName: fileIds, ArgumentName: fileIds } ], @@ -25116,6 +26271,7 @@ integrate the Assistants API with streaming. }, IsRequired: true, Summary: , + ParameterName: @event, ArgumentName: @event }, { @@ -25135,6 +26291,7 @@ integrate the Assistants API with streaming. }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data } ], @@ -25167,6 +26324,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: , + ParameterName: error, ArgumentName: error } ], @@ -25202,6 +26360,7 @@ integrate the Assistants API with streaming. }, IsRequired: true, Summary: , + ParameterName: @event, ArgumentName: @event }, { @@ -25220,6 +26379,7 @@ integrate the Assistants API with streaming. }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data } ], @@ -25252,6 +26412,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: , + ParameterName: done, ArgumentName: done } ], @@ -25284,6 +26445,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: , + ParameterName: dONE, ArgumentName: dONE } ], @@ -25315,6 +26477,7 @@ integrate the Assistants API with streaming. }, IsRequired: true, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -25333,6 +26496,7 @@ integrate the Assistants API with streaming. }, IsRequired: true, Summary: The object type, which is always `batch`., + ParameterName: object, ArgumentName: object }, { @@ -25347,6 +26511,7 @@ integrate the Assistants API with streaming. }, IsRequired: true, Summary: The OpenAI API endpoint used by the batch., + ParameterName: endpoint, ArgumentName: endpoint }, { @@ -25361,6 +26526,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: , + ParameterName: errors, ArgumentName: errors }, { @@ -25375,6 +26541,7 @@ integrate the Assistants API with streaming. }, IsRequired: true, Summary: The ID of the input file for the batch., + ParameterName: inputFileId, ArgumentName: inputFileId }, { @@ -25389,6 +26556,7 @@ integrate the Assistants API with streaming. }, IsRequired: true, Summary: The time frame within which the batch should be processed., + ParameterName: completionWindow, ArgumentName: completionWindow }, { @@ -25421,6 +26589,7 @@ integrate the Assistants API with streaming. }, IsRequired: true, Summary: The current status of the batch., + ParameterName: status, ArgumentName: status }, { @@ -25435,6 +26604,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: The ID of the file containing the outputs of successfully executed requests., + ParameterName: outputFileId, ArgumentName: outputFileId }, { @@ -25449,6 +26619,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: The ID of the file containing the outputs of requests with errors., + ParameterName: errorFileId, ArgumentName: errorFileId }, { @@ -25463,6 +26634,7 @@ integrate the Assistants API with streaming. }, IsRequired: true, Summary: The Unix timestamp (in seconds) for when the batch was created., + ParameterName: createdAt, ArgumentName: createdAt }, { @@ -25477,6 +26649,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: The Unix timestamp (in seconds) for when the batch started processing., + ParameterName: inProgressAt, ArgumentName: inProgressAt }, { @@ -25491,6 +26664,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: The Unix timestamp (in seconds) for when the batch will expire., + ParameterName: expiresAt, ArgumentName: expiresAt }, { @@ -25505,6 +26679,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: The Unix timestamp (in seconds) for when the batch started finalizing., + ParameterName: finalizingAt, ArgumentName: finalizingAt }, { @@ -25519,6 +26694,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: The Unix timestamp (in seconds) for when the batch was completed., + ParameterName: completedAt, ArgumentName: completedAt }, { @@ -25533,6 +26709,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: The Unix timestamp (in seconds) for when the batch failed., + ParameterName: failedAt, ArgumentName: failedAt }, { @@ -25547,6 +26724,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: The Unix timestamp (in seconds) for when the batch expired., + ParameterName: expiredAt, ArgumentName: expiredAt }, { @@ -25561,6 +26739,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: The Unix timestamp (in seconds) for when the batch started cancelling., + ParameterName: cancellingAt, ArgumentName: cancellingAt }, { @@ -25575,6 +26754,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: The Unix timestamp (in seconds) for when the batch was cancelled., + ParameterName: cancelledAt, ArgumentName: cancelledAt }, { @@ -25589,6 +26769,7 @@ integrate the Assistants API with streaming. }, IsRequired: false, Summary: The request counts for different statuses within the batch., + ParameterName: requestCounts, ArgumentName: requestCounts }, { @@ -25605,6 +26786,7 @@ integrate the Assistants API with streaming. Summary: Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maxium of 512 characters long. , + ParameterName: metadata, ArgumentName: metadata } ], @@ -25636,6 +26818,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The object type, which is always `list`., + ParameterName: object, ArgumentName: object }, { @@ -25650,6 +26833,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: data, ArgumentName: data } ], @@ -25681,6 +26865,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: An error code identifying the error type., + ParameterName: code, ArgumentName: code }, { @@ -25695,6 +26880,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: A human-readable message providing more details about the error., + ParameterName: message, ArgumentName: message }, { @@ -25709,6 +26895,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The name of the parameter that caused the error, if applicable., + ParameterName: param, ArgumentName: param }, { @@ -25723,6 +26910,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The line number of the input file where the error occurred, if applicable., + ParameterName: line, ArgumentName: line } ], @@ -25754,6 +26942,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: Total number of requests in the batch., + ParameterName: total, ArgumentName: total }, { @@ -25768,6 +26957,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: Number of requests that have been completed successfully., + ParameterName: completed, ArgumentName: completed }, { @@ -25782,6 +26972,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: Number of requests that have failed., + ParameterName: failed, ArgumentName: failed } ], @@ -25832,6 +27023,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: batch, ArgumentName: batch } ], @@ -25864,6 +27056,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: validating, ArgumentName: validating }, { @@ -25878,6 +27071,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: failed, ArgumentName: failed }, { @@ -25892,6 +27086,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: inProgress, ArgumentName: inProgress }, { @@ -25906,6 +27101,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: finalizing, ArgumentName: finalizing }, { @@ -25920,6 +27116,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: completed, ArgumentName: completed }, { @@ -25934,6 +27131,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: expired, ArgumentName: expired }, { @@ -25948,6 +27146,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: cancelling, ArgumentName: cancelling }, { @@ -25962,6 +27161,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: cancelled, ArgumentName: cancelled } ], @@ -25993,6 +27193,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: A developer-provided per-request id that will be used to match outputs to inputs. Must be unique for each request in a batch., + ParameterName: customId, ArgumentName: customId }, { @@ -26011,6 +27212,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The HTTP method to be used for the request. Currently only `POST` is supported., + ParameterName: method, ArgumentName: method }, { @@ -26025,6 +27227,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The OpenAI API relative URL to be used for the request. Currently `/v1/chat/completions` and `/v1/embeddings` are supported., + ParameterName: url, ArgumentName: url } ], @@ -26057,6 +27260,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: pOST, ArgumentName: pOST } ], @@ -26088,6 +27292,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: id, ArgumentName: id }, { @@ -26102,6 +27307,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: A developer-provided per-request id that will be used to match outputs to inputs., + ParameterName: customId, ArgumentName: customId }, { @@ -26116,6 +27322,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: response, ArgumentName: response }, { @@ -26130,6 +27337,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: For requests that failed with a non-HTTP error, this will contain more information on the cause of the failure., + ParameterName: error, ArgumentName: error } ], @@ -26161,6 +27369,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The HTTP status code of the response, + ParameterName: statusCode, ArgumentName: statusCode }, { @@ -26175,6 +27384,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: An unique identifier for the OpenAI API request. Please include this request ID when contacting support., + ParameterName: requestId, ArgumentName: requestId }, { @@ -26189,6 +27399,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: The JSON body of the response, + ParameterName: body, ArgumentName: body } ], @@ -26236,6 +27447,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: A machine-readable error code., + ParameterName: code, ArgumentName: code }, { @@ -26250,6 +27462,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: A human-readable error message., + ParameterName: message, ArgumentName: message } ], @@ -26281,6 +27494,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: data, ArgumentName: data }, { @@ -26296,6 +27510,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: false, Summary:
Example: batch_abc123, + ParameterName: firstId, ArgumentName: firstId }, { @@ -26311,6 +27526,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful IsRequired: false, Summary:
Example: batch_abc456, + ParameterName: lastId, ArgumentName: lastId }, { @@ -26325,6 +27541,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: hasMore, ArgumentName: hasMore }, { @@ -26343,6 +27560,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: true, Summary: , + ParameterName: object, ArgumentName: object } ], @@ -26375,6 +27593,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: list, ArgumentName: list } ], @@ -26407,6 +27626,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: asc, ArgumentName: asc }, { @@ -26421,6 +27641,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: desc, ArgumentName: desc } ], @@ -26454,6 +27675,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: asc, ArgumentName: asc }, { @@ -26468,6 +27690,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: desc, ArgumentName: desc } ], @@ -26501,6 +27724,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: asc, ArgumentName: asc }, { @@ -26515,6 +27739,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: desc, ArgumentName: desc } ], @@ -26548,6 +27773,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: asc, ArgumentName: asc }, { @@ -26562,6 +27788,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: desc, ArgumentName: desc } ], @@ -26595,6 +27822,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: asc, ArgumentName: asc }, { @@ -26609,6 +27837,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: desc, ArgumentName: desc } ], @@ -26642,6 +27871,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: asc, ArgumentName: asc }, { @@ -26656,6 +27886,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: desc, ArgumentName: desc } ], @@ -26689,6 +27920,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: inProgress, ArgumentName: inProgress }, { @@ -26703,6 +27935,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: completed, ArgumentName: completed }, { @@ -26717,6 +27950,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: failed, ArgumentName: failed }, { @@ -26731,6 +27965,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: cancelled, ArgumentName: cancelled } ], @@ -26763,6 +27998,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: asc, ArgumentName: asc }, { @@ -26777,6 +28013,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: desc, ArgumentName: desc } ], @@ -26810,6 +28047,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: inProgress, ArgumentName: inProgress }, { @@ -26824,6 +28062,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: completed, ArgumentName: completed }, { @@ -26838,6 +28077,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: failed, ArgumentName: failed }, { @@ -26852,6 +28092,7 @@ Set of 16 key-value pairs that can be attached to an object. This can be useful }, IsRequired: false, Summary: , + ParameterName: cancelled, ArgumentName: cancelled } ], diff --git a/src/tests/OpenApiGenerator.UnitTests/Snapshots/Replicate/_.verified.txt b/src/tests/OpenApiGenerator.UnitTests/Snapshots/Replicate/_.verified.txt index fcbdfd0216..ed613f18b1 100644 --- a/src/tests/OpenApiGenerator.UnitTests/Snapshots/Replicate/_.verified.txt +++ b/src/tests/OpenApiGenerator.UnitTests/Snapshots/Replicate/_.verified.txt @@ -35,6 +35,7 @@ Use a data URL when: - you don't want to upload and host the file somewhere - you don't need to use the file again (Replicate will not store it) , + ParameterName: input, ArgumentName: input }, { @@ -53,6 +54,7 @@ Request a URL to receive streaming output using [server-sent events (SSE)](https If the requested model version supports streaming, the returned prediction will have a `stream` entry in its `urls` property with an HTTPS URL that you can use to construct an [`EventSource`](https://developer.mozilla.org/en-US/docs/Web/API/EventSource). , + ParameterName: stream, ArgumentName: stream }, { @@ -69,6 +71,7 @@ If the requested model version supports streaming, the returned prediction will Summary: An HTTPS URL for receiving a webhook when the prediction has new output. The webhook will be a POST request where the request body is the same as the response body of the [get prediction](#predictions.get) operation. If there are network problems, we will retry the webhook a few times, so make sure it can be safely called more than once. Replicate will not follow redirects when sending webhook requests to your service, so be sure to specify a URL that will resolve without redirecting. , + ParameterName: webhook, ArgumentName: webhook }, { @@ -104,6 +107,7 @@ For example, if you only wanted requests to be sent at the start and end of the Requests for event types `output` and `logs` will be sent at most once every 500ms. If you request `start` and `completed` webhooks, then they'll always be sent regardless of throttling. , + ParameterName: webhookEventsFilter, ArgumentName: webhookEventsFilter } ], @@ -169,6 +173,7 @@ Use a data URL when: Summary: A string representing the desired model to push to in the format `{destination_model_owner}/{destination_model_name}`. This should be an existing model owned by the user or organization making the API request. If the destination is invalid, the server will return an appropriate 4XX response. , + ParameterName: destination, ArgumentName: destination }, { @@ -185,6 +190,7 @@ A string representing the desired model to push to in the format `{destination_m Summary: An object containing inputs to the Cog model's `train()` function. , + ParameterName: input, ArgumentName: input }, { @@ -199,6 +205,7 @@ An object containing inputs to the Cog model's `train()` function. }, IsRequired: false, Summary: An HTTPS URL for receiving a webhook when the training completes. The webhook will be a POST request where the request body is the same as the response body of the [get training](#trainings.get) operation. If there are network problems, we will retry the webhook a few times, so make sure it can be safely called more than once. Replicate will not follow redirects when sending webhook requests to your service, so be sure to specify a URL that will resolve without redirecting., + ParameterName: webhook, ArgumentName: webhook }, { @@ -235,6 +242,7 @@ For example, if you only wanted requests to be sent at the start and end of the Requests for event types `output` and `logs` will be sent at most once every 500ms. If you request `start` and `completed` webhooks, then they'll always be sent regardless of throttling. , + ParameterName: webhookEventsFilter, ArgumentName: webhookEventsFilter } ], @@ -300,6 +308,7 @@ Use a data URL when: - you don't want to upload and host the file somewhere - you don't need to use the file again (Replicate will not store it) , + ParameterName: input, ArgumentName: input }, { @@ -318,6 +327,7 @@ Request a URL to receive streaming output using [server-sent events (SSE)](https If the requested model version supports streaming, the returned prediction will have a `stream` entry in its `urls` property with an HTTPS URL that you can use to construct an [`EventSource`](https://developer.mozilla.org/en-US/docs/Web/API/EventSource). , + ParameterName: stream, ArgumentName: stream }, { @@ -332,6 +342,7 @@ If the requested model version supports streaming, the returned prediction will }, IsRequired: true, Summary: The ID of the model version that you want to run., + ParameterName: version, ArgumentName: version }, { @@ -348,6 +359,7 @@ If the requested model version supports streaming, the returned prediction will Summary: An HTTPS URL for receiving a webhook when the prediction has new output. The webhook will be a POST request where the request body is the same as the response body of the [get prediction](#predictions.get) operation. If there are network problems, we will retry the webhook a few times, so make sure it can be safely called more than once. Replicate will not follow redirects when sending webhook requests to your service, so be sure to specify a URL that will resolve without redirecting. , + ParameterName: webhook, ArgumentName: webhook }, { @@ -384,6 +396,7 @@ For example, if you only wanted requests to be sent at the start and end of the Requests for event types `output` and `logs` will be sent at most once every 500ms. If you request `start` and `completed` webhooks, then they'll always be sent regardless of throttling. , + ParameterName: webhookEventsFilter, ArgumentName: webhookEventsFilter } ],