Skip to content

api.md

Latest commit

 

History

History
1288 lines (938 loc) · 40.1 KB

api.md

File metadata and controls

1288 lines (938 loc) · 40.1 KB
Raw

Scalar Java API

Complete reference of every operation, grouped by resource. See the README for usage and configuration.

Contents

Setup

import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

Registry

Registry

List all API Documents

List all API documents across every namespace the caller can access.

Direction Type
Request RegistryListAllApiDocumentsParams
Response List<RegistryListAllApiDocumentsResponse> 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

var registry = client.registry().listAllApiDocuments();

System.out.println(registry);

List API Documents in a namespace

List API documents in a namespace.

Direction Type
Request RegistryListApiDocumentsParams
Response List<RegistryListApiDocumentsResponse> 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.RegistryListApiDocumentsParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RegistryListApiDocumentsParams params =
    RegistryListApiDocumentsParams.builder().namespace("namespace").build();
var registry = client.registry().listApiDocuments(params);

System.out.println(registry);

Create API Document

Create an API document.

Direction Type
Request RegistryCreateApiDocumentParams
Response RegistryCreateApiDocumentResponse 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.RegistryCreateApiDocumentParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RegistryCreateApiDocumentParams params =
    RegistryCreateApiDocumentParams.builder()
        .namespace("namespace")
        .title("")
        .version("x")
        .slug("")
        .document("")
        .build();
var registry = client.registry().createApiDocument(params);

System.out.println(registry);

Update API Document metadata

Update metadata for an API document.

Direction Type
Request RegistryUpdateApiDocumentParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.RegistryUpdateApiDocumentParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RegistryUpdateApiDocumentParams params =
    RegistryUpdateApiDocumentParams.builder().namespace("namespace").slug("slug").build();
var registry = client.registry().updateApiDocument(params);

System.out.println(registry);

Delete API Document

Delete an API document and all versions.

Direction Type
Request RegistryDeleteApiDocumentParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.RegistryDeleteApiDocumentParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RegistryDeleteApiDocumentParams params =
    RegistryDeleteApiDocumentParams.builder().namespace("namespace").slug("slug").build();
var registry = client.registry().deleteApiDocument(params);

System.out.println(registry);

Get API Document

Get a specific API document version.

Direction Type
Request RegistryRetrieveApiDocumentVersionParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.RegistryRetrieveApiDocumentVersionParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RegistryRetrieveApiDocumentVersionParams params =
    RegistryRetrieveApiDocumentVersionParams.builder()
        .namespace("namespace")
        .slug("slug")
        .semver("semver")
        .build();
var registry = client.registry().retrieveApiDocumentVersion(params);

System.out.println(registry);

Update API Document version

Update the registry file content for an API document version.

Direction Type
Request RegistryUpdateApiDocumentVersionParams
Response RegistryUpdateApiDocumentVersionResponse 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.RegistryUpdateApiDocumentVersionParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RegistryUpdateApiDocumentVersionParams params =
    RegistryUpdateApiDocumentVersionParams.builder()
        .namespace("namespace")
        .slug("slug")
        .semver("semver")
        .document("")
        .build();
var registry = client.registry().updateApiDocumentVersion(params);

System.out.println(registry);

Delete API Document version

Delete a specific API document version.

Direction Type
Request RegistryDeleteApiDocumentVersionParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.RegistryDeleteApiDocumentVersionParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RegistryDeleteApiDocumentVersionParams params =
    RegistryDeleteApiDocumentVersionParams.builder()
        .namespace("namespace")
        .slug("slug")
        .semver("semver")
        .build();
var registry = client.registry().deleteApiDocumentVersion(params);

System.out.println(registry);

Get API Document version metadata

Get metadata (uid, content shas, version sha, tags) for a specific API document version.

Direction Type
Request RegistryListApiDocumentVersionMetadataParams
Response ManagedDocVersion 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.RegistryListApiDocumentVersionMetadataParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RegistryListApiDocumentVersionMetadataParams params =
    RegistryListApiDocumentVersionMetadataParams.builder()
        .namespace("namespace")
        .slug("slug")
        .semver("semver")
        .build();
var registry = client.registry().listApiDocumentVersionMetadata(params);

System.out.println(registry);

Create API Document version

Create a new API document version.

Direction Type
Request RegistryCreateApiDocumentVersionParams
Response ManagedDocVersion 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.RegistryCreateApiDocumentVersionParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RegistryCreateApiDocumentVersionParams params =
    RegistryCreateApiDocumentVersionParams.builder()
        .namespace("namespace")
        .slug("slug")
        .version("x")
        .document("")
        .build();
var registry = client.registry().createApiDocumentVersion(params);

System.out.println(registry);

Add access group

Add an access group to an API document.

