From aa89cf450ed959cb77016f56be9237643b7008e8 Mon Sep 17 00:00:00 2001 From: crschnick Date: Thu, 12 Sep 2024 21:06:23 +0000 Subject: [PATCH] Small fixes --- .../main/java/io/xpipe/app/util/DataStoreFormatter.java | 6 ++++++ app/src/main/resources/io/xpipe/app/resources/misc/api.md | 8 ++++---- openapi.yaml | 6 +++--- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/app/src/main/java/io/xpipe/app/util/DataStoreFormatter.java b/app/src/main/java/io/xpipe/app/util/DataStoreFormatter.java index e07298477..620cd5f15 100644 --- a/app/src/main/java/io/xpipe/app/util/DataStoreFormatter.java +++ b/app/src/main/java/io/xpipe/app/util/DataStoreFormatter.java @@ -9,8 +9,14 @@ import io.xpipe.core.process.ShellTtyState; import javafx.beans.value.ObservableValue; +import java.util.Arrays; + public class DataStoreFormatter { + public static String join(String... elements) { + return String.join(" ", Arrays.stream(elements).filter(s -> s != null).toList()); + } + public static String formattedOsName(String osName) { osName = osName.replaceAll("^Microsoft ", ""); diff --git a/app/src/main/resources/io/xpipe/app/resources/misc/api.md b/app/src/main/resources/io/xpipe/app/resources/misc/api.md index f8acaf00b..0bfc4db99 100644 --- a/app/src/main/resources/io/xpipe/app/resources/misc/api.md +++ b/app/src/main/resources/io/xpipe/app/resources/misc/api.md @@ -1,5 +1,5 @@ --- -title: XPipe API Documentation v10.0 +title: XPipe API Documentation v11.3 language_tabs: - javascript: JavaScript - python: Python @@ -21,7 +21,7 @@ headingLevel: 2 --- -

XPipe API Documentation v10.0

+

XPipe API Documentation v11.3

The XPipe API provides programmatic access to XPipe’s features. You can get started by either using this page as an API reference or alternatively import the OpenAPI definition file into your API client of choice: @@ -31,7 +31,7 @@ You can get started by either using this page as an API reference or alternative The XPipe application will start up an HTTP server that can be used to send requests. Note that this server is HTTP-only for now as it runs only on localhost. HTTPS requests are not accepted. -You can either call the API directly or using the python API at https://github.com/xpipe-io/xpipe-python-api. +You can either call the API directly or using the official [XPipe Python API](https://github.com/xpipe-io/xpipe-python-api). To start off with the API, you can query connections based on various filters. With the matched connections, you can start remote shell sessions for each one and run arbitrary commands in them. @@ -40,7 +40,7 @@ Any kind of passwords and other secrets are automatically provided by XPipe when If a required password is not stored and is set to be dynamically prompted, the running XPipe application will ask you to enter any required passwords. See the authentication handshake below on how to authenticate prior to sending requests. -For development you can also skip the authentication step by disabling it in the settings menu. +For development, you can also skip the authentication step by disabling it in the settings menu. Base URLs: diff --git a/openapi.yaml b/openapi.yaml index ea39b7bf7..ac4e922a5 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -10,7 +10,7 @@ info: The XPipe application will start up an HTTP server that can be used to send requests. Note that this server is HTTP-only for now as it runs only on localhost. HTTPS requests are not accepted. - You can either call the API directly or using the python API at https://github.com/xpipe-io/xpipe-python-api. + You can either call the API directly or using the official [XPipe Python API](https://github.com/xpipe-io/xpipe-python-api). To start off with the API, you can query connections based on various filters. With the matched connections, you can start remote shell sessions for each one and run arbitrary commands in them. @@ -19,12 +19,12 @@ info: If a required password is not stored and is set to be dynamically prompted, the running XPipe application will ask you to enter any required passwords. See the authentication handshake below on how to authenticate prior to sending requests. - For development you can also skip the authentication step by disabling it in the settings menu. + For development, you can also skip the authentication step by disabling it in the settings menu. termsOfService: https://docs.xpipe.io/terms-of-service contact: name: XPipe - Contact us url: mailto:hello@xpipe.io - version: "10.0" + version: "11.3" externalDocs: description: XPipe - Plans and pricing url: https://xpipe.io/pricing