Skip to content

Commit

Permalink
- Update API docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
konstantin-msft committed Sep 27, 2024
1 parent 00270d9 commit 2df0f85
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions lib/msal-common/apiReview/msal-common.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ declare namespace AADServerParamKeys {
SID,
LOGIN_HINT,
DOMAIN_HINT,
X_CLIENT_EXTRA_SKU
X_CLIENT_EXTRA_SKU,
BROKER_CLIENT_ID,
BROKER_REDIRECT_URI
}
}
export { AADServerParamKeys }
Expand Down Expand Up @@ -603,6 +605,7 @@ export type BaseAuthRequest = {
storeInCache?: StoreInCache;
scenarioId?: string;
popKid?: string;
brokerParameters?: BrokerParameters;
};

// Warning: (ae-internal-missing-underscore) The name "BaseClient" should be prefixed with an underscore because the declaration is marked as @internal
Expand Down Expand Up @@ -647,6 +650,16 @@ export abstract class BaseClient {
// @public (undocumented)
const bindingKeyNotRemoved = "binding_key_not_removed";

// Warning: (ae-missing-release-tag) "BROKER_CLIENT_ID" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
const BROKER_CLIENT_ID = "brk_client_id";

// Warning: (ae-missing-release-tag) "BROKER_REDIRECT_URI" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
const BROKER_REDIRECT_URI = "brk_redirect_uri";

// Warning: (ae-incompatible-release-tags) The symbol "buildAccountToCache" is marked as @public, but its signature references "CacheManager" which is marked as @internal
// Warning: (ae-incompatible-release-tags) The symbol "buildAccountToCache" is marked as @public, but its signature references "Authority" which is marked as @internal
// Warning: (ae-incompatible-release-tags) The symbol "buildAccountToCache" is marked as @public, but its signature references "AccountEntity" which is marked as @internal
Expand Down Expand Up @@ -1574,6 +1587,7 @@ export type CommonEndSessionRequest = {
state?: string;
logoutHint?: string;
extraQueryParameters?: StringDict;
brokerParameters?: BrokerParameters;
};

// Warning: (ae-missing-release-tag) "CommonOnBehalfOfRequest" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
Expand Down Expand Up @@ -3048,6 +3062,7 @@ export type PerformanceEvent = {
scenarioId?: string;
accountType?: "AAD" | "MSA" | "B2C";
retryError?: string;
embeddedClientId?: string;
};

// Warning: (tsdoc-undefined-tag) The TSDoc tag "@export" is not defined in this configuration
Expand Down Expand Up @@ -3356,11 +3371,13 @@ const REQUESTED_TOKEN_USE = "requested_token_use";
//
// @internal (undocumented)
export class RequestParameterBuilder {
constructor();
constructor(performanceClient?: IPerformanceClient);
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
addApplicationTelemetry(appTelemetry: ApplicationTelemetry): void;
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
addAuthorizationCode(code: string): void;
// (undocumented)
addBrokerParameters(params: BrokerParameters): void;
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
addCcsOid(clientInfo: ClientInfo): void;
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Expand Down Expand Up @@ -4266,9 +4283,9 @@ const X_MS_LIB_CAPABILITY = "x-ms-lib-capability";
// src/client/AuthorizationCodeClient.ts:228:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/client/AuthorizationCodeClient.ts:229:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/client/AuthorizationCodeClient.ts:307:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/client/AuthorizationCodeClient.ts:501:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/client/AuthorizationCodeClient.ts:712:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/client/AuthorizationCodeClient.ts:769:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/client/AuthorizationCodeClient.ts:508:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/client/AuthorizationCodeClient.ts:726:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/client/AuthorizationCodeClient.ts:789:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/client/RefreshTokenClient.ts:193:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/client/RefreshTokenClient.ts:277:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/client/RefreshTokenClient.ts:278:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Expand All @@ -4280,6 +4297,7 @@ const X_MS_LIB_CAPABILITY = "x-ms-lib-capability";
// src/index.ts:8:12 - (tsdoc-characters-after-block-tag) The token "@azure" looks like a TSDoc tag but contains an invalid character "/"; if it is not a tag, use a backslash to escape the "@"
// src/index.ts:8:4 - (tsdoc-undefined-tag) The TSDoc tag "@module" is not defined in this configuration
// src/request/AuthenticationHeaderParser.ts:74:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/request/BaseAuthRequest.ts:55:5 - (ae-forgotten-export) The symbol "BrokerParameters" needs to be exported by the entry point index.d.ts
// src/request/ScopeSet.ts:72:15 - (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
// src/request/ScopeSet.ts:73:15 - (tsdoc-param-tag-with-invalid-type) The @param block should not include a JSDoc-style '{type}'
// src/response/ResponseHandler.ts:430:8 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
Expand Down

0 comments on commit 2df0f85

Please sign in to comment.