mirror of
https://github.com/n8n-io/n8n-docs.git
synced 2026-03-27 09:28:43 +07:00
chore: Update Public API schema (#4052)
Co-authored-by: ivov <44588767+ivov@users.noreply.github.com> Co-authored-by: Kartik Balasubramanian <22399046+HumanistSerif@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
d9f4c0024e
commit
fc30ab6575
@@ -105,6 +105,41 @@ paths:
|
||||
'415':
|
||||
description: Unsupported media type.
|
||||
/credentials/{id}:
|
||||
patch:
|
||||
x-eov-operation-id: updateCredential
|
||||
x-eov-operation-handler: v1/handlers/credentials/credentials.handler
|
||||
tags:
|
||||
- Credential
|
||||
summary: Update credential by ID
|
||||
description: Updates an existing credential. You must be the owner of the credential.
|
||||
operationId: updateCredential
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The credential ID that needs to be updated
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
description: Credential data to update. All fields are optional.
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/update-credential-request'
|
||||
responses:
|
||||
'200':
|
||||
description: Operation successful.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/create-credential-response'
|
||||
'400':
|
||||
description: Bad request - invalid credential type or data.
|
||||
'401':
|
||||
$ref: '#/components/responses/unauthorized'
|
||||
'404':
|
||||
$ref: '#/components/responses/notFound'
|
||||
delete:
|
||||
x-eov-operation-id: deleteCredential
|
||||
x-eov-operation-handler: v1/handlers/credentials/credentials.handler
|
||||
@@ -1424,6 +1459,36 @@ components:
|
||||
format: date-time
|
||||
readOnly: true
|
||||
example: '2022-04-29T11:02:29.842Z'
|
||||
update-credential-request:
|
||||
type: object
|
||||
properties:
|
||||
name:
|
||||
type: string
|
||||
example: Updated Credential Name
|
||||
description: The name of the credential
|
||||
type:
|
||||
type: string
|
||||
example: githubApi
|
||||
description: The credential type. If changing type, data must also be provided.
|
||||
data:
|
||||
type: object
|
||||
writeOnly: true
|
||||
example:
|
||||
accessToken: new_token_value
|
||||
description: The credential data. Required when changing credential type.
|
||||
isGlobal:
|
||||
type: boolean
|
||||
example: false
|
||||
description: Whether this credential is available globally
|
||||
isResolvable:
|
||||
type: boolean
|
||||
example: false
|
||||
description: Whether this credential has resolvable fields
|
||||
isPartialData:
|
||||
type: boolean
|
||||
example: false
|
||||
default: false
|
||||
description: If true, unredacts and merges existing credential data with the provided data. If false, replaces the entire data object.
|
||||
execution:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Reference in New Issue
Block a user