v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1316192184.4 KB
projects

Creates a new note.

post/v1/{+parent}/notes

Path parameters

parentstring required

Required. The name of the project in the form of projects/[PROJECT_ID], under which the note is to be created.

Query parameters

noteIdstring

Required. The ID to use for this note.

Request body

kind'NOTE_KIND_UNSPECIFIED' | 'VULNERABILITY' | 'BUILD' | 'IMAGE' | 'PACKAGE' | 'DEPLOYMENT' | 'DISCOVERY' | 'ATTESTATION' | 'UPGRADE' | 'COMPLIANCE' | 'DSSE_ATTESTATION' | 'VULNERABILITY_ASSESSMENT' | 'SBOM_REFERENCE' | 'SECRET' | 'AI_SKILL_ANALYSIS'

Output only. The type of analysis. This field can be used as a filter in list requests.

expirationTimestring google-datetime

Time of expiration for this note. Empty if note does not expire.

namestring

Output only. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].

secretSecretNote

The note representing a secret.

longDescriptionstring

A detailed description of this note.

relatedNoteNamesstring[]

Other notes related to this note.

aiSkillAnalysisAISkillAnalysisNote

AISkillAnalysisNote provides the metadata of an AI-based skill analysis.

updateTimestring google-datetime

Output only. The time this note was last updated. This field can be used as a filter in list requests.

createTimestring google-datetime

Output only. The time this note was created. This field can be used as a filter in list requests.

shortDescriptionstring

A one sentence description of this note.

Response

Successful response