Direction Type
Request RegistryCreateApiDocumentAccessGroupParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.AccessGroup;
import com.scalar.models.registry.RegistryCreateApiDocumentAccessGroupParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RegistryCreateApiDocumentAccessGroupParams params =
    RegistryCreateApiDocumentAccessGroupParams.builder()
        .namespace("namespace")
        .slug("slug")
        .accessGroup(AccessGroup.builder().accessGroupSlug("xxx").build())
        .build();
var registry = client.registry().createApiDocumentAccessGroup(params);

System.out.println(registry);

Remove access group

Remove an access group from an API document.

Direction Type
Request RegistryDeleteApiDocumentAccessGroupParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.AccessGroup;
import com.scalar.models.registry.RegistryDeleteApiDocumentAccessGroupParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RegistryDeleteApiDocumentAccessGroupParams params =
    RegistryDeleteApiDocumentAccessGroupParams.builder()
        .namespace("namespace")
        .slug("slug")
        .accessGroup(AccessGroup.builder().accessGroupSlug("xxx").build())
        .build();
var registry = client.registry().deleteApiDocumentAccessGroup(params);

System.out.println(registry);

Schemas

Schemas

List all shared components

List schemas in a namespace.

Direction Type
Request SchemaListParams
Response List<SchemaListResponse> 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.schemas.SchemaListParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

SchemaListParams params = SchemaListParams.builder().namespace("namespace").build();
var schema = client.schemas().list(params);

System.out.println(schema);

Create a shared component

Create a schema in a namespace.

Direction Type
Request SchemaCreateParams
Response Uid 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.schemas.SchemaCreateParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

SchemaCreateParams params =
    SchemaCreateParams.builder()
        .namespace("namespace")
        .title("")
        .version("x")
        .slug("")
        .document("")
        .build();
var schema = client.schemas().create(params);

System.out.println(schema);

Update shared component metadata

Update schema metadata.

Direction Type
Request SchemaUpdateParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.schemas.SchemaUpdateParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

SchemaUpdateParams params =
    SchemaUpdateParams.builder().namespace("namespace").slug("slug").build();
var schema = client.schemas().update(params);

System.out.println(schema);

Delete a shared component

Delete a schema and all related versions.

Direction Type
Request SchemaDeleteParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.schemas.SchemaDeleteParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

SchemaDeleteParams params =
    SchemaDeleteParams.builder().namespace("namespace").slug("slug").build();
var schema = client.schemas().delete(params);

System.out.println(schema);

Schemas Version

Schemas

Get a shared component document

Get a specific schema version document.

Direction Type
Request VersionRetrieveParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.schemas.version.VersionRetrieveParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

VersionRetrieveParams params =
    VersionRetrieveParams.builder()
        .namespace("namespace")
        .slug("slug")
        .semver("semver")
        .build();
var version = client.schemas().version().retrieve(params);

System.out.println(version);

Delete a shared component version

Delete a schema version.

Direction Type
Request VersionDeleteParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.schemas.version.VersionDeleteParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

VersionDeleteParams params =
    VersionDeleteParams.builder().namespace("namespace").slug("slug").semver("semver").build();
var version = client.schemas().version().delete(params);

System.out.println(version);

Create a shared component version

Create a schema version.

Direction Type
Request VersionCreateParams
Response Uid 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.schemas.version.VersionCreateParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

VersionCreateParams params =
    VersionCreateParams.builder()
        .namespace("namespace")
        .slug("slug")
        .version("x")
        .document("")
        .build();
var version = client.schemas().version().create(params);

System.out.println(version);

Schemas AccessGroup

Schemas

Add shared component access group

Add an access group to a schema.

Direction Type
Request AccessGroupCreateParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.AccessGroup;
import com.scalar.models.schemas.accessGroup.AccessGroupCreateParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

AccessGroupCreateParams params =
    AccessGroupCreateParams.builder()
        .namespace("namespace")
        .slug("slug")
        .accessGroup(AccessGroup.builder().accessGroupSlug("xxx").build())
        .build();
var accessGroup = client.schemas().accessGroup().create(params);

System.out.println(accessGroup);

Remove shared component access group

Remove an access group from a schema.

Direction Type
Request AccessGroupDeleteParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.AccessGroup;
import com.scalar.models.schemas.accessGroup.AccessGroupDeleteParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

AccessGroupDeleteParams params =
    AccessGroupDeleteParams.builder()
        .namespace("namespace")
        .slug("slug")
        .accessGroup(AccessGroup.builder().accessGroupSlug("xxx").build())
        .build();
var accessGroup = client.schemas().accessGroup().delete(params);

System.out.println(accessGroup);

LoginPortals

Login Portals

Get a login portal

Get a login portal by slug.

Direction Type
Request LoginPortalRetrieveParams
Response LoginPortalRetrieveResponse 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.loginPortals.LoginPortalRetrieveParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

