dinagraves / client-python

swagger_client

An API to insert and retrieve annotations on cloud artifacts.

This Python package is automatically generated by the Swagger Codegen project:

• API version: 0.1
• Package version: 1.0.0
• Build date: 2017-10-08T15:14:38.092-04:00
• Build package: class io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import swagger_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import swagger_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# create an instance of the API class
api_instance = swagger_client.GrafeasApi
projects_id = 'projects_id_example' # str | Part of `parent`. This field contains the projectId for example: \"project/{project_id}
note_id = 'note_id_example' # str | The ID to use for this note. (optional)
note = swagger_client.Note() # Note | The Note to be inserted (optional)

try:
    api_response = api_instance.create_note(projects_id, note_id=note_id, note=note)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling GrafeasApi->create_note: %s\n" % e

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
GrafeasApi	create_note	POST /v1alpha1/projects/{projectsId}/notes
GrafeasApi	create_occurrence	POST /v1alpha1/projects/{projectsId}/occurrences
GrafeasApi	delete_note	DELETE /v1alpha1/projects/{projectsId}/notes/{notesId}
GrafeasApi	delete_occurrence	DELETE /v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}
GrafeasApi	get_note	GET /v1alpha1/projects/{projectsId}/notes/{notesId}
GrafeasApi	get_occurrence	GET /v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}
GrafeasApi	get_occurrence_note	GET /v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}/notes
GrafeasApi	get_operation	GET /v1alpha1/projects/{projectsId}/operations/{operationsId}
GrafeasApi	list_note_occurrences	GET /v1alpha1/projects/{projectsId}/notes/{notesId}/occurrences
GrafeasApi	list_notes	GET /v1alpha1/projects/{projectsId}/notes
GrafeasApi	list_occurrences	GET /v1alpha1/projects/{projectsId}/occurrences
GrafeasApi	list_operations	GET /v1alpha1/projects/{projectsId}/operations
GrafeasApi	update_note	PUT /v1alpha1/projects/{projectsId}/notes/{notesId}
GrafeasApi	update_occurrence	PUT /v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}
GrafeasApi	update_operation	PUT /v1alpha1/projects/{projectsId}/operations/{operationsId}

Documentation For Models

• AliasContext
• Artifact
• Basis
• BuildDetails
• BuildProvenance
• BuildSignature
• BuildType
• CloudRepoSourceContext
• CloudWorkspaceId
• CloudWorkspaceSourceContext
• Command
• CreateOperationRequest
• CustomDetails
• Deployable
• Deployment
• Derived
• Detail
• Discovered
• Discovery
• Distribution
• Empty
• ExtendedSourceContext
• FileHashes
• Fingerprint
• GerritSourceContext
• GitSourceContext
• Hash
• Installation
• Layer
• ListNoteOccurrencesResponse
• ListNotesResponse
• ListOccurrencesResponse
• ListOperationsResponse
• Location
• Note
• Occurrence
• Operation
• Package
• PackageIssue
• ProjectRepoId
• RelatedUrl
• RepoId
• RepoSource
• Source
• SourceContext
• Status
• StorageSource
• UpdateOperationRequest
• Version
• VulnerabilityDetails
• VulnerabilityLocation
• VulnerabilityType

Documentation For Authorization

All endpoints do not require authorization.

Author