Skip to content

Commit 329ee1b

Browse files
pcrespovpcrespov
committed
Fixes doc linkx
1 parent 066f6b8 commit 329ee1b

File tree

2 files changed

+62
-64
lines changed

2 files changed

+62
-64
lines changed

‎README.md‎

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -86,46 +86,43 @@ with osparc.ApiClient(cfg) as api_client:
8686

8787
```
8888

89-
9089
## Documentation for API Endpoints
9190

92-
All URIs are relative to *https://api.osparc.io*
93-
94-
Class | Method | HTTP request | Description
95-
-------------|-----------------------------------------------------------------------------------------|-------------------------------------------------|-------------------------------
96-
*FilesApi* | [**download_file**](docs/md/FilesApi.md#download_file) | **GET** /v0/files/{file_id}/content | Download File
97-
*FilesApi* | [**get_file**](docs/md/FilesApi.md#get_file) | **GET** /v0/files/{file_id} | Get File
98-
*FilesApi* | [**list_files**](docs/md/FilesApi.md#list_files) | **GET** /v0/files | List Files
99-
*FilesApi* | [**upload_file**](docs/md/FilesApi.md#upload_file) | **PUT** /v0/files/content | Upload File
100-
*JobsApi* | [**get_job**](docs/md/JobsApi.md#get_job) | **GET** /v0/jobs/{job_id} | Get Job
101-
*JobsApi* | [**get_job_output**](docs/md/JobsApi.md#get_job_output) | **GET** /v0/jobs/{job_id}/outputs/{output_name} | Get Job Output
102-
*JobsApi* | [**inspect_job**](docs/md/JobsApi.md#inspect_job) | **POST** /v0/jobs/{job_id}:inspect | Inspect Job
103-
*JobsApi* | [**list_all_jobs**](docs/md/JobsApi.md#list_all_jobs) | **GET** /v0/jobs | List All Jobs
104-
*JobsApi* | [**list_job_outputs**](docs/md/JobsApi.md#list_job_outputs) | **GET** /v0/jobs/{job_id}/outputs | List Job Outputs
105-
*JobsApi* | [**start_job**](docs/md/JobsApi.md#start_job) | **POST** /v0/jobs/{job_id}:start | Start Job
106-
*JobsApi* | [**stop_job**](docs/md/JobsApi.md#stop_job) | **POST** /v0/jobs/{job_id}:stop | Stop Job
107-
*MetaApi* | [**get_service_metadata**](docs/md/MetaApi.md#get_service_metadata) | **GET** /v0/meta | Get Service Metadata
108-
*SolversApi* | [**create_job**](docs/md/SolversApi.md#create_job) | **POST** /v0/solvers/{solver_id}/jobs | Create Job
109-
*SolversApi* | [**get_solver**](docs/md/SolversApi.md#get_solver) | **GET** /v0/solvers/{solver_id} | Get Solver
110-
*SolversApi* | [**get_solver_by_name_and_version**](docs/md/SolversApi.md#get_solver_by_name_and_version) | **GET** /v0/solvers/{solver_name}/{version} | Get Solver By Name And Version
111-
*SolversApi* | [**list_jobs**](docs/md/SolversApi.md#list_jobs) | **GET** /v0/solvers/{solver_id}/jobs | List Jobs
112-
*SolversApi* | [**list_solvers**](docs/md/SolversApi.md#list_solvers) | **GET** /v0/solvers | List Solvers
113-
*UsersApi* | [**get_my_profile**](docs/md/UsersApi.md#get_my_profile) | **GET** /v0/me | Get My Profile
114-
*UsersApi* | [**update_my_profile**](docs/md/UsersApi.md#update_my_profile) | **PUT** /v0/me | Update My Profile
91+
All URIs are relative to *http://localhost*
92+
93+
Class | Method | HTTP request | Description
94+
------------ | ------------- | ------------- | -------------
95+
*FilesApi* | [**download_file**](docs/md/FilesApi.md#download_file) | **GET** /v0/files/{file_id}/content | Download File
96+
*FilesApi* | [**get_file**](docs/md/FilesApi.md#get_file) | **GET** /v0/files/{file_id} | Get File
97+
*FilesApi* | [**list_files**](docs/md/FilesApi.md#list_files) | **GET** /v0/files | List Files
98+
*FilesApi* | [**upload_file**](docs/md/md/FilesApi.md#upload_file) | **PUT** /v0/files/content | Upload File
99+
*MetaApi* | [**get_service_metadata**](docs/md/md/MetaApi.md#get_service_metadata) | **GET** /v0/meta | Get Service Metadata
100+
*SolversApi* | [**create_job**](docs/md/SolversApi.md#create_job) | **POST** /v0/solvers/{solver_key}/releases/{version}/jobs | Create Job
101+
*SolversApi* | [**get_job**](docs/md/SolversApi.md#get_job) | **GET** /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id} | Get Job
102+
*SolversApi* | [**get_job_outputs**](docs/md/SolversApi.md#get_job_outputs) | **GET** /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/outputs | Get Job Outputs
103+
*SolversApi* | [**get_solver**](docs/md/SolversApi.md#get_solver) | **GET** /v0/solvers/{solver_key}/latest | Get Latest Release of a Solver
104+
*SolversApi* | [**get_solver_release**](docs/md/SolversApi.md#get_solver_release) | **GET** /v0/solvers/{solver_key}/releases/{version} | Get Solver Release
105+
*SolversApi* | [**inspect_job**](docs/md/SolversApi.md#inspect_job) | **POST** /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:inspect | Inspect Job
106+
*SolversApi* | [**list_jobs**](docs/md/SolversApi.md#list_jobs) | **GET** /v0/solvers/{solver_key}/releases/{version}/jobs | List Jobs
107+
*SolversApi* | [**list_solver_releases**](docs/md/SolversApi.md#list_solver_releases) | **GET** /v0/solvers/{solver_key}/releases | List Solver Releases
108+
*SolversApi* | [**list_solvers**](docs/md/SolversApi.md#list_solvers) | **GET** /v0/solvers | List Solvers
109+
*SolversApi* | [**list_solvers_releases**](docs/md/SolversApi.md#list_solvers_releases) | **GET** /v0/solvers/releases | Lists All Releases
110+
*SolversApi* | [**start_job**](docs/md/SolversApi.md#start_job) | **POST** /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:start | Start Job
111+
*SolversApi* | [**stop_job**](docs/md/SolversApi.md#stop_job) | **POST** /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:stop | Stop Job
112+
*UsersApi* | [**get_my_profile**](docs/md/UsersApi.md#get_my_profile) | **GET** /v0/me | Get My Profile
113+
*UsersApi* | [**update_my_profile**](docs/md/UsersApi.md#update_my_profile) | **PUT** /v0/me | Update My Profile
115114

116115

117116
## Documentation For Models
118117

119-
- [BodyUploadFileV0FilesContentPut](docs/md/BodyUploadFileV0FilesContentPut.md)
120-
- [FileMetadata](docs/md/FileMetadata.md)
118+
- [File](docs/md/File.md)
121119
- [Groups](docs/md/Groups.md)
122120
- [HTTPValidationError](docs/md/HTTPValidationError.md)
123121
- [Job](docs/md/Job.md)
124-
- [JobInput](docs/md/JobInput.md)
125-
- [JobOutput](docs/md/JobOutput.md)
122+
- [JobInputs](docs/md/JobInputs.md)
123+
- [JobOutputs](docs/md/JobOutputs.md)
126124
- [JobStatus](docs/md/JobStatus.md)
127125
- [Meta](docs/md/Meta.md)
128-
- [PortValue](docs/md/PortValue.md)
129126
- [Profile](docs/md/Profile.md)
130127
- [ProfileUpdate](docs/md/ProfileUpdate.md)
131128
- [Solver](docs/md/Solver.md)
@@ -134,6 +131,7 @@ Class | Method
134131
- [UsersGroup](docs/md/UsersGroup.md)
135132
- [ValidationError](docs/md/ValidationError.md)
136133

134+
137135
## Documentation For Authorization
138136

139137

‎docs/README.md‎

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -85,48 +85,48 @@ with osparc.ApiClient(cfg) as api_client:
8585

8686
All URIs are relative to *https://api.osparc.io*
8787

88-
Class | Method | HTTP request | Description
89-
-------------|--------------------------------------------------------------------------------------------|-------------------------------------------------|-------------------------------
90-
*FilesApi* | [**download_file**](docs/md/FilesApi.md#download_file) | **GET** /v0/files/{file_id}/content | Download File
91-
*FilesApi* | [**get_file**](docs/md/FilesApi.md#get_file) | **GET** /v0/files/{file_id} | Get File
92-
*FilesApi* | [**list_files**](docs/md/FilesApi.md#list_files) | **GET** /v0/files | List Files
93-
*FilesApi* | [**upload_file**](docs/md/FilesApi.md#upload_file) | **PUT** /v0/files/content | Upload File
94-
*JobsApi* | [**get_job**](docs/md/JobsApi.md#get_job) | **GET** /v0/jobs/{job_id} | Get Job
95-
*JobsApi* | [**get_job_output**](docs/md/JobsApi.md#get_job_output) | **GET** /v0/jobs/{job_id}/outputs/{output_name} | Get Job Output
96-
*JobsApi* | [**inspect_job**](docs/md/JobsApi.md#inspect_job) | **POST** /v0/jobs/{job_id}:inspect | Inspect Job
97-
*JobsApi* | [**list_all_jobs**](docs/md/JobsApi.md#list_all_jobs) | **GET** /v0/jobs | List All Jobs
98-
*JobsApi* | [**list_job_outputs**](docs/md/JobsApi.md#list_job_outputs) | **GET** /v0/jobs/{job_id}/outputs | List Job Outputs
99-
*JobsApi* | [**start_job**](docs/md/JobsApi.md#start_job) | **POST** /v0/jobs/{job_id}:start | Start Job
100-
*JobsApi* | [**stop_job**](docs/md/JobsApi.md#stop_job) | **POST** /v0/jobs/{job_id}:stop | Stop Job
101-
*MetaApi* | [**get_service_metadata**](docs/md/MetaApi.md#get_service_metadata) | **GET** /v0/meta | Get Service Metadata
102-
*SolversApi* | [**create_job**](docs/md/SolversApi.md#create_job) | **POST** /v0/solvers/{solver_id}/jobs | Create Job
103-
*SolversApi* | [**get_solver**](docs/md/SolversApi.md#get_solver) | **GET** /v0/solvers/{solver_id} | Get Solver
104-
*SolversApi* | [**get_solver_by_name_and_version**](docs/md/SolversApi.md#get_solver_by_name_and_version) | **GET** /v0/solvers/{solver_name}/{version} | Get Solver By Name And Version
105-
*SolversApi* | [**list_jobs**](docs/md/SolversApi.md#list_jobs) | **GET** /v0/solvers/{solver_id}/jobs | List Jobs
106-
*SolversApi* | [**list_solvers**](docs/md/SolversApi.md#list_solvers) | **GET** /v0/solvers | List Solvers
107-
*UsersApi* | [**get_my_profile**](docs/md/UsersApi.md#get_my_profile) | **GET** /v0/me | Get My Profile
108-
*UsersApi* | [**update_my_profile**](docs/md/UsersApi.md#update_my_profile) | **PUT** /v0/me | Update My Profile
88+
Class | Method | HTTP request | Description
89+
-------------|-----------------------------------------------------------------------|----------------------------------------------------------------------------|-------------------------------
90+
*FilesApi* | [**download_file**](docs/md/FilesApi.md#download_file) | **GET** /v0/files/{file_id}/content | Download File
91+
*FilesApi* | [**get_file**](docs/md/FilesApi.md#get_file) | **GET** /v0/files/{file_id} | Get File
92+
*FilesApi* | [**list_files**](docs/md/FilesApi.md#list_files) | **GET** /v0/files | List Files
93+
*FilesApi* | [**upload_file**](docs/md/FilesApi.md#upload_file) | **PUT** /v0/files/content | Upload File
94+
*MetaApi* | [**get_service_metadata**](docs/md/MetaApi.md#get_service_metadata) | **GET** /v0/meta | Get Service Metadata
95+
*SolversApi* | [**create_job**](docs/md/SolversApi.md#create_job) | **POST** /v0/solvers/{solver_key}/releases/{version}/jobs | Create Job
96+
*SolversApi* | [**get_job**](docs/md/SolversApi.md#get_job) | **GET** /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id} | Get Job
97+
*SolversApi* | [**get_job_outputs**](docs/md/SolversApi.md#get_job_outputs) | **GET** /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/outputs | Get Job Outputs
98+
*SolversApi* | [**get_solver**](docs/md/SolversApi.md#get_solver) | **GET** /v0/solvers/{solver_key}/latest | Get Latest Release of a Solver
99+
*SolversApi* | [**get_solver_release**](docs/md/SolversApi.md#get_solver_release) | **GET** /v0/solvers/{solver_key}/releases/{version} | Get Solver Release
100+
*SolversApi* | [**inspect_job**](docs/md/SolversApi.md#inspect_job) | **POST** /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:inspect | Inspect Job
101+
*SolversApi* | [**list_jobs**](docs/md/SolversApi.md#list_jobs) | **GET** /v0/solvers/{solver_key}/releases/{version}/jobs | List Jobs
102+
*SolversApi* | [**list_solver_releases**](docs/md/SolversApi.md#list_solver_releases) | **GET** /v0/solvers/{solver_key}/releases | List Solver Releases
103+
*SolversApi* | [**list_solvers**](docs/md/SolversApi.md#list_solvers) | **GET** /v0/solvers | List Solvers
104+
*SolversApi* | [**list_solvers_releases**](docs/md/SolversApi.md#list_solvers_releases) | **GET** /v0/solvers/releases | Lists All Releases
105+
*SolversApi* | [**start_job**](docs/md/SolversApi.md#start_job) | **POST** /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:start | Start Job
106+
*SolversApi* | [**stop_job**](docs/md/SolversApi.md#stop_job) | **POST** /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:stop | Stop Job
107+
*UsersApi* | [**get_my_profile**](docs/md/UsersApi.md#get_my_profile) | **GET** /v0/me | Get My Profile
108+
*UsersApi* | [**update_my_profile**](docs/md/UsersApi.md#update_my_profile) | **PUT** /v0/me | Update My Profile
109109

110110

111111
## Documentation For Models
112112

113113
- [BodyUploadFileV0FilesContentPut](docs/md/BodyUploadFileV0FilesContentPut.md)
114-
- [FileMetadata](docs/md/FileMetadata.md)
114+
- [File](docs/md/File.md)
115115
- [Groups](docs/md/Groups.md)
116116
- [HTTPValidationError](docs/md/HTTPValidationError.md)
117-
- [Job](docs/md/Job.md)
118-
- [JobInput](docs/md/JobInput.md)
119-
- [JobOutput](docs/md/JobOutput.md)
120-
- [JobStatus](docs/md/JobStatus.md)
121-
- [Meta](docs/md/Meta.md)
122-
- [PortValue](docs/md/PortValue.md)
123-
- [Profile](docs/md/Profile.md)
124-
- [ProfileUpdate](docs/md/ProfileUpdate.md)
125-
- [Solver](docs/md/Solver.md)
126-
- [TaskStates](docs/md/TaskStates.md)
127-
- [UserRoleEnum](docs/md/UserRoleEnum.md)
128-
- [UsersGroup](docs/md/UsersGroup.md)
129-
- [ValidationError](docs/md/ValidationError.md)
117+
- [Job](docs/Job.md)
118+
- [JobInputs](docs/JobInputs.md)
119+
- [JobOutputs](docs/JobOutputs.md)
120+
- [JobStatus](docs/JobStatus.md)
121+
- [Meta](docs/Meta.md)
122+
- [Profile](docs/Profile.md)
123+
- [ProfileUpdate](docs/ProfileUpdate.md)
124+
- [Solver](docs/Solver.md)
125+
- [TaskStates](docs/TaskStates.md)
126+
- [UserRoleEnum](docs/UserRoleEnum.md)
127+
- [UsersGroup](docs/UsersGroup.md)
128+
- [ValidationError](docs/ValidationError.md)
129+
130130

131131
## Documentation For Authorization
132132

0 commit comments

Comments
 (0)