nostaigia/ParaTool huggingface dataset:
name: transformers.pipeline
description: Initializes a processing pipeline for natural language tasks using pre-trained models from the Hugging Face library. Supports tasks like sentiment analysis, question answering, and text generation.
parameters: type: dict
required: task
model
properties: task: type: string
description: The task to be performed, such as 'sentiment-analysis', 'question-answering', or 'text-generation'.
enum: sentiment-analysis
question-answering
text-generation
ner
summarization
model: type: string
description: The model ID of a pre-trained model from Hugging Face's model hub. For example, 'bert-base-uncased' for English tasks.
framework: type: string
description: The deep learning framework to use. Can be either 'tf' for TensorFlow or 'pt' for PyTorch.
enum: tf
pt
default: pt
device: type: integer
description: CUDA device to use for computation (e.g., 0 for the first GPU or -1 for CPU).
default: -1
tokenizer: type: string
description: Optional tokenizer to use. If not specified, the default tokenizer for the selected model is used.
config: type: string
description: Optional configuration for the pipeline. If not specified, the default configuration for the selected model is used.
name: initialize_question_answering_pipeline
description: Initializes the question-answering pipeline using a specified pre-trained model, enabling the system to process and answer questions based on the data it has been trained on.
parameters: type: dict
required: model_name
properties: model_name: type: string
description: The name of the pre-trained model to be used for the question-answering pipeline, such as 'vikhyatk/moondream2'.
use_gpu: type: boolean
description: A flag indicating whether to use GPU for computation. If set to false, CPU will be used instead.
default: no
name: analyze_image_with_question.pipeline
description: This function takes an image file and a question related to the image, and uses a machine learning pipeline to analyze the image and answer the question.
parameters: type: dict
required: image_path
question
properties: image_path: type: string
description: The file path to the image to be analyzed.
question: type: string
description: A question in plain English related to the contents of the image.
name: getCurrentTime
description: Returns the current local time in ISO 8601 format.
parameters: type: dict
properties: timezone: type: string
description: The timezone for which the current time is requested, in the format of 'Area/Location' (e.g., 'America/New_York'). If not provided, defaults to the server's local timezone.
default: local
include_date: type: boolean
description: Determines whether the date should be included in the time string. If set to true, the date is included. Defaults to false.
default: no
name: CalcProduct
description: Calculates the product of two numeric values.
parameters: type: dict
required: a
b
properties: a: type: integer
description: The first multiplicand in the multiplication operation.
b: type: integer
description: The second multiplicand in the multiplication operation.
name: sum
description: Calculates the sum of two integers.
parameters: type: dict
required: a
b
properties: a: type: integer
description: The first integer to be added.
b: type: integer
description: The second integer to be added.
name: get_current_weather
description: Retrieves the current weather conditions for a specified location, including temperature and atmospheric conditions.
parameters: type: dict
required: location
properties: location: type: string
description: The location for which weather is being requested, in the format of 'City, State', such as 'San Francisco, CA' or 'New York, NY'.
unit: type: string
description: The unit of temperature measurement for the weather report.
enum: celsius
fahrenheit
default: fahrenheit
name: get_tickets
description: Retrieve a list of support tickets for a specified company.
parameters: type: dict
required: customer
properties: customer: type: string
description: The name of the company for which to retrieve support tickets.
name: get_current_weather
description: Retrieve the current weather conditions for a specified location, with options to choose the temperature unit.
parameters: type: dict
required: location
properties: location: type: string
description: The location for which to get the weather, in the format of 'City, State', such as 'San Francisco, CA' or 'New York, NY'.
unit: type: string
description: The unit of temperature to be used in the weather report.
enum: celsius
fahrenheit
default: fahrenheit
name: get_tickets
description: Retrieve the list of support tickets for a specified company, optionally filtered by priority level.
parameters: type: dict
required: customer
properties: customer: type: string
description: The name of the company for which to retrieve support tickets.
priority: type: integer
description: The priority level of the tickets, represented as an integer from 1 (highest priority) to 8 (lowest priority).
default: 5
name: find_flights
description: Searches for available flights between an origin and a destination on a specified date for a given number of passengers.
parameters: type: dict
required: origin
destination
date
passengers
properties: origin: type: string
description: The three-letter IATA code of the origin airport, such as 'SFO' for San Francisco International Airport.
destination: type: string
description: The three-letter IATA code of the destination airport, similar to the origin format.
date: type: string
description: The departure date of the flight in the format YYYY-MM-DD, such as '2023-04-15'.
passengers: type: integer
description: The total number of passengers traveling.
name: book_flight
description: Registers a specified flight for the given list of passengers on a particular date.
parameters: type: dict
required: flight
passengers
date
properties: flight: type: string
description: The unique identifier of the flight to be booked.
passengers: type: array
items: type: string
description: A list of names of the passengers traveling.
date: type: string
description: The departure date of the flight in the format YYYY-MM-DD.
name: uber.ride
description: Find a suitable Uber ride for customers based on their starting location, preferred type of ride, and maximum wait time.
parameters: type: dict
required: loc
type
time
properties: loc: type: string
description: Location of the starting point for the Uber ride, in the format of 'City, State', such as 'Berkeley, CA' or 'New York, NY'.
type: type: string
description: Type of Uber ride the user is requesting.
enum: plus
comfort
black
time: type: integer
description: The maximum amount of time the customer is willing to wait for the ride, in minutes.
name: segment
description: Segments all objects within a provided image and identifies distinct elements for further analysis.
parameters: type: dict
required: img_path
properties: img_path: type: string
description: The file system path to the image to be segmented, in the format of '/path/to/image.jpg'.
name: uber.ride
description: Find a suitable Uber ride for customers based on their location, preferred ride type, and maximum wait time.
parameters: type: dict
required: loc
type
time
properties: loc: type: string
description: The starting location of the Uber ride in the format of 'Street Address, City, State'. For example: '123 Main St, Anytown, CA'.
type: type: string
description: The type of Uber ride the user is requesting.
enum: plus
comfort
black
time: type: integer
description: The maximum amount of time the customer is willing to wait for the ride, measured in minutes.
name: send.message
description: Sends an email message to the specified recipient.
parameters: type: dict
required: dest
message
properties: dest: type: string
description: The email address of the recipient, in standard email format (e.g., 'username@example.com').
message: type: string
description: The body of the email message, summarizing the content to be sent.
subject: type: string
description: The subject line of the email message.
default: No Subject
cc: type: array
items: type: string
description: An array of email addresses to be included as CC in the email, in standard email format.
bcc: type: array
items: type: string
description: An array of email addresses to be included as BCC in the email, in standard email format.
name: uber.ride
description: Find a suitable ride for customers based on their location, desired type of ride, and maximum wait time.
parameters: type: dict
required: loc
type
time
properties: loc: type: string
description: The starting location for the Uber ride in the format of 'Street, City, State'. For example, '50 Memorial Drive, Cambridge, MA'.
type: type: string
description: The type of Uber ride the user is ordering.
enum: plus
comfort
black
time: type: integer
description: The maximum amount of time the customer is willing to wait for the ride, in minutes.
name: segment_all_objects
description: Segments all identifiable objects within a provided image and returns their boundaries.
parameters: type: dict
required: img_path
properties: img_path: type: string
description: The file system path to the image that will be processed for object segmentation. The path should be absolute or relative to the execution directory.
name: list_directory_contents
description: List all the files and directories within the specified directory path.
parameters: type: dict
required: dir_path
properties: dir_path: type: string
description: The file system path to the directory whose contents are to be listed. The path should be absolute or relative to the current working directory.
include_hidden: type: boolean
description: A flag to determine whether hidden files and directories should be included in the list.
default: no
sort_order: type: string
description: The order in which the directory contents are listed. Ascending or descending by name.
enum: asc
desc
default: asc
name: reschedule
description: Moves a specified event to a new date and time, adjusting for time zone differences.
parameters: type: dict
required: identifier
dateortime
properties: identifier: type: string
description: A unique identifier for the event to be rescheduled.
dateortime: type: string
description: The new date and time for the event, in ISO-8601 format (YYYY-MM-DDTHH:MM:SS), without a timezone offset.
timezone: type: string
description: The Olson timezone identifier representing the timezone for the new event time, such as 'Asia/Tokyo'.
enum: Asia/Tokyo
America/New_York
Europe/London
UTC
default: UTC
name: list_events
description: Retrieves a list of events that occur within a specified date and time range, formatted according to ISO-8601 standards.
parameters: type: dict
required: start
end
properties: start: type: string
description: The start date and time of the query window, in ISO-8601 format (e.g., '2023-01-01T00:00:00Z').
end: type: string
description: The end date and time of the query window, in ISO-8601 format (e.g., '2023-01-02T00:00:00Z').
name: version_api.VersionApi.get_version
description: Retrieve the version information of the application, including its name and version number in a JSON object.
parameters: type: dict
name: project_api.ProjectApi.get_project_by_name_and_version
description: Retrieves a specific project's details by matching the provided project name and version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name of the project to retrieve. For example, 'AlphaProject'.
version: type: string
description: The version identifier of the project, formatted as 'major.minor.patch', e.g., '1.2.0'.
name: badge_api.BadgeApi.get_project_vulnerabilities_badge
description: Retrieves the current security vulnerability metrics for a specified project and version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name of the project for which vulnerability metrics are requested.
version: type: string
description: The specific version of the project for which vulnerability metrics are requested.
name: badge_api.BadgeApi.get_project_policy_violations_badge1
description: Retrieves a badge image that represents the policy violation status for a specific project and its version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name identifier of the project.
version: type: string
description: The specific version of the project to be checked for policy violations.
name: repository_api.RepositoryApi.get_repository_meta_component
description: Resolves the latest version of the specified component within the configured repositories.
parameters: type: dict
required: purl
properties: purl: type: string
description: The Package URL (PURL) for the component whose latest version is to be queried. It should conform to the PURL specification.
name: project_api.ProjectApi.get_children_projects_by_tag
description: Retrieves a list of all child projects associated with a specific tag within a parent project.
parameters: type: dict
required: tag
uuid
properties: tag: type: string
description: The unique identifier used to filter child projects within the parent project.
uuid: type: string
description: The universally unique identifier (UUID) of the parent project from which to retrieve child projects.
excludeInactive: type: boolean
description: Determines whether to exclude inactive child projects from the results.
default: no
name: project_api.ProjectApi.get_projects_by_tag
description: Returns a list of all projects associated with a specified tag, with options to exclude inactive projects and children projects.
parameters: type: dict
required: tag
properties: tag: type: string
description: The tag used to filter projects.
excludeInactive: type: boolean
description: If set to true, inactive projects will not be included in the results.
default: no
onlyRoot: type: boolean
description: If set to true, only root projects without children will be included in the results.
default: no
name: project_api.ProjectApi.get_children_projects
description: Retrieve a list of all child projects associated with a given parent project, with an option to exclude inactive projects.
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier (UUID) of the parent project for which child projects are to be retrieved.
excludeInactive: type: boolean
description: When set to true, inactive child projects will not be included in the response.
default: no
name: project_api.ProjectApi.get_children_projects_by_classifier
description: This function retrieves a list of child projects associated with a given project UUID, filtered by a specified classifier. Optionally, inactive projects can be excluded from the results.
parameters: type: dict
required: classifier
uuid
properties: classifier: type: string
description: The classifier used to filter child projects. This could be a category or type of project, such as 'infrastructure' or 'research'.
uuid: type: string
description: The unique identifier of the parent project in UUID format, from which the children projects are derived.
excludeInactive: type: boolean
description: A flag to determine whether inactive child projects should be excluded from the list. By default, all child projects are included.
default: no
name: project_api.ProjectApi.get_projects
description: Retrieve a list of all projects from the database. Allows filtering by project name and controlling whether inactive or child projects are included in the results.
parameters: type: dict
required: excludeInactive
onlyRoot
properties: name: type: string
description: The name of the project to filter the query results. If left empty, all projects will be returned.
excludeInactive: type: boolean
description: If true, inactive projects will not be included in the result set.
onlyRoot: type: boolean
description: If true, only root projects will be returned, excluding any child projects.
name: analysis_api.AnalysisApi.retrieve_analysis
description: Retrieves the analysis trail associated with a specified vulnerability within a component of a project.
parameters: type: dict
required: project
component
vulnerability
properties: project: type: string
description: The UUID of the project to which the analysis trail belongs.
component: type: string
description: The UUID of the component within the project being analyzed.
vulnerability: type: string
description: The UUID of the vulnerability for which the analysis trail is retrieved.
name: finding_api.FindingApi.analyze_project
description: Initiates a vulnerability analysis for the specified project using its unique identifier (UUID).
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier (UUID) of the project for which the vulnerability analysis is to be triggered.
name: violationanalysis_api.retrieve_analysis
description: Retrieves the details of a violation analysis trail for a given component and policy violation by their UUIDs.
parameters: type: dict
required: component
policyViolation
properties: component: type: string
description: The unique identifier (UUID) of the component for which the analysis trail is to be retrieved.
policyViolation: type: string
description: The unique identifier (UUID) of the policy violation associated with the component.
name: VulnerabilityApi.get_vulnerabilities_by_component
description: Retrieves a list of all identified vulnerabilities associated with a specific software component, allowing for optional inclusion of suppressed vulnerabilities.
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The universally unique identifier (UUID) of the software component for which vulnerabilities are being queried.
suppressed: type: boolean
description: A flag to determine whether suppressed vulnerabilities should be included in the response. Suppressed vulnerabilities are those that have been flagged as false positives or accepted risks.
default: no
name: VulnerabilityApi.get_vulnerabilities_by_project
description: Retrieve a list of all identified vulnerabilities associated with a given project using its unique identifier (UUID).
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier (UUID) of the project for which the vulnerabilities are being queried.
suppressed: type: boolean
description: Indicates whether to include suppressed vulnerabilities in the result. Suppressed vulnerabilities are those that have been marked as ignored or irrelevant.
default: no
name: get_current_weather
description: Retrieve the current weather conditions for a specified location in the desired unit of temperature.
parameters: type: dict
required: location
properties: location: type: string
description: The location for which to get the weather, in the format of 'City, State', such as 'San Francisco, CA' or 'Austin, TX'.
unit: type: string
description: The unit of temperature for the weather report.
enum: celsius
fahrenheit
default: fahrenheit
name: get_area_of_square
description: Calculates the area of a square by squaring the length of one of its sides.
parameters: type: dict
required: size
properties: size: type: float
description: The length of one side of the square in units.
name: get_contact_information
description: Retrieve the contact information for an individual based on their name or identification number. One of the parameters 'name' or 'id_no' must be provided, but not both.
parameters: type: dict
properties: name: type: string
description: The full name of the individual. Provide the name in the format 'First Last', such as 'John Doe'. Optional, but if 'id_no' is not provided, 'name' becomes required.
id_no: type: string
description: The unique identification number assigned to the individual. It should be in the format 'A1234567B'. Optional, but if 'name' is not provided, 'id_no' becomes required.
name: get_current_weather
description: Retrieves the current weather conditions for a specified location in the desired temperature unit.
parameters: type: dict
required: location
properties: location: type: string
description: The location for which to get the weather, in the format of 'City, State', such as 'San Francisco, CA' or 'New York, NY'.
unit: type: string
description: The temperature unit for the weather report.
enum: celsius
fahrenheit
default: fahrenheit
name: get_area_of_square
description: Calculates the area of a square by squaring the length of one of its sides.
parameters: type: dict
required: size
properties: size: type: float
description: The length of one side of the square in units.
name: get_contact_information
description: Retrieves the contact information for an individual using their full name or identification number. Either the 'name' or 'id_no' parameter must be provided. If both are given, 'id_no' takes precedence over 'name'.
parameters: type: dict
properties: name: type: string
description: The full name of the person, in the format 'First Last'. Example: 'John Doe'. If not provided, the function will attempt to use 'id_no' as the lookup parameter.
id_no: type: string
description: The unique identification number of the person, used as an alternative to 'name' for retrieving contact information.
name: get_current_weather
description: Retrieves the current weather information for a specified city and state.
parameters: type: dict
required: location
properties: location: type: string
description: The location for which to get the weather, in the format of 'City, State', such as 'San Francisco, CA' or 'New York, NY'.
unit: type: string
description: The unit of measurement for temperature values.
enum: celsius
fahrenheit
default: fahrenheit
name: get_area_of_square
description: Calculates the area of a square by squaring the length of one of its sides.
parameters: type: dict
required: size
properties: size: type: float
description: The length of one side of the square in units.
name: get_contact_information
description: Retrieve the contact details of a person using their name or identification number. At least one identifier (name or identification number) is required for the lookup.
parameters: type: dict
properties: name: type: string
description: The full name of the person. Optional if the identification number is provided. If omitted, the system will prompt for additional search criteria.
identification_number: type: string
description: The unique identification number for the person. Optional if the name is provided. If omitted, the system will prompt for additional search criteria.
name: set_integer
description: Sets the value of an integer variable specified by its name.
parameters: type: dict
required: name
value
properties: name: type: string
description: The unique identifier for the integer variable.
value: type: integer
description: The value to assign to the integer variable.
name: set_string
description: Assigns a new value to the specified string variable.
parameters: type: dict
required: string_name
string_value
properties: string_name: type: string
description: The identifier of the string variable to be updated.
string_value: type: string
description: The new content that the string variable will hold.
name: set_float
description: Assigns a floating-point number to the specified variable.
parameters: type: dict
required: number_name
number_value
properties: number_name: type: string
description: The identifier for the floating-point variable.
number_value: type: float
description: The floating-point value to be assigned to the variable.
name: set_point
description: Sets a point in 3D space with given X, Y, and Z coordinates and assigns it a name.
parameters: type: dict
required: x
y
z
point_name
properties: x: type: float
description: The X coordinate of the point in units.
y: type: float
description: The Y coordinate of the point in units.
z: type: float
description: The Z coordinate of the point in units.
point_name: type: string
description: The unique name assigned to the point.
name: version_api.VersionApi.get_version
description: Retrieves the current version information of the application, including the name and version number.
parameters: type: dict
name: project_api.ProjectApi.get_project_by_name_and_version
description: Retrieve detailed information about a specific project based on its unique name and version identifier.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique identifier of the project, such as 'Alpha_Project'.
version: type: string
description: The specific version of the project to retrieve, formatted as 'v1.2.3'.
enum: v1.0.0
v1.2.3
v2.0.0
name: badge_api.BadgeApi.get_project_policy_violations_badge1
description: Generates a badge image representing the policy compliance status for a specified project and version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name of the project for which the policy violations badge is requested.
version: type: string
description: The specific version of the project for which the policy violations badge is requested.
name: project_api.update_project
description: Updates the specified project's details such as its name, status, and description.
parameters: type: dict
required: project_id
properties: project_id: type: string
description: The unique identifier of the project to be updated.
project_name: type: string
description: The new name of the project.
default: Untitled Project
status: type: string
description: The current status of the project.
enum: active
inactive
archived
default: active
description: type: string
description: A brief description of the project.
default: No description provided.
name: badge_api.BadgeApi.get_project_vulnerabilities_badge
description: Fetches and returns the current security vulnerability metrics for a specified project and its version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name of the project for which to retrieve vulnerability metrics.
version: type: string
description: The specific version of the project to obtain vulnerability metrics for.
name: version_api.VersionApi.get_version
description: Retrieve the current version information of the application, including its name and version number.
parameters: type: dict
name: oidc_api.OidcApi.is_available
description: Checks whether OpenID Connect authentication is enabled and available for the application.
parameters: type: dict
required: application_id
properties: application_id: type: string
description: The unique identifier of the application for which to check OpenID Connect availability.
name: project_api.ProjectApi.update_project
description: Updates the specified project with new details. This may include changing the project's name, description, status, or other metadata.
parameters: type: dict
required: project_id
project_data
properties: project_id: type: string
description: The unique identifier for the project to be updated.
project_data: type: dict
properties: name: type: string
description: The new name of the project.
description: type: string
description: A brief description of the project and its goals.
status: type: string
description: The current status of the project.
enum: active
inactive
completed
archived
default: active
deadline: type: string
description: The updated deadline for the project completion, in the format of 'YYYY-MM-DD'.
description: A dictionary containing the new details of the project. All keys are optional, but at least one must be provided.
name: version_api.VersionApi.get_version
description: Retrieve the current version of the application, including the application name and its semantic versioning string.
parameters: type: dict
name: repository_api.RepositoryApi.get_repository_meta_component
description: Resolves the latest version of a component based on its Package URL from the configured repositories.
parameters: type: dict
required: purl
properties: purl: type: string
description: The Package URL (purl) uniquely identifying the component whose latest version needs to be resolved.
name: oidc_api.OidcApi.is_available
description: Check whether OpenID Connect authentication is available for the specified application.
parameters: type: dict
required: app_id
properties: app_id: type: string
description: The unique identifier of the application to check for OpenID Connect availability.
name: analysis_api.AnalysisApi.retrieve_analysis
description: Retrieves the analysis trail for a specific vulnerability within a component of a project.
parameters: type: dict
required: project
component
vulnerability
properties: project: type: string
description: The unique identifier (UUID) of the project.
component: type: string
description: The unique identifier (UUID) of the component within the project.
vulnerability: type: string
description: The unique identifier (UUID) of the vulnerability within the component.
name: finding_api.FindingApi.analyze_project
description: Initiates a vulnerability analysis for the specified project using its unique identifier (UUID).
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier (UUID) of the project for which the vulnerability analysis is to be triggered.
include_dependencies: type: boolean
description: A flag indicating whether to include project dependencies in the analysis.
default: no
priority: type: string
description: The priority level of the analysis job.
enum: low
medium
high
default: medium
name: violationanalysis_api.ViolationanalysisApi.retrieve_analysis1
description: Retrieves a detailed trail of a specific violation analysis for a given component and policy violation.
parameters: type: dict
required: component
policyViolation
properties: component: type: string
description: The unique identifier (UUID) of the component involved in the violation.
policyViolation: type: string
description: The unique identifier (UUID) of the specific policy violation to be analyzed.
name: version_api.VersionApi.get_version
description: Retrieves the current version of the application along with its name in a simple JSON object format.
parameters: type: dict
name: project_api.ProjectApi.get_project_by_name_and_version
description: Retrieves detailed information about a specific project based on its unique name and version identifier.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name identifier for the project. It is case-sensitive and follows the naming conventions of the system.
version: type: string
description: The version identifier of the project, typically adhering to semantic versioning. For example, '1.0.0', '1.0.1-alpha', etc.
name: project_api.ProjectApi.update_project
description: Updates the specified project with new information such as its name, status, or description.
parameters: type: dict
required: project_id
project_data
properties: project_id: type: string
description: The unique identifier of the project to be updated.
project_data: type: dict
properties: name: type: string
description: The new name of the project.
status: type: string
description: The new status of the project.
enum: active
inactive
completed
on_hold
description: type: string
description: A brief description of the project and the updates being made.
default: No description provided.
description: A collection of data representing the updates to apply to the project.
name: repository_api.RepositoryApi.update_repository
description: Updates the specified repository with new information such as name, description, and visibility settings.
parameters: type: dict
required: repository_id
update_fields
properties: repository_id: type: string
description: The unique identifier of the repository to be updated.
update_fields: type: dict
properties: name: type: string
description: The new name of the repository.
description: type: string
description: A short text describing the repository.
visibility: type: string
description: The visibility level of the repository.
enum: public
private
default: public
description: A collection of fields that need to be updated with their new values.
name: create_vulnerability
description: This function creates a new record in the system to track a vulnerability identified in a software component.
parameters: type: dict
required: name
severity
affected_component
properties: name: type: string
description: The unique name describing the vulnerability.
severity: type: string
description: The level of severity of the vulnerability.
enum: Low
Medium
High
Critical
description: type: string
description: A detailed description of the vulnerability.
default: No detailed description provided.
affected_component: type: string
description: The software component that is affected by this vulnerability.
discovered_date: type: string
description: The date on which the vulnerability was discovered, in the format 'YYYY-MM-DD'.
remediation_status: type: string
description: The current status of the remediation efforts.
enum: Not Started
In Progress
Completed
default: Not Started
name: version_api.VersionApi.get_version
description: Retrieve the current version of the application, including its name and version number, formatted in JSON.
parameters: type: dict
name: project_api.ProjectApi.get_project_by_name_and_version
description: Retrieve details of a specific project by matching a given name and version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The exact name of the project to be retrieved.
version: type: string
description: The specific version of the project to be retrieved, in the format 'major.minor.patch' (e.g., '1.4.2').
name: badge_api.BadgeApi.get_project_policy_violations_badge1
description: Generates a badge indicating the level of policy violations present in a specified project and version.
parameters: type: dict
required: project_name
project_version
properties: project_name: type: string
description: The unique identifier of the project for which the policy violations badge is requested.
project_version: type: string
description: The specific version identifier of the project to assess for policy violations.
name: version_api.VersionApi.get_version
description: Retrieve the current version of the application, including its name and version number in a simple JSON object format.
parameters: type: dict
name: project_api.ProjectApi.get_project_by_name_and_version
description: Retrieve the details of a specific project using its unique name and version identifier.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name of the project to be retrieved.
version: type: string
description: The specific version of the project to be retrieved, formatted as 'major.minor.patch' (e.g., '1.2.0').
name: project_api.ProjectApi.update_project
description: Updates the existing project details with the provided information.
parameters: type: dict
required: project_id
project_data
properties: project_id: type: integer
description: The unique identifier of the project to update.
project_data: type: dict
properties: name: type: string
description: The new name of the project.
status: type: string
description: The new status of the project.
enum: active
inactive
completed
start_date: type: string
description: The start date of the project in the format 'YYYY-MM-DD'.
default: null
end_date: type: string
description: The end date of the project in the format 'YYYY-MM-DD'. Optional, can be null if the project is ongoing.
default: null
budget: type: float
description: The updated budget for the project in USD.
description: A dictionary containing the updated project details.
name: badge_api.BadgeApi.get_project_policy_violations_badge1
description: Generates a badge representing the policy violations status for a given project and version.
parameters: type: dict
required: project_name
project_version
properties: project_name: type: string
description: The unique name of the project for which the badge is generated.
project_version: type: string
description: The specific version of the project to evaluate for policy violations.
name: project_api.ProjectApi.get_project_by_name_and_version
description: Retrieves the details of a specific project identified by its name and version number.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name of the project to retrieve.
version: type: string
description: The version identifier of the project, typically in the format 'major.minor.patch' (e.g., '1.2.3').
name: version_api.VersionApi.get_version
description: Retrieves the current version of the application along with its name in a simple JSON object format.
parameters: type: dict
name: bom_api.BomApi.is_token_being_processed
description: Check if tasks associated with a given token are currently being processed or are queued for processing. This is typically used to check the status of a BOM (Bill of Materials) upload, which returns a token. The token can be queried to determine if tasks, such as vulnerability analysis, are in progress. A return value of 'true' indicates ongoing processing, while 'false' means there is no current processing for the provided token. Note that 'false' does not verify the token's validity, but simply the absence of associated processing tasks.
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier (UUID) of the token to be queried. This UUID is provided after successfully uploading a BOM document.
name: service_api.update_service
description: Updates the specified service with new details. This may include changing the service's name, description, or active status.
parameters: type: dict
required: service_id
service_data
properties: service_id: type: string
description: The unique identifier of the service to be updated.
service_data: type: dict
properties: name: type: string
description: The new name of the service.
description: type: string
description: A brief summary of the service and its updates.
is_active: type: boolean
description: The status indicating whether the service is active or not.
default: yes
description: A dictionary containing the new details of the service.
name: version_api.VersionApi.get_version
description: Retrieve the application's name and its current version as a JSON object.
parameters: type: dict
name: badge_api.BadgeApi.get_project_vulnerabilities_badge
description: Retrieves the current security vulnerability metrics for a specified project and version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name identifier of the project for which to retrieve vulnerability metrics.
version: type: string
description: The specific version of the project to query for current vulnerabilities.
name: metrics_api.MetricsApi.get_project_current_metrics
description: Retrieves the current metrics associated with a specific project identified by its UUID.
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier (UUID) of the project for which current metrics are being retrieved.
name: badge_api.BadgeApi.get_project_vulnerabilities_badge1
description: Retrieve the current security metrics, such as the number of vulnerabilities, for a specified project using its unique identifier (UUID).
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier (UUID) of the project for which security metrics are being retrieved.
name: BadgeApi.get_project_policy_violations_badge1
description: Generates a badge image indicating the number of policy violations for a specified project and version.
parameters: type: dict
required: project_name
project_version
properties: project_name: type: string
description: The unique name of the project for which the badge is being requested.
project_version: type: string
description: The specific version of the project to check for policy violations.
name: badge_api.BadgeApi.get_project_policy_violations_badge
description: Retrieves a badge image that represents the policy violations status for a specific project based on its UUID.
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier of the project for which the policy violations badge is requested.
name: violationanalysis_api.retrieve_analysis
description: Retrieves a detailed trail of a specific policy violation for a given component, which includes timestamps and related data.
parameters: type: dict
required: component
policyViolation
properties: component: type: string
description: The unique identifier (UUID) of the component for which the analysis trail is requested.
policyViolation: type: string
description: The unique identifier (UUID) of the policy violation to retrieve the analysis trail for.
name: badge_api.BadgeApi.get_project_policy_violations_badge
description: Generates a badge image representing the policy violations status of a specified project.
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier of the project for which the policy violations badge is to be generated.
format: type: string
description: The image format of the badge to be returned.
enum: svg
png
default: svg
style: type: string
description: The style of the badge to be returned.
enum: flat
plastic
flat-square
for-the-badge
social
default: flat
name: BadgeApi.get_project_policy_violations_badge1
description: Retrieves a badge indicating the policy violations status for a specified project and version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name identifier of the project for which the policy violations badge is requested.
version: type: string
description: The version identifier of the project for which the policy violations badge is requested.
name: violation_api.ViolationApi.get_violations_by_project
description: Retrieves a list of all policy violations associated with a given project ID. It can be configured to include suppressed violations as well.
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier of the project for which violations are being queried.
suppressed: type: boolean
description: Determines whether suppressed violations should be included in the results. Suppressed violations are those that have been flagged as not requiring immediate action.
default: no
name: vex_api.VexApi.export_project_as_cyclone_dx1
description: Exports the Vulnerability Exploitability Exchange (VEX) information for a specified project in CycloneDX format. This can be used to integrate with tools that support CycloneDX for security and license compliance.
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier of the project for which the VEX information is to be exported.
download: type: boolean
description: A flag that, when set to true, forces the resulting VEX to be downloaded as a file. If false, the VEX will be returned in the response body.
default: no
name: vex_api.upload_vex1
description: Upload a CycloneDX document for a project. Either a valid project UUID must be provided, or both the projectName and projectVersion must be specified if a UUID is not given.
parameters: type: dict
required: cyclonedx_document
project_name
project_version
properties: cyclonedx_document: type: string
description: The CycloneDX document content encoded in base64.
project_uuid: type: string
description: The unique identifier of the project. If not provided, projectName and projectVersion are required.
project_name: type: string
description: The name of the project. Required if project_uuid is not specified.
project_version: type: string
description: The version of the project. Required if project_uuid is not specified.
name: vex_api.VexApi.upload_vex
description: Uploads a CycloneDX document along with project identification. If a project UUID is not provided, both projectName and projectVersion must be specified to create a new project entry.
parameters: type: dict
required: CycloneDX_document
properties: CycloneDX_document: type: string
description: The CycloneDX document content in XML or JSON format.
project_UUID: type: string
description: The unique identifier of the project. If not provided, projectName and projectVersion are required.
projectName: type: string
description: The name of the project. Required if project_UUID is not provided.
projectVersion: type: string
description: The version of the project. Required if project_UUID is not provided.
name: component_api.ComponentApi.get_component_by_identity
description: Retrieve a list of components that match the specified identity criteria, which include group, name, version, package URL (purl), Common Platform Enumeration (cpe), or Software Identity Tag (swidTagId) of the component.
parameters: type: dict
required: group
name
version
properties: group: type: string
description: The group or namespace of the component.
name: type: string
description: The unique name of the component.
version: type: string
description: The version identifier of the component.
purl: type: string
description: The package URL that uniquely identifies the component.
cpe: type: string
description: The Common Platform Enumeration representation of the component.
swidTagId: type: string
description: The Software Identity Tag for the component as per ISO/IEC 19770-2:2015.
project: type: string
description: The name of the project to which the component belongs.
name: vex_api.VexApi.export_project_as_cyclone_dx1
description: Exports the Vulnerability Exploitability eXchange (VEX) information for a specified project in the CycloneDX format, which can be optionally downloaded as a file.
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The universally unique identifier (UUID) of the project for which the VEX information should be exported.
download: type: boolean
description: When set to true, the resulting VEX will be provided as a downloadable file. Otherwise, it will be returned in the response body.
default: no
name: vex_api.VexApi.upload_vex1
description: Upload a CycloneDX document to a specific project. Requires either a valid project UUID or the combination of a project name and project version.
parameters: type: dict
required: cyclonedx_document
properties: cyclonedx_document: type: string
description: The CycloneDX document content encoded in base64.
project_uuid: type: string
description: The universally unique identifier of the project. If not provided, projectName and projectVersion must be specified.
project_name: type: string
description: The name of the project. Required if project_uuid is not provided.
project_version: type: string
description: The version of the project. Required if project_uuid is not provided.
name: project_api.ProjectApi.get_project_by_name_and_version
description: Fetches the details of a project identified by its unique name and version number.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique identifier name of the project.
version: type: string
description: The release version of the project in semantic versioning format, such as '1.0.0'.
name: badge_api.BadgeApi.get_project_vulnerabilities_badge
description: Retrieve the current security metrics for a specified project version, such as the number of known vulnerabilities.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name of the project for which metrics are being retrieved.
version: type: string
description: The specific version of the project to query. Format should follow semantic versioning, e.g., '1.0.0'.
name: badge_api.BadgeApi.get_project_policy_violations_badge1
description: Generates a badge representing the policy violations for a given project and version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name of the project for which the badge is to be generated.
version: type: string
description: The specific version of the project for which the badge is to be generated.