Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: API Reference now uses Api Definition V2 #1608

Merged
merged 36 commits into from
Oct 10, 2024
Merged

chore: API Reference now uses Api Definition V2 #1608

merged 36 commits into from
Oct 10, 2024

Conversation

abvthecity
Copy link
Contributor

@abvthecity abvthecity commented Oct 8, 2024 •
edited
Loading

In this PR:

  • delete Resolved API types
  • delete the /api/fern-docs/resolve-api endpoint
  • change all shape: TypeReference to shape: TypeShape because TypeShape is more flexible (allows you to specify TypeReference via an alias. This lets us unwrap websocket variants more smoothly.
  • deletes schemaWithExample
  • updates the resolveDocsContent to adopt the new typings
  • update all api reference components to use the new typings
  • in some cases, fixes the descriptions field (but not in all cases)
  • fixes dropped globalHeaders in api playground
  • delete the InternalTypeDefinitionError (in favor of just InternalTypeDefinition) for simplicity (also it's not implemented correctly anyway)
  • refactor ApiPackageContents -> ApiDefinitionContent to use a flattened array instead of recursion. (eventually this will be used to collapse / summarize api sections)
  • improved memoization of ApiDefinition
  • update tests and snapshots

the following functionality has been commented out because it no longer works:

  • EndpointRequestSnippet no longer links back to the api reference (we can precompute this somewhere)

@abvthecity abvthecity had a problem deploying to Preview - app-dev.buildwithfern.com October 8, 2024 16:44 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app.buildwithfern.com October 8, 2024 16:44 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app-dev.buildwithfern.com October 8, 2024 17:21 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app.buildwithfern.com October 8, 2024 17:21 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app.buildwithfern.com October 8, 2024 19:30 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app-dev.buildwithfern.com October 8, 2024 19:30 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app.buildwithfern.com October 8, 2024 22:31 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app-dev.buildwithfern.com October 8, 2024 22:31 — with GitHub Actions Failure
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 8, 2024

🌿 Preview your docs: https://fern-preview-c1038525-4b84-4f00-abbe-08b8818e3425.docs.buildwithfern.com

@abvthecity abvthecity had a problem deploying to Preview - app.buildwithfern.com October 8, 2024 23:31 — with GitHub Actions Failure
@abvthecity abvthecity had a problem deploying to Preview - app-dev.buildwithfern.com October 8, 2024 23:31 — with GitHub Actions Failure
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 9, 2024

🌿 Preview your docs: https://fern-preview-d600435e-e925-4e1e-9e8f-077b7b831ce9.docs.buildwithfern.com

@abvthecity abvthecity changed the title stash chore: API Reference now uses Api Definition V2 Oct 9, 2024
@abvthecity abvthecity marked this pull request as ready for review October 9, 2024 02:33
@abvthecity abvthecity requested a review from dsinghvi as a code owner October 9, 2024 02:33
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 9, 2024

🌿 Preview your docs: https://fern-preview-eeda02f8-dab3-44ee-9acf-cc90446f3178.docs.buildwithfern.com

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 9, 2024

🌿 Preview your docs: https://fern-preview-efb6f2b4-79c0-45c7-b1b1-5045a3872a0b.docs.buildwithfern.com

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 9, 2024

🌿 Preview your docs: https://fern-preview-e9fde9ee-8e05-4d60-9ca6-ac75ee16c7e4.docs.buildwithfern.com

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 9, 2024

🌿 Preview your docs: https://fern-preview-7676b8e1-b724-4126-83c4-7653f6c081f8.docs.buildwithfern.com

@abvthecity abvthecity enabled auto-merge (squash) October 9, 2024 22:14
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 9, 2024

🌿 Preview your docs: https://fern-preview-55f54397-4054-461a-8074-a4b0096eae57.docs.buildwithfern.com

dsinghvi
dsinghvi reviewed Oct 10, 2024
View reviewed changes
fern/apis/fdr/definition/api/latest/type.yml
@@ -60,7 +60,7 @@ types:
- commons.WithAvailability
properties:
key: rootCommons.PropertyKey
valueShape: TypeReference
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could this break any consumer?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no it won't, all the consumers use unwrapReference which accepts TypeShape | TypeReference

dsinghvi
dsinghvi reviewed Oct 10, 2024
View reviewed changes
packages/ui/app/src/mdx/common/util.ts
@@ -12,73 +12,73 @@ export type ExpectedCodeBlockChildren = {
};
};

export function stringHasMarkdown(s: string): boolean {
s = s.trim();
// export function stringHasMarkdown(s: string): boolean {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why are we commenting this out instead of deleting? is the idea to bring this back?

@abvthecity abvthecity merged commit 41de5ab into main Oct 10, 2024
22 of 23 checks passed
@abvthecity abvthecity deleted the ajiang/api-definition-migrate-2 branch October 10, 2024 12:39
@dsinghvi
Copy link
Member

didn't mean to auto merge this cause it would be valuable to understand the stringHasMarkdown change

@dsinghvi dsinghvi restored the ajiang/api-definition-migrate-2 branch October 10, 2024 12:40
dsinghvi added a commit that referenced this pull request Oct 10, 2024
@dsinghvi
Revert "chore: API Reference now uses Api Definition V2 (#1608)"
37f50b4 
This reverts commit 41de5ab.
@dsinghvi dsinghvi mentioned this pull request Oct 10, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dsinghvi dsinghvi dsinghvi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@abvthecity @dsinghvi