Last active
April 24, 2025 14:44
-
-
Save jiparis/17705b9a8ff9f3b4a748b09b2c8a9fdb to your computer and use it in GitHub Desktop.
swagger.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| openapi: 3.0.1 | |
| info: | |
| title: Chainloop Platform API | |
| contact: | |
| name: Chainloop | |
| url: https://chainloop.dev | |
| email: [email protected] | |
| version: "1.0" | |
| servers: | |
| - url: / | |
| tags: | |
| - name: EvidenceService | |
| - name: StatusService | |
| paths: | |
| /infoz: | |
| get: | |
| tags: | |
| - StatusService | |
| operationId: StatusService_Infoz | |
| responses: | |
| "200": | |
| description: A successful response. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/v1InfozResponse' | |
| default: | |
| description: An unexpected error response. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/rpcStatus' | |
| /statusz: | |
| get: | |
| tags: | |
| - StatusService | |
| operationId: StatusService_Statusz | |
| parameters: | |
| - name: readiness | |
| in: query | |
| description: |- | |
| Parameter that can be used by readiness probes | |
| The main difference is that readiness probes will take into account that all | |
| dependent services are up and ready | |
| schema: | |
| type: boolean | |
| responses: | |
| "200": | |
| description: A successful response. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/v1StatuszResponse' | |
| default: | |
| description: An unexpected error response. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/rpcStatus' | |
| /v1/evidence: | |
| get: | |
| tags: | |
| - EvidenceService | |
| summary: List | |
| description: List all evidence for the organization in the authentication token. | |
| operationId: EvidenceService_List | |
| parameters: | |
| - name: projectName | |
| in: query | |
| description: ProjectName is the name of the project to filter by | |
| schema: | |
| type: string | |
| - name: projectVersionName | |
| in: query | |
| description: ProjectVersionName is the name of the project version to filter | |
| by | |
| schema: | |
| type: string | |
| - name: kind | |
| in: query | |
| description: Kind is the type of evidence to filter by | |
| style: form | |
| explode: true | |
| schema: | |
| type: array | |
| items: | |
| type: string | |
| enum: | |
| - MATERIAL_TYPE_UNSPECIFIED | |
| - STRING | |
| - CONTAINER_IMAGE | |
| - ARTIFACT | |
| - SBOM_CYCLONEDX_JSON | |
| - SBOM_SPDX_JSON | |
| - JUNIT_XML | |
| - OPENVEX | |
| - HELM_CHART | |
| - SARIF | |
| - EVIDENCE | |
| - ATTESTATION | |
| - CSAF_VEX | |
| - CSAF_INFORMATIONAL_ADVISORY | |
| - CSAF_SECURITY_ADVISORY | |
| - CSAF_SECURITY_INCIDENT_RESPONSE | |
| - GITLAB_SECURITY_REPORT | |
| - ZAP_DAST_ZIP | |
| - BLACKDUCK_SCA_JSON | |
| - TWISTCLI_SCAN_JSON | |
| - GHAS_CODE_SCAN | |
| - GHAS_SECRET_SCAN | |
| - GHAS_DEPENDENCY_SCAN | |
| - JACOCO_XML | |
| - SLSA_PROVENANCE | |
| - name: pagination.cursor | |
| in: query | |
| description: The cursor to start pagination from | |
| schema: | |
| type: string | |
| - name: pagination.limit | |
| in: query | |
| description: The limit of the number of entries to return | |
| schema: | |
| type: integer | |
| format: int32 | |
| responses: | |
| "200": | |
| description: A successful response. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/v1EvidenceServiceListResponse' | |
| default: | |
| description: An unexpected error response. | |
| content: | |
| application/json: | |
| schema: | |
| $ref: '#/components/schemas/rpcStatus' | |
| components: | |
| schemas: | |
| protobufAny: | |
| type: object | |
| properties: | |
| '@type': | |
| type: string | |
| additionalProperties: | |
| type: object | |
| rpcStatus: | |
| type: object | |
| properties: | |
| code: | |
| type: integer | |
| format: int32 | |
| message: | |
| type: string | |
| details: | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/protobufAny' | |
| v1CursorPaginationRequest: | |
| title: CursorPaginationRequest is used to paginate the results in a cursor-based | |
| way | |
| type: object | |
| properties: | |
| cursor: | |
| title: The cursor to start pagination from | |
| type: string | |
| limit: | |
| title: The limit of the number of entries to return | |
| type: integer | |
| format: int32 | |
| v1CursorPaginationResponse: | |
| title: CursorPaginationResponse is used to return the pagination information | |
| in a cursor-based way | |
| type: object | |
| properties: | |
| nextCursor: | |
| title: The next cursor to start pagination from | |
| type: string | |
| v1EvidenceListItem: | |
| title: EvidenceListItem is an item in the list of evidence | |
| type: object | |
| properties: | |
| id: | |
| title: ID is the unique identifier of the evidence | |
| type: string | |
| name: | |
| title: Name is the name of the evidence | |
| type: string | |
| digest: | |
| title: Digest is the digest of the evidence | |
| type: string | |
| kind: | |
| title: Kind is the type of evidence | |
| type: string | |
| subjectName: | |
| type: string | |
| subjectVersion: | |
| type: string | |
| annotations: | |
| title: Annotations are key-value pairs associated with the evidence | |
| type: object | |
| additionalProperties: | |
| type: string | |
| organizationId: | |
| title: OrganizationID is the ID of the organization that owns the evidence | |
| type: string | |
| organizationName: | |
| title: OrganizationName is the name of the organization that owns the evidence | |
| type: string | |
| workflowId: | |
| title: WorkflowID is the ID of the workflow that created the evidence | |
| type: string | |
| workflowName: | |
| title: WorkflowName is the name of the workflow that created the evidence | |
| type: string | |
| workflowRunId: | |
| title: WorkflowRunID is the ID of the workflow run that created the evidence | |
| type: string | |
| projectId: | |
| title: ProjectID is the ID of the project that owns the evidence | |
| type: string | |
| projectName: | |
| title: ProjectName is the name of the project that owns the evidence | |
| type: string | |
| projectVersionId: | |
| title: ProjectVersionID is the ID of the project version that owns the evidence | |
| type: string | |
| projectVersionName: | |
| title: ProjectVersionName is the name of the project version that owns the | |
| evidence | |
| type: string | |
| createdAt: | |
| title: CreatedAt is the timestamp when the evidence was created | |
| type: string | |
| format: date-time | |
| v1EvidenceServiceListResponse: | |
| title: EvidenceServiceListResponse is the response for the List method | |
| type: object | |
| properties: | |
| results: | |
| title: Results is the list of evidence | |
| type: array | |
| items: | |
| $ref: '#/components/schemas/v1EvidenceListItem' | |
| pagination: | |
| $ref: '#/components/schemas/v1CursorPaginationResponse' | |
| v1InfozResponse: | |
| type: object | |
| properties: | |
| version: | |
| title: Application version | |
| type: string | |
| commit: | |
| title: Commit hash | |
| type: string | |
| chartVersion: | |
| title: Chart version | |
| type: string | |
| backend_db_ok: | |
| type: boolean | |
| chainloop_db_ok: | |
| type: boolean | |
| v1MaterialType: | |
| type: string | |
| default: MATERIAL_TYPE_UNSPECIFIED | |
| enum: | |
| - MATERIAL_TYPE_UNSPECIFIED | |
| - STRING | |
| - CONTAINER_IMAGE | |
| - ARTIFACT | |
| - SBOM_CYCLONEDX_JSON | |
| - SBOM_SPDX_JSON | |
| - JUNIT_XML | |
| - OPENVEX | |
| - HELM_CHART | |
| - SARIF | |
| - EVIDENCE | |
| - ATTESTATION | |
| - CSAF_VEX | |
| - CSAF_INFORMATIONAL_ADVISORY | |
| - CSAF_SECURITY_ADVISORY | |
| - CSAF_SECURITY_INCIDENT_RESPONSE | |
| - GITLAB_SECURITY_REPORT | |
| - ZAP_DAST_ZIP | |
| - BLACKDUCK_SCA_JSON | |
| - TWISTCLI_SCAN_JSON | |
| - GHAS_CODE_SCAN | |
| - GHAS_SECRET_SCAN | |
| - GHAS_DEPENDENCY_SCAN | |
| - JACOCO_XML | |
| - SLSA_PROVENANCE | |
| v1StatuszResponse: | |
| type: object | |
| x-original-swagger-version: "2.0" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment