Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ jobs:
build:
docker:
# specify the version you desire here
# use `-browsers` prefix for selenium tests, e.g. `3.6.1-browsers`
- image: circleci/python:3.6.1
# use `-browsers` prefix for selenium tests, e.g. `3.8.7-browsers`
- image: circleci/python:3.8.7

working_directory: ~/repo

steps:
Expand All @@ -27,14 +27,14 @@ jobs:
command: |
python3 -m venv venv
. venv/bin/activate
python setup.py install
python setup.py install

- save_cache:
paths:
- ./venv

key: v1-dependencies-{{ checksum "requirements.txt" }}

# run tests!
- run:
name: run tests
Expand All @@ -45,4 +45,4 @@ jobs:
- store_artifacts:
path: test-reports
destination: test-reports

4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,7 @@ target/

#Ipython Notebook
.ipynb_checkpoints

# Files used for regenerating the client
swagger-codegen-cli.jar
grafeas.swagger.json
2 changes: 2 additions & 0 deletions .swagger-codegen-ignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,5 @@
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md

.gitignore
1 change: 1 addition & 0 deletions .swagger-codegen/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2.4.18
42 changes: 25 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,11 @@ import time
import grafeas
from grafeas.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = grafeas.GrafeasApi()
parent = 'parent_example' # str |
body = grafeas.ApiNote() # ApiNote |
api_instance = grafeas.GrafeasApi(grafeas.ApiClient(configuration))
parent = 'parent_example' # str | This field contains the project Id for example: \"project/{project_id}
body = grafeas.ApiNote() # ApiNote | The Note to be inserted

