diff options
Diffstat (limited to 'doc/api/graphql/reference')
| -rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 77 | ||||
| -rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 233 | ||||
| -rw-r--r-- | doc/api/graphql/reference/index.md | 12 |
3 files changed, 298 insertions, 24 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index a08e9284234..b7fdf52dca0 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -1093,6 +1093,77 @@ type ApiFuzzingCiConfiguration { } """ +Autogenerated input type of ApiFuzzingCiConfigurationCreate +""" +input ApiFuzzingCiConfigurationCreateInput { + """ + File path or URL to the file that defines the API surface for scanning. Must + be in the format specified by the `scanMode` argument. + """ + apiSpecificationFile: String! + + """ + CI variable containing the password for authenticating with the target API. + """ + authPassword: String + + """ + CI variable containing the username for authenticating with the target API. + """ + authUsername: String + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Full path of the project. + """ + projectPath: ID! + + """ + The mode for API fuzzing scans. + """ + scanMode: ApiFuzzingScanMode! + + """ + Name of a default profile to use for scanning. Ex: Quick-10. + """ + scanProfile: String + + """ + URL for the target of API fuzzing scans. + """ + target: String! +} + +""" +Autogenerated return type of ApiFuzzingCiConfigurationCreate +""" +type ApiFuzzingCiConfigurationCreatePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + A YAML snippet that can be inserted into the project's `.gitlab-ci.yml` to set up API fuzzing scans. + """ + configurationYaml: String + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! + + """ + The location at which the project's `.gitlab-ci.yml` file can be edited in the browser. + """ + gitlabCiYamlEditPath: String +} + +""" All possible ways to specify the API surface for an API fuzzing scan """ enum ApiFuzzingScanMode { @@ -16698,6 +16769,7 @@ type Mutation { adminSidekiqQueuesDeleteJobs(input: AdminSidekiqQueuesDeleteJobsInput!): AdminSidekiqQueuesDeleteJobsPayload alertSetAssignees(input: AlertSetAssigneesInput!): AlertSetAssigneesPayload alertTodoCreate(input: AlertTodoCreateInput!): AlertTodoCreatePayload + apiFuzzingCiConfigurationCreate(input: ApiFuzzingCiConfigurationCreateInput!): ApiFuzzingCiConfigurationCreatePayload awardEmojiAdd(input: AwardEmojiAddInput!): AwardEmojiAddPayload awardEmojiRemove(input: AwardEmojiRemoveInput!): AwardEmojiRemovePayload awardEmojiToggle(input: AwardEmojiToggleInput!): AwardEmojiTogglePayload @@ -18566,11 +18638,6 @@ type Pipeline { Permissions for the current user on the resource """ userPermissions: PipelinePermissions! - - """ - Indicates if a pipeline has warnings. - """ - warnings: Boolean! } type PipelineAnalytics { diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index e380ea3d0d5..0bf3042044c 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -2736,6 +2736,194 @@ "possibleTypes": null }, { + "kind": "INPUT_OBJECT", + "name": "ApiFuzzingCiConfigurationCreateInput", + "description": "Autogenerated input type of ApiFuzzingCiConfigurationCreate", + "fields": null, + "inputFields": [ + { + "name": "projectPath", + "description": "Full path of the project.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "apiSpecificationFile", + "description": "File path or URL to the file that defines the API surface for scanning. Must be in the format specified by the `scanMode` argument.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "authPassword", + "description": "CI variable containing the password for authenticating with the target API.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "authUsername", + "description": "CI variable containing the username for authenticating with the target API.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "scanMode", + "description": "The mode for API fuzzing scans.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ApiFuzzingScanMode", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "scanProfile", + "description": "Name of a default profile to use for scanning. Ex: Quick-10.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "target", + "description": "URL for the target of API fuzzing scans.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ApiFuzzingCiConfigurationCreatePayload", + "description": "Autogenerated return type of ApiFuzzingCiConfigurationCreate", + "fields": [ + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "configurationYaml", + "description": "A YAML snippet that can be inserted into the project's `.gitlab-ci.yml` to set up API fuzzing scans.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "Errors encountered during execution of the mutation.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gitlabCiYamlEditPath", + "description": "The location at which the project's `.gitlab-ci.yml` file can be edited in the browser.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "ENUM", "name": "ApiFuzzingScanMode", "description": "All possible ways to specify the API surface for an API fuzzing scan", @@ -45814,6 +46002,33 @@ "deprecationReason": null }, { + "name": "apiFuzzingCiConfigurationCreate", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ApiFuzzingCiConfigurationCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ApiFuzzingCiConfigurationCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "awardEmojiAdd", "description": null, "args": [ @@ -54399,24 +54614,6 @@ }, "isDeprecated": false, "deprecationReason": null - }, - { - "name": "warnings", - "description": "Indicates if a pipeline has warnings.", - "args": [ - - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Boolean", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null } ], "inputFields": null, diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index df31b6f1dd0..9c2d28ed743 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -191,6 +191,17 @@ Data associated with configuring API fuzzing scans in GitLab CI. | `scanModes` | ApiFuzzingScanMode! => Array | All available scan modes. | | `scanProfiles` | ApiFuzzingScanProfile! => Array | All default scan profiles. | +### ApiFuzzingCiConfigurationCreatePayload + +Autogenerated return type of ApiFuzzingCiConfigurationCreate. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `configurationYaml` | String | A YAML snippet that can be inserted into the project's `.gitlab-ci.yml` to set up API fuzzing scans. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `gitlabCiYamlEditPath` | String | The location at which the project's `.gitlab-ci.yml` file can be edited in the browser. | + ### ApiFuzzingScanProfile An API Fuzzing scan profile.. @@ -2807,7 +2818,6 @@ Information about pagination in a connection.. | `upstream` | Pipeline | Pipeline that triggered the pipeline. | | `user` | User | Pipeline user. | | `userPermissions` | PipelinePermissions! | Permissions for the current user on the resource | -| `warnings` | Boolean! | Indicates if a pipeline has warnings. | ### PipelineAnalytics |