LoginPortalRetrieveParams params = LoginPortalRetrieveParams.builder().slug("slug").build();
var loginPortal = client.loginPortals().retrieve(params);

System.out.println(loginPortal);

Update portal metadata

Update metadata for a login portal.

Direction Type
Request LoginPortalUpdateParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.loginPortals.LoginPortalUpdateParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

LoginPortalUpdateParams params = LoginPortalUpdateParams.builder().slug("slug").build();
var loginPortal = client.loginPortals().update(params);

System.out.println(loginPortal);

Delete a login portal

Delete a login portal.

Direction Type
Request LoginPortalDeleteParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.loginPortals.LoginPortalDeleteParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

LoginPortalDeleteParams params = LoginPortalDeleteParams.builder().slug("slug").build();
var loginPortal = client.loginPortals().delete(params);

System.out.println(loginPortal);

Create a portal

Create a login portal for the current team.

Direction Type
Request LoginPortalCreateParams
Response Uid 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.loginPortals.LoginPortalCreateParams;
import com.scalar.models.loginPortals.LoginPortalEmail;
import com.scalar.models.loginPortals.LoginPortalPage;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

LoginPortalCreateParams params =
    LoginPortalCreateParams.builder()
        .title("")
        .slug("")
        .email(
            LoginPortalEmail.builder()
                .logo("")
                .logoSize("100")
                .buttonText("Login")
                .message("Click to access private documentation hosted by scalar.com")
                .title("Private Docs")
                .mainColor("#2a2f45")
                .mainBackground("#f6f6f6")
                .cardColor("2a2f45")
                .cardBackground("#fff")
                .buttonColor("#fff")
                .buttonBackground("#0f0f0f")
                .build())
        .page(
            LoginPortalPage.builder()
                .title("Scalar Private Docs")
                .description("Login to access your documentation")
                .head("")
                .script("")
                .theme("")
                .companyName("")
                .logo("")
                .logoUrl("")
                .favicon("")
                .termsLink("")
                .privacyLink("")
                .formTitle("Scalar Private Docs")
                .formDescription("Login to access your documentation")
                .formImage("")
                .build())
        .build();
var loginPortal = client.loginPortals().create(params);

System.out.println(loginPortal);

List all portals

List all login portals for the current team.

Direction Type
Request LoginPortalListParams
Response List<LoginPortalListResponse> 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

var loginPortal = client.loginPortals().list();

System.out.println(loginPortal);

Rules

Rules

List all rules

List all rulesets in a namespace.

Direction Type
Request RuleListRulesetsParams
Response List<RuleListRulesetsResponse> 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.rules.RuleListRulesetsParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RuleListRulesetsParams params = RuleListRulesetsParams.builder().namespace("namespace").build();
var rule = client.rules().listRulesets(params);

System.out.println(rule);

Create a rule

Create a rule in a namespace.

Direction Type
Request RuleCreateRulesetParams
Response Uid 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.rules.RuleCreateRulesetParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RuleCreateRulesetParams params =
    RuleCreateRulesetParams.builder()
        .namespace("namespace")
        .title("")
        .slug("")
        .document("")
        .build();
var rule = client.rules().createRuleset(params);

System.out.println(rule);

Update rule metadata

Update rule metadata by slug.

Direction Type
Request RuleUpdateRulesetParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.rules.RuleUpdateRulesetParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RuleUpdateRulesetParams params =
    RuleUpdateRulesetParams.builder()
        .pathNamespace("pathNamespace")
        .pathSlug("pathSlug")
        .build();
var rule = client.rules().updateRuleset(params);

System.out.println(rule);

Delete a rule

Delete a rule by slug.

Direction Type
Request RuleDeleteRulesetParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.rules.RuleDeleteRulesetParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RuleDeleteRulesetParams params =
    RuleDeleteRulesetParams.builder().namespace("namespace").slug("slug").build();
var rule = client.rules().deleteRuleset(params);

System.out.println(rule);

Get a rule

Get a rule document by slug.

Direction Type
Request RuleRetrieveRulesetDocumentParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.rules.RuleRetrieveRulesetDocumentParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RuleRetrieveRulesetDocumentParams params =
    RuleRetrieveRulesetDocumentParams.builder().namespace("namespace").slug("slug").build();
var rule = client.rules().retrieveRulesetDocument(params);

System.out.println(rule);

Add rule access group

Grant an access group to a rule.

Direction Type
Request RuleCreateRulesetAccessGroupParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.AccessGroup;
import com.scalar.models.rules.RuleCreateRulesetAccessGroupParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RuleCreateRulesetAccessGroupParams params =
    RuleCreateRulesetAccessGroupParams.builder()
        .namespace("namespace")
        .slug("slug")
        .accessGroup(AccessGroup.builder().accessGroupSlug("xxx").build())
        .build();