try:
# Creates a new `Note`.
Expand All @@ -70,25 +71,32 @@ All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*GrafeasApi* | [**create_note**](docs/GrafeasApi.md#create_note) | **POST** /v1alpha1/{parent}/notes | Creates a new `Note`.
*GrafeasApi* | [**create_occurrence**](docs/GrafeasApi.md#create_occurrence) | **POST** /v1alpha1/{parent}/occurrences | Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource.
*GrafeasApi* | [**create_operation**](docs/GrafeasApi.md#create_operation) | **POST** /v1alpha1/{parent}/operations | Creates a new `Operation`.
*GrafeasApi* | [**get_occurrence_note**](docs/GrafeasApi.md#get_occurrence_note) | **GET** /v1alpha1/{name}/notes | Gets the `Note` attached to the given `Occurrence`.
*GrafeasApi* | [**list_note_occurrences**](docs/GrafeasApi.md#list_note_occurrences) | **GET** /v1alpha1/{name}/occurrences | Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer projects.
*GrafeasApi* | [**list_notes**](docs/GrafeasApi.md#list_notes) | **GET** /v1alpha1/{parent}/notes | Lists all `Notes` for a given project.
*GrafeasApi* | [**list_occurrences**](docs/GrafeasApi.md#list_occurrences) | **GET** /v1alpha1/{parent}/occurrences | Lists active `Occurrences` for a given project matching the filters.
*GrafeasApi* | [**update_note**](docs/GrafeasApi.md#update_note) | **PATCH** /v1alpha1/{name} | Updates an existing `Note`.
*GrafeasProjectsApi* | [**create_project**](docs/GrafeasProjectsApi.md#create_project) | **POST** /v1alpha1/projects | Creates a new `Project`.
*GrafeasProjectsApi* | [**delete_project**](docs/GrafeasProjectsApi.md#delete_project) | **DELETE** /v1alpha1/{name} | Deletes the given `Project` from the system.
*GrafeasProjectsApi* | [**get_project**](docs/GrafeasProjectsApi.md#get_project) | **GET** /v1alpha1/{name} | Returns the requested `Project`.
*GrafeasProjectsApi* | [**list_projects**](docs/GrafeasProjectsApi.md#list_projects) | **GET** /v1alpha1/projects | Lists `Projects`
*GrafeasApi* | [**create_note**](docs/GrafeasApi.md#create_note) | **POST** /v1alpha1/{parent=projects/*}/notes | Creates a new `Note`.
*GrafeasApi* | [**create_occurrence**](docs/GrafeasApi.md#create_occurrence) | **POST** /v1alpha1/{parent=projects/*}/occurrences | Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource.
*GrafeasApi* | [**create_operation**](docs/GrafeasApi.md#create_operation) | **POST** /v1alpha1/{parent=projects/*}/operations | Creates a new `Operation`.
*GrafeasApi* | [**delete_note**](docs/GrafeasApi.md#delete_note) | **DELETE** /v1alpha1/{name=projects/*/notes/*} | Deletes the given `Note` from the system.
*GrafeasApi* | [**delete_occurrence**](docs/GrafeasApi.md#delete_occurrence) | **DELETE** /v1alpha1/{name=projects/*/occurrences/*} | Deletes the given `Occurrence` from the system. Use this when an `Occurrence` is no longer applicable for the given resource.
*GrafeasApi* | [**get_note**](docs/GrafeasApi.md#get_note) | **GET** /v1alpha1/{name=projects/*/notes/*} | Returns the requested `Note`.
*GrafeasApi* | [**get_occurrence**](docs/GrafeasApi.md#get_occurrence) | **GET** /v1alpha1/{name=projects/*/occurrences/*} | Returns the requested `Occurrence`.
*GrafeasApi* | [**get_occurrence_note**](docs/GrafeasApi.md#get_occurrence_note) | **GET** /v1alpha1/{name=projects/*/occurrences/*}/notes | Gets the `Note` attached to the given `Occurrence`.
*GrafeasApi* | [**list_note_occurrences**](docs/GrafeasApi.md#list_note_occurrences) | **GET** /v1alpha1/{name=projects/*/notes/*}/occurrences | Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer projects.
*GrafeasApi* | [**list_notes**](docs/GrafeasApi.md#list_notes) | **GET** /v1alpha1/{parent=projects/*}/notes | Lists all `Notes` for a given project.
*GrafeasApi* | [**list_occurrences**](docs/GrafeasApi.md#list_occurrences) | **GET** /v1alpha1/{parent=projects/*}/occurrences | Lists active `Occurrences` for a given project matching the filters.
*GrafeasApi* | [**update_note**](docs/GrafeasApi.md#update_note) | **PATCH** /v1alpha1/{name=projects/*/notes/*} | Updates an existing `Note`.
*GrafeasApi* | [**update_occurrence**](docs/GrafeasApi.md#update_occurrence) | **PATCH** /v1alpha1/{name=projects/*/occurrences/*} | Updates an existing occurrence.
*GrafeasApi* | [**update_operation**](docs/GrafeasApi.md#update_operation) | **PATCH** /v1alpha1/{name=projects/*/operations/*} | Updates an existing operation returns an error if operation does not exist. The only valid operations are to update mark the done bit change the result.
*GrafeasProjectsApi* | [**create_project**](docs/GrafeasProjectsApi.md#create_project) | **POST** /v1alpha1/projects | Creates a new project.
*GrafeasProjectsApi* | [**delete_project**](docs/GrafeasProjectsApi.md#delete_project) | **DELETE** /v1alpha1/{name=projects/*} | Deletes the specified project.
*GrafeasProjectsApi* | [**get_project**](docs/GrafeasProjectsApi.md#get_project) | **GET** /v1alpha1/{name=projects/*} | Gets the specified project.
*GrafeasProjectsApi* | [**list_projects**](docs/GrafeasProjectsApi.md#list_projects) | **GET** /v1alpha1/projects | Lists projects.


## Documentation For Models

- [ApiAliasContext](docs/ApiAliasContext.md)
- [ApiAliasContextKind](docs/ApiAliasContextKind.md)
- [ApiArtifact](docs/ApiArtifact.md)
- [ApiAttestationAuthority](docs/ApiAttestationAuthority.md)
- [ApiBuildDetails](docs/ApiBuildDetails.md)
- [ApiBuildProvenance](docs/ApiBuildProvenance.md)
- [ApiBuildSignature](docs/ApiBuildSignature.md)
Expand Down Expand Up @@ -120,6 +128,7 @@ Class | Method | HTTP request | Description
- [ApiStorageSource](docs/ApiStorageSource.md)
- [ApiUpdateOperationRequest](docs/ApiUpdateOperationRequest.md)
- [ApiVulnerabilityType](docs/ApiVulnerabilityType.md)
- [AttestationAuthorityAttestationAuthorityHint](docs/AttestationAuthorityAttestationAuthorityHint.md)
- [AttestationAuthorityAttestationDetails](docs/AttestationAuthorityAttestationDetails.md)
- [BuildSignatureKeyType](docs/BuildSignatureKeyType.md)
- [DeployableDeploymentDetails](docs/DeployableDeploymentDetails.md)
Expand All @@ -129,17 +138,16 @@ Class | Method | HTTP request | Description
- [DockerImageDerivedDetails](docs/DockerImageDerivedDetails.md)
- [DockerImageFingerprint](docs/DockerImageFingerprint.md)
- [DockerImageLayer](docs/DockerImageLayer.md)
- [GooglelongrunningOperation](docs/GooglelongrunningOperation.md)
- [HashHashType](docs/HashHashType.md)
- [LayerDirective](docs/LayerDirective.md)
- [LongrunningOperation](docs/LongrunningOperation.md)
- [NoteRelatedUrl](docs/NoteRelatedUrl.md)
- [PackageManagerArchitecture](docs/PackageManagerArchitecture.md)
- [PackageManagerDistribution](docs/PackageManagerDistribution.md)
- [PackageManagerInstallationDetails](docs/PackageManagerInstallationDetails.md)
- [PackageManagerPackage](docs/PackageManagerPackage.md)
- [PgpSignedAttestationContentType](docs/PgpSignedAttestationContentType.md)
- [ProtobufAny](docs/ProtobufAny.md)
- [ProtobufEmpty](docs/ProtobufEmpty.md)
- [ProtobufFieldMask](docs/ProtobufFieldMask.md)
- [RpcStatus](docs/RpcStatus.md)
- [VersionVersionKind](docs/VersionVersionKind.md)
Expand Down
6 changes: 6 additions & 0 deletions config.py.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"projectName": "Grafeas",
"packageVersion": "v1alpha1",
"packageName": "grafeas",
"licenseName": "Apache 2.0"
}
10 changes: 10 additions & 0 deletions docs/ApiAttestationAuthority.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# ApiAttestationAuthority

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**hint** | [**AttestationAuthorityAttestationAuthorityHint**](AttestationAuthorityAttestationAuthorityHint.md) | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


2 changes: 1 addition & 1 deletion docs/ApiCreateOperationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**parent** | **str** | The projectId that this operation should be created under. | [optional]
**operation_id** | **str** | The ID to use for this operation. | [optional]
**operation** | [**LongrunningOperation**](LongrunningOperation.md) | The operation to create. | [optional]
**operation** | [**GooglelongrunningOperation**](GooglelongrunningOperation.md) | The operation to create. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
6 changes: 4 additions & 2 deletions docs/ApiNote.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
**name** | **str** | The name of the note in the form \"projects/{PROJECT_ID}/notes/{NOTE_ID}\". | [optional]
**short_description** | **str** | A one sentence description of this `Note`. | [optional]
**long_description** | **str** | A detailed description of this `Note`. | [optional]
**kind** | [**ApiNoteKind**](ApiNoteKind.md) | Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests. | [optional]
Expand All @@ -13,10 +13,12 @@ Name | Type | Description | Notes
**package** | [**PackageManagerPackage**](PackageManagerPackage.md) | A note describing a package hosted by various package managers. | [optional]
**deployable** | [**ApiDeployable**](ApiDeployable.md) | A note describing something that can be deployed. | [optional]
**discovery** | [**ApiDiscovery**](ApiDiscovery.md) | A note describing a provider/analysis type. | [optional]
**related_url** | [**list[NoteRelatedUrl]**](NoteRelatedUrl.md) | | [optional]
**attestation_authority** | [**ApiAttestationAuthority**](ApiAttestationAuthority.md) | A note describing an attestation role. | [optional]
**related_url** | [**list[NoteRelatedUrl]**](NoteRelatedUrl.md) | URLs associated with this note. | [optional]
**expiration_time** | **datetime** | Time of expiration for this note, null if note does not expire. | [optional]
**create_time** | **datetime** | Output only. The time this note was created. This field can be used as a filter in list requests. | [optional]
**update_time** | **datetime** | Output only. The time this note was last updated. This field can be used as a filter in list requests. | [optional]
**operation_name** | **str** | The name of the `Operation` in the form \"projects/{PROJECT_ID}/operations/{OPERATION_ID}\". | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
1 change: 1 addition & 0 deletions docs/ApiOccurrence.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Name | Type | Description | Notes
**remediation** | **str** | | [optional]
**create_time** | **datetime** | Output only. The time this `Occurrence` was created. | [optional]
**update_time** | **datetime** | Output only. The time this `Occurrence` was last updated. | [optional]
**operation_name** | **str** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/ApiProject.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | | [optional]
**name** | **str** | The name of the project in the form of `projects/{PROJECT_ID}`. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/ApiUpdateOperationRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the Operation. Should be of the form \"projects/{provider_id}/operations/{operation_id}\". | [optional]
**operation** | [**LongrunningOperation**](LongrunningOperation.md) | The operation to create. | [optional]
**operation** | [**GooglelongrunningOperation**](GooglelongrunningOperation.md) | The operation to create. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
10 changes: 10 additions & 0 deletions docs/AttestationAuthorityAttestationAuthorityHint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# AttestationAuthorityAttestationAuthorityHint

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**human_readable_name** | **str** | The human readable name of this Attestation Authority, e.g. \"qa\". | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


2 changes: 1 addition & 1 deletion docs/DiscoveryDiscoveredDetails.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operation** | [**LongrunningOperation**](LongrunningOperation.md) | Output only. An operation that indicates the status of the current scan. | [optional]
**operation** | [**GooglelongrunningOperation**](GooglelongrunningOperation.md) | Output only. An operation that indicates the status of the current scan. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
14 changes: 14 additions & 0 deletions docs/GooglelongrunningOperation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# GooglelongrunningOperation

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `operations/some/unique/name`. | [optional]
**metadata** | [**ProtobufAny**](ProtobufAny.md) | Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. | [optional]
**done** | **bool** | If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. | [optional]
**error** | [**RpcStatus**](RpcStatus.md) | The error result of the operation in case of failure or cancellation. | [optional]
**response** | [**ProtobufAny**](ProtobufAny.md) | The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading