[ci] Update Typedoc (dd51fe4) - Core 3#3456
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
This is failing because the file doesn't exist. But it will exist once this PR is merged. So waiting on that to be merged before merging this. 
Have added some links to the ignore typedoc object, as these links aren't being used anyway, but will put up a PR to document them on the docs. So ultimately, will remove the links from being ignored. |
| | Parameter | Type | Description | | ||
| | ------ | ------ | ------ | | ||
| | `domainName` | `string` | The name of the domain to create. | | ||
| | `params?` | `Pick`\<[`CreateOrganizationDomainParams`](../create-organization-domain-params.mdx), `"enrollmentMode"`\> | Optional parameters, including the `enrollmentMode` to assign to the new domain. | |
There was a problem hiding this comment.
do you have plans to handle this ^ or would you like me to take a look! there actually might be something in docs(backend,shared): Generate typedoc output for backend docs that handles this because I think I ran into a Pick issue and solved it in that PR
There was a problem hiding this comment.
After investigating this, I don't think it's an issue with the Pick but more that the link is broken. I tried implementing the logic you had in the backend PR but it didn't change anything - the link was still broken. Here is the fix I implemented: clerk/javascript#8957. But if you find a better fix - feel freee to push it there! @alexisintech
| Issues a fresh TXT challenge for each of the given domains in a single | ||
| request. Each resolved domain's `ownershipVerification` carries the | ||
| `txtRecordName` and `txtRecordValue` the org admin must publish. A single | ||
| bad domain does not fail the batch; it lands in `errors`. |
There was a problem hiding this comment.
the formatting here needs to get fixed!
There was a problem hiding this comment.
This Typedoc isn't being used in the docs currently so I think we can follow up and iterate later on this. Priority is for the broken link in clerk-properties to go.
| `txtRecordName` and `txtRecordValue` the org admin must publish. A single | ||
| bad domain does not fail the batch; it lands in `errors`. | ||
|
|
||
| Returns an [`OrganizationDomainsBulkOwnershipVerificationResource`](/docs/reference/types/organization-domains-bulk-ownership-verification-resource) object. |
There was a problem hiding this comment.
There was a problem hiding this comment.
Yup that's why I put it in the ignore stuff for now. That Typedoc isn't used in the docs anyway atm.
There was a problem hiding this comment.
This Typedoc isn't being used in the docs currently so I think we can follow up and iterate later on this. Priority is for the broken link in clerk-properties to go.
There was a problem hiding this comment.
documented this resource in this PR: clerk/javascript#8956
| | Property | Type | Description | | ||
| | ---------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | <a id="affiliationemailaddress"></a> `affiliationEmailAddress` | <code>null \| string</code> | The email address used to verify the affiliation with the domain, or `null` if none has been provided. | | ||
| | <a id="affiliationverification"></a> `affiliationVerification` | <code>null \| [OrganizationDomainVerification](organization-domain-verification.mdx)</code> | The affiliation verification details for the domain, or `null` if the domain has not been verified. | |
There was a problem hiding this comment.
I think the all of the organization domain additions are for the upcoming Self-serve SSO feature - and it's unfortunate they haven't documented things as we've asked :/ I can ping that team to get these things documented
There was a problem hiding this comment.
This Typedoc isn't being used in the docs currently so I think we can follow up and iterate later on this. Priority is for the broken link in clerk-properties to go.
| Resolves the published TXT record for each of the given domains in a single | ||
| request to complete ownership verification. A single bad domain does not | ||
| fail the batch; it lands in `errors`. |
There was a problem hiding this comment.
formatting here needs to get fixed!
There was a problem hiding this comment.
This Typedoc isn't being used in the docs currently so I think we can follow up and iterate later on this. Priority is for the broken link in clerk-properties to go.
|
Reached out to Tu regarding some of these missing types! 
|
|
Closing this in favor of: #3459. |
2 participants
Auto-generated PR to update Typedoc documentation from clerk/javascript@dd51fe4