OpenPodcast API
- API version: 0.1.0
- Build date: 2024-07-17T20:17:50.894234-10:00[Pacific/Honolulu]
- Generator version: 7.7.0
This is the OpenAPI specification for the OpenPodcast API
Automatically generated by the OpenAPI Generator
Building the API client library requires:
- Java 1.8+
- Maven (3.8.3+)/Gradle (7.2+)
To install the API client library to your local Maven repository, simply execute:
mvn clean install
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
mvn clean deploy
Refer to the OSSRH Guide for more information.
Add this dependency to your project's POM:
<dependency>
<groupId>org.openapitools</groupId>
<artifactId>openapi-java-client</artifactId>
<version>0.1.0</version>
<scope>compile</scope>
</dependency>
Add this dependency to your project's build file:
repositories {
mavenCentral() // Needed if the 'openapi-java-client' jar has been published to maven central.
mavenLocal() // Needed if the 'openapi-java-client' jar has been published to the local maven repo.
}
dependencies {
implementation "org.openapitools:openapi-java-client:0.1.0"
}
At first generate the JAR by executing:
mvn clean package
Then manually install the following JARs:
target/openapi-java-client-0.1.0.jar
target/lib/*.jar
Please follow the installation instruction and execute the following Java code:
// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.SubscriptionsApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://localhost");
// Configure OAuth2 access token for authorization: podcast_auth
OAuth podcast_auth = (OAuth) defaultClient.getAuthentication("podcast_auth");
podcast_auth.setAccessToken("YOUR ACCESS TOKEN");
SubscriptionsApi apiInstance = new SubscriptionsApi(defaultClient);
FeedArray feedArray = new FeedArray(); // FeedArray | An array of feeds the user wants to subscribe to
try {
NewSubscriptions result = apiInstance.addSubscription(feedArray);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SubscriptionsApi#addSubscription");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
SubscriptionsApi | addSubscription | POST /subscriptions | Add new subscriptions for the authenticated user |
SubscriptionsApi | deleteSubscription | DELETE /subscriptions/{guid} | Delete a single subscription entry |
SubscriptionsApi | getDeletions | GET /deletions/{id} | Retrieve information subscription deletion |
SubscriptionsApi | getSubscription | GET /subscriptions/{guid} | Retrieve information about a single subscription |
SubscriptionsApi | getSubscriptions | GET /subscriptions | Retrieve all updated subscription information |
SubscriptionsApi | updateSubscription | PATCH /subscriptions/{guid} | Update a single subscription entry |
- Deletion
- Error
- FailedSubscription
- FeedArray
- FeedArraySubscriptionsInner
- NewSubscription
- NewSubscriptions
- PatchedSubscription
- Subscription
- SubscriptionUpdate
- Subscriptions
- Success
Authentication schemes defined for the API:
- Type: OAuth
- Flow: implicit
- Authorization URL: https://test.openpodcastapi.com/oauth/authorize
- Scopes:
- write:subscriptions: modify subscription information for your account
- read:subscriptions: read your subscription information
- Type: API key
- API key parameter name: api_key
- Location: HTTP header
It's recommended to create an instance of ApiClient
per thread in a multithreaded environment to avoid any potential issues.