var rule = client.rules().createRulesetAccessGroup(params);

System.out.println(rule);

Remove rule access group

Remove an access group from a rule.

Direction Type
Request RuleDeleteRulesetAccessGroupParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.registry.AccessGroup;
import com.scalar.models.rules.RuleDeleteRulesetAccessGroupParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

RuleDeleteRulesetAccessGroupParams params =
    RuleDeleteRulesetAccessGroupParams.builder()
        .namespace("namespace")
        .slug("slug")
        .accessGroup(AccessGroup.builder().accessGroupSlug("xxx").build())
        .build();
var rule = client.rules().deleteRulesetAccessGroup(params);

System.out.println(rule);

Themes

Themes

List all themes

List all team themes.

Direction Type
Request ThemeListParams
Response List<ThemeListResponse> 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

var theme = client.themes().list();

System.out.println(theme);

Create a theme

Create a team theme.

Direction Type
Request ThemeCreateParams
Response Uid 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.themes.ThemeCreateParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

ThemeCreateParams params = ThemeCreateParams.builder().name("").slug("").document("").build();
var theme = client.themes().create(params);

System.out.println(theme);

Update theme metadata

Update theme metadata.

Direction Type
Request ThemeUpdateParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.themes.ThemeUpdateParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

ThemeUpdateParams params = ThemeUpdateParams.builder().slug("slug").build();
var theme = client.themes().update(params);

System.out.println(theme);

Update theme document

Replace the theme document.

Direction Type
Request ThemeReplaceDocumentParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.themes.ThemeReplaceDocumentParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

ThemeReplaceDocumentParams params =
    ThemeReplaceDocumentParams.builder().slug("slug").document("").build();
var theme = client.themes().replaceDocument(params);

System.out.println(theme);

Delete a theme

Delete a theme by slug.

Direction Type
Request ThemeDeleteParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.themes.ThemeDeleteParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

ThemeDeleteParams params = ThemeDeleteParams.builder().slug("slug").build();
var theme = client.themes().delete(params);

System.out.println(theme);

Get a theme

Get the theme document by slug.

Direction Type
Request ThemeRetrieveParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.themes.ThemeRetrieveParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

ThemeRetrieveParams params = ThemeRetrieveParams.builder().slug("slug").build();
var theme = client.themes().retrieve(params);

System.out.println(theme);

Teams

Teams

List teams

List all available teams

Direction Type
Request TeamListParams
Response List<TeamListResponse> 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

var team = client.teams().list();

System.out.println(team);

ScalarDocs

Scalar Docs

List all projects

List all guide projects.

Direction Type
Request ScalarDocListGuidesParams
Response List<ScalarDocListGuidesResponse> 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

var scalarDoc = client.scalarDocs().listGuides();

System.out.println(scalarDoc);

Create a project

Create a guide project.

Direction Type
Request ScalarDocCreateGuideParams
Response ScalarDocCreateGuideResponse 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.scalarDocs.ScalarDocCreateGuideParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

ScalarDocCreateGuideParams params =
    ScalarDocCreateGuideParams.builder()
        .name("")
        .isPrivate(false)
        .allowedUsers(java.util.List.of())
        .allowedDomains(java.util.List.of())
        .build();
var scalarDoc = client.scalarDocs().createGuide(params);

System.out.println(scalarDoc);

Publish a project

Start a new publish process.

Direction Type
Request ScalarDocPublishGuideParams
Response ScalarDocPublishGuideResponse 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.scalarDocs.ScalarDocPublishGuideParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

ScalarDocPublishGuideParams params = ScalarDocPublishGuideParams.builder().slug("slug").build();
var scalarDoc = client.scalarDocs().publishGuide(params);

System.out.println(scalarDoc);

Namespaces

Namespaces

List namespaces

Get all namespaces for the current team

Direction Type
Request NamespaceListParams 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

var namespace = client.namespaces().list();

System.out.println(namespace);

Authentication

Authentication

Exchange token

Exchange an API key for an access token.

Direction Type
Request AuthenticationExchangePersonalTokenParams
Response AuthenticationExchangePersonalTokenResponse 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;
import com.scalar.models.authentication.AuthenticationExchangePersonalTokenParams;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

AuthenticationExchangePersonalTokenParams params =
    AuthenticationExchangePersonalTokenParams.builder().personalToken("").build();
var authentication = client.authentication().exchangePersonalToken(params);

System.out.println(authentication);

Get current user

Get the authenticated user, including their available teams and theme.

Direction Type
Request AuthenticationListCurrentUserParams
Response AuthenticationListCurrentUserResponse 
import com.scalar.client.ScalarClient;
import com.scalar.client.okhttp.ScalarOkHttpClient;

ScalarClient client =
    ScalarOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();

var authentication = client.authentication().listCurrentUser();

System.out.println(authentication);