feat(api): creating LICENSE files and and SDK headings #786
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
erunion
added
enhancement
erunion
commented
Oct 25, 2023
erunion
commented
Oct 25, 2023
| @@ -510,6 +514,10 @@ sdk.server('https://eu.api.example.com/v14');`), | |||
| tsup: tsupOptions as JsonObject, | |||
| }; | |||
|
|
|||
| if (!this.spdxLicense) { | |||
| delete pkg.license; | |||
There was a problem hiding this comment.
Doing this instead of adding license to pkg here because I like having license slotted into the object where it is instead of after tsup. 💅
erunion
commented
Oct 25, 2023
Comment on lines
12
to
13
| * Detailed information on using this API can be found in the Ably <a | ||
| * href="https://ably.com/documentation/control-api">developer documentation</a>. |
There was a problem hiding this comment.
Annoying that they have HTML elements in this but I don't really have any desire to pull in a Markdown parser to convert these.
erunion
commented
Oct 25, 2023
erunion
commented
Oct 25, 2023
erunion
changed the title
info objects to SDK docblocks
erunion
changed the title
kanadgupta
requested changes
Oct 25, 2023
erunion
commented
Oct 25, 2023
| @@ -97,22 +97,16 @@ function assertSDKFixture(file: string, fixture: string) { | |||
|
|
|||
| describe('typescript', () => { | |||
| beforeEach(() => { | |||
| vi.setSystemTime(new Date('2023')); | |||
There was a problem hiding this comment.
Had to change this to a fuller date because new Date('2023').getFullYear() returns 2022.
erunion
commented
Oct 25, 2023
Comment on lines
+109
to
113
| /** | ||
| * Quirky `operationID` cases | ||
| * | ||
| */ | ||
| const createSDK = (() => { return new SDK(); })(); |
There was a problem hiding this comment.
Moving these docblocks from the SDK class to this export caused them to get surfaced:
erunion
commented
Oct 25, 2023
kanadgupta
reviewed
Oct 25, 2023
kanadgupta
approved these changes
Oct 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧰 Changes
LICENSEfile in the codegen'd SDK directory if we're able to recognize a license in their OpenAPI definitioninfo.licenseobject.licenseproperty to thepackage.jsonfile if we have a recognized license.SDKclass containing various pieces of data from their OpenAPI definitioninfoobject including:title,description, andtermsOfServiceThis is what it all looks like on a fully specced out definition: