README

This is client library for Nexus Package Manager's REST API.

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

API version: 3.16.1-02
Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 7.2 and later
Guzzle 6 (will be installed via composer)

Installation & Usage

Composer

$ composer require apiida/nexus-client-api

Then run composer install

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Apiida\Nexus\Client\Api\AssetsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = "id_example"; // string | Id of the asset to delete

try {
    $apiInstance->deleteAsset($id);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->deleteAsset: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://localhost/service/rest/

Class	Method	HTTP request	Description
AssetsApi	deleteAsset	DELETE /v1/assets/{id}	Delete a single asset
AssetsApi	getAssetById	GET /v1/assets/{id}	Get a single asset
AssetsApi	getAssets	GET /v1/assets	List assets
BlobStoreApi	quotaStatus	GET /v1/blobstores/{id}/quota-status	Get quota status for a given blob store
ComponentsApi	deleteComponent	DELETE /v1/components/{id}	Delete a single component
ComponentsApi	getComponentById	GET /v1/components/{id}	Get a single component
ComponentsApi	getComponents	GET /v1/components	List components
ComponentsApi	uploadComponent	POST /v1/components	Upload a single component
FormatsApi	get1	GET /v1/formats/upload-specs	Get upload field requirements for each supported format
FormatsApi	get2	GET /v1/formats/{format}/upload-specs	Get upload field requirements for the desired format
LifecycleApi	bounce	PUT /v1/lifecycle/bounce	Bounce lifecycle phase
LifecycleApi	getPhase	GET /v1/lifecycle/phase	Get current lifecycle phase
LifecycleApi	setPhase	PUT /v1/lifecycle/phase	Move to new lifecycle phase
ReadOnlyApi	forceRelease	POST /v1/read-only/force-release	Forcibly release read-only
ReadOnlyApi	freeze	POST /v1/read-only/freeze	Enable read-only
ReadOnlyApi	get	GET /v1/read-only	Get read-only state
ReadOnlyApi	release	POST /v1/read-only/release	Release read-only
RepositoriesApi	getRepositories	GET /v1/repositories	List repositories
ScriptApi	add	POST /v1/script	Add a new script
ScriptApi	browse	GET /v1/script	List all stored scripts
ScriptApi	delete	DELETE /v1/script/{name}	Delete stored script by name
ScriptApi	edit	PUT /v1/script/{name}	Update stored script by name
ScriptApi	read	GET /v1/script/{name}	Read stored script by name
ScriptApi	run1	POST /v1/script/{name}/run	Run stored script by name
SearchApi	search	GET /v1/search	Search components
SearchApi	searchAndDownloadAssets	GET /v1/search/assets/download	Search and download asset
SearchApi	searchAssets	GET /v1/search/assets	Search assets
StatusApi	isAvailable	GET /v1/status	Health check endpoint that validates server can respond to read requests
StatusApi	isWritable	GET /v1/status/writable	Health check endpoint that validates server can respond to read and write requests
SupportApi	supportzip	POST /v1/support/supportzip	Creates and downloads a support zip
TasksApi	getTaskById	GET /v1/tasks/{id}	Get a single task by id
TasksApi	getTasks	GET /v1/tasks	List tasks
TasksApi	run	POST /v1/tasks/{id}/run	Run task
TasksApi	stop	POST /v1/tasks/{id}/stop	Stop task

apiida / nexus-client-api

Maintainers

Details