Skip to content

Commit

Permalink
Hide alpha docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ebouck committed Sep 20, 2023
1 parent a4b01e9 commit 724241e
Show file tree
Hide file tree
Showing 12 changed files with 33 additions and 19 deletions.
4 changes: 2 additions & 2 deletions packages/@runlightyear/gcal/src/GoogleCalendar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ import {
} from "./listeners/onUpdatedEvents";

/**
* @beta
* @alpha
*/
export interface GoogleCalendarProps extends AuthConnectorProps {}

/**
* Google Calendar connector
*
* @beta
* @alpha
*
* @example Install
* ```
Expand Down
4 changes: 2 additions & 2 deletions packages/@runlightyear/gcal/src/GoogleCalendarOAuth.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { OAuthConnectorProps, OAuthConnector } from "@runlightyear/lightyear";

/**
* @beta
* @alpha
*/
export interface GoogleCalendarOAuthProps extends OAuthConnectorProps {}

/**
* @beta
* @alpha
*/
export class GoogleCalendarOAuth extends OAuthConnector {
scopes = ["https://www.googleapis.com/auth/calendar"];
Expand Down
4 changes: 2 additions & 2 deletions packages/@runlightyear/gmail/src/Gmail.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { AuthConnectorProps, RestConnector } from "@runlightyear/lightyear";

/**
* @beta
* @alpha
*/
export interface GmailProps extends AuthConnectorProps {}

/**
* @beta
* @alpha
*/
export class Gmail extends RestConnector {
constructor(props: GmailProps) {
Expand Down
4 changes: 2 additions & 2 deletions packages/@runlightyear/gmail/src/GmailOAuth.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { OAuthConnectorProps, OAuthConnector } from "@runlightyear/lightyear";

/**
* @beta
* @alpha
*/
export interface GmailOAuthProps extends OAuthConnectorProps {}

/**
* @beta
* @alpha
*/
export class GmailOAuth extends OAuthConnector {
scopes = [
Expand Down
4 changes: 2 additions & 2 deletions packages/@runlightyear/linear/src/Linear.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ import {
} from "./helpers/findWorkflowStateByName";

/**
* @beta
* @alpha
*/
export interface LinearProps extends AuthConnectorProps {}

/**
* @beta
* @alpha
*
* Connector to the Linear API
*
Expand Down
4 changes: 2 additions & 2 deletions packages/@runlightyear/linear/src/LinearOAuth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { OAuthConnector, OAuthConnectorProps } from "@runlightyear/lightyear";
import { LinearScope } from "./types/LinearScope";

/**
* @beta
* @alpha
*/
export interface LinearOAuthProps extends OAuthConnectorProps {
/**
Expand All @@ -27,7 +27,7 @@ export interface LinearOAuthProps extends OAuthConnectorProps {
}

/**
* @beta
* @alpha
*/
export class LinearOAuth extends OAuthConnector {
scope: LinearScope[];
Expand Down
4 changes: 2 additions & 2 deletions packages/@runlightyear/salesforce/src/Salesforce.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { query, QueryProps } from "./query/query";
import { describeObject, DescribeObjectProps } from "./describe/describeObject";

/**
* @beta
* @alpha
*/
export interface SalesforceProps extends AuthConnectorProps {
domain: string;
Expand All @@ -16,7 +16,7 @@ export interface SalesforceProps extends AuthConnectorProps {
/**
* Salesforce connector
*
* @beta
* @alpha
*
* @example Install
* ```
Expand Down
2 changes: 1 addition & 1 deletion packages/@runlightyear/salesforce/src/SalesforceOAuth.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { dayjsUtc } from "@runlightyear/lightyear";
export interface SalesforceOAuthProps extends OAuthConnectorProps {}

/**
* @beta
* @alpha
*/
export class SalesforceOAuth extends OAuthConnector {
scopes = ["full", "refresh_token"];
Expand Down
8 changes: 8 additions & 0 deletions packages/@runlightyear/salesforce/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
/**
* Salesforce Connectors for Lightyear
*
* @alpha
*
* @packageDocumentation
*/

export { Salesforce } from "./Salesforce";
export type { SalesforceProps } from "./Salesforce";

Expand Down
4 changes: 2 additions & 2 deletions packages/@runlightyear/zoom/src/Zoom.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ import {
} from "./listeners/onNewRecordings";

/**
* @beta
* @alpha
*/
export interface ZoomProps extends AuthConnectorProps {}

/**
* Zoom Connector
*
* @beta
* @alpha
*
* @example Install
* ```
Expand Down
4 changes: 2 additions & 2 deletions packages/@runlightyear/zoom/src/ZoomOAuth.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { OAuthConnector, OAuthConnectorProps } from "@runlightyear/lightyear";

/**
* @beta
* @alpha
*/
export interface ZoomOAuthProps extends OAuthConnectorProps {}

/**
* @beta
* @alpha
*/
export class ZoomOAuth extends OAuthConnector {
constructor(props: ZoomOAuthProps) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -578,6 +578,12 @@ export class MarkdownDocumenter {
});

for (const apiMember of apiModel.members) {
// skip if no classes
const pkg = apiMember.members[0];
if (!pkg.members.find((member) => member.kind === ApiItemKind.Class)) {
continue;
}

const row: DocTableRow = new DocTableRow({ configuration }, [
this._createTitleCell(apiMember),
this._createDescriptionCell(apiMember),
Expand Down

0 comments on commit 724241e

Please sign in to comment.