Release v0.0.24

Author: fern-api[bot]

.mock/definition/feature.yml

@@ -1,14 +1,18 @@
 types:
   FeatureId:
-    docs: |
-      A unique identifier for a feature (e.g. OPTIONALS). This is typed as a freeform string
-      to allow for arbitrary features, but callers are expected to use the FeatureType
-      string representation whenever possible.
-    type: string
+    discriminated: false
+    union:
+      - string
+      - StructuredFeatureId
+    docs: >
+      A unique identifier for a feature (e.g. OPTIONALS). This is typed as a
+      freeform string
 
-  FeatureType:
-    docs: |
-      Unique identifiers for features that can be demonstrated with snippets.
+      to allow for arbitrary features, but callers are expected to use the
+      StructuredFeatureId
+
+      string representation whenever possible.
+  StructuredFeatureId:
     enum:
       - AUTHENTICATION
       - ERRORS
@@ -18,22 +22,28 @@ types:
       - REQUEST_OPTIONS
       - STREAMING
       - TIMEOUTS
-
-  FeatureConfig:
+      - CUSTOM_CLIENT
     docs: |
-      The configuration used to specify a generator's set of supported features.
-      This is static data associated with a particular version of a generator, and
-      is expected to be written as a static features.yml file in the generator's
-      repository.
+      Unique identifiers for features that can be demonstrated with snippets.
+  FeatureConfig:
     properties:
       features: list<FeatureSpec>
+    docs: >
+      The configuration used to specify a generator's set of supported features.
+
+      This is static data associated with a particular version of a generator,
+      and
+
+      is expected to be written as a static features.yml file in the generator's
 
+      repository.
   FeatureSpec:
-    docs: |
-      A specification for a feature supported by a generator. This includes the
-      feature's ID, a description, and any additional information that should be
-      included in the README.md.
     properties:
       id: FeatureId
       description: optional<string>
       addendum: optional<string>
+      advanced: optional<boolean>
+    docs: |
+      A specification for a feature supported by a generator. This includes the
+      feature's ID, a description, and any additional information that should be
+      included in the README.md.

.mock/definition/github.yml

@@ -0,0 +1,19 @@
+types:
+  GitHubConfig:
+    properties:
+      sourceDirectory:
+        type: string
+        docs: >-
+          The directory from which to read the contents of the GitHub
+          repository.
+      uri:
+        type: string
+        docs: The URI of the GitHub repository.
+      token:
+        type: string
+        docs: The token used to access the GitHub repository.
+      branch:
+        type: optional<string>
+        docs: The branch to use when interacting with the GitHub repository.
+    docs: |
+      The configuration used to interact with a GitHub repository.

.mock/definition/readme.yml

@@ -2,113 +2,115 @@ imports:
   feature: feature.yml
 types:
   ReadmeConfig:
-    docs: |
-      The configuration used to generate a README.md file.
-
-      The information described here is a combination of user-defined information
-      (i.e. specified in the generators.yml), and dynamically generated information
-      that comes from each generator (i.e. features, requirements, and more).
     properties:
+      remote:
+        type: optional<Remote>
+        docs: >
+          If specified, the original README.md will be fetched from this remote
+          (if it exists).
       language: LanguageInfo
       organization: string
       bannerLink: optional<string>
-      docsLink: optional<string>
+      introduction: optional<string>
+      apiReferenceLink: optional<string>
+      referenceMarkdownPath: optional<string>
       requirements: optional<list<string>>
       features:
+        type: optional<list<ReadmeFeature>>
         docs: |
           Specifies the list of features supported by a specific generator.
           The features are rendered in the order they're specified.
-        type: optional<list<ReadmeFeature>>
+    docs: >
+      The configuration used to generate a README.md file.
 
-  ReadmeFeature:
+      The information described here is a combination of user-defined
+      information
+
+      (i.e. specified in the generators.yml), and dynamically generated
+      information
+
+      that comes from each generator (i.e. features, requirements, and more).
+  Remote:
+    union:
+      github: GithubRemote
     docs: |
-      A single feature supported by a generator (e.g. PAGINATION).
+      The remote where the README.md is hosted.
+  GithubRemote:
+    properties:
+      repoUrl:
+        type: string
+        docs: A full repo url (i.e. https://github.com/fern-api/fern)
+      installationToken:
+        type: string
+        docs: The token used to clone the GitHub repository.
+  ReadmeFeature:
+    extends: feature.FeatureSpec
     properties:
-      id: feature.FeatureId
-      description: optional<string>
-      addendum: optional<string>
       snippets: optional<list<string>>
       snippetsAreOptional:
-        docs: |
-          If true, the feature block should be rendered even if we don't receive a snippet for it.
-          This is useful for features that are always supported, but might not require a snippet
-          to explain.
         type: boolean
+        docs: >
+          If true, the feature block should be rendered even if we don't receive
+          a snippet for it.
 
-  LanguageInfo:
-    docs: |
-      The language and its associated publish information (if any).
+          This is useful for features that are always supported, but might not
+          require a snippet
 
-      This is used to generate badges, the installation guide, and determine what language to
-      use when surrounding the snippets in a code block.
+          to explain.
+    docs: |
+      A single feature supported by a generator (e.g. PAGINATION).
+  LanguageInfo:
     union:
       typescript: TypescriptInfo
       python: PythonInfo
       go: GoInfo
       java: JavaInfo
       ruby: RubyInfo
       csharp: CsharpInfo
+    docs: >
+      The language and its associated publish information (if any).
+
+      This is used to generate badges, the installation guide, and determine
+      what language to
 
+      use when surrounding the snippets in a code block.
   TypescriptInfo:
     properties:
-      title: literal<"TypeScript">
-      format: literal<"ts">
       publishInfo: optional<NpmPublishInfo>
-
   PythonInfo:
     properties:
-      title: literal<"Python">
-      format: literal<"python">
       publishInfo: optional<PypiPublishInfo>
-
   GoInfo:
     properties:
-      title: literal<"Go">
-      format: literal<"go">
       publishInfo: optional<GoPublishInfo>
-
   JavaInfo:
     properties:
-      title: literal<"Java">
-      format: literal<"java">
       publishInfo: optional<MavenPublishInfo>
-
   RubyInfo:
     properties:
-      title: literal<"Ruby">
-      format: literal<"ruby">
       publishInfo: optional<RubyGemsPublishInfo>
-
   CsharpInfo:
     properties:
-      title: literal<"C#">
-      format: literal<"csharp">
       publishInfo: optional<NugetPublishInfo>
-
   NpmPublishInfo:
     properties:
       packageName: string
-
   PypiPublishInfo:
     properties:
       packageName: string
-
   GoPublishInfo:
     properties:
       owner: string
       repo: string
       version: string
-
   MavenPublishInfo:
     properties:
       artifact: string
       group: string
       version: string
-
   RubyGemsPublishInfo:
     properties:
       packageName: string
-
   NugetPublishInfo:
     properties:
       packageName: string

.mock/definition/reference.yml

@@ -0,0 +1,101 @@
+types:
+  ReferenceConfig:
+    properties:
+      rootSection: optional<RootPackageReferenceSection>
+      sections: list<ReferenceSection>
+      language:
+        type: Language
+        docs: >-
+          Similar to in README generation, the language property is used to
+          determine the language to use when generating code blocks in markdown.
+    docs: >
+      The information to include within the `reference.md` file generated by the
+      CLI.
+
+      The information here should really be all defined by the generator, and
+      not user provided.
+
+      We intentionally keep this a bit flexible in the event SDKs structure
+      their package/module
+
+      references in a unique way for the same API.
+  RootPackageReferenceSection:
+    properties:
+      description: optional<string>
+      endpoints: list<EndpointReference>
+  ReferenceSection:
+    properties:
+      title: string
+      description: optional<string>
+      endpoints: list<EndpointReference>
+  EndpointReference:
+    properties:
+      title:
+        type: MethodInvocationSnippet
+        docs: >
+          The title is a code snippet that is shown when the endpoint's
+          reference is collapsed. 
+
+          For example, `client.subpackage.method({ ...params }) -> ReturnValue`.
+      description: optional<string>
+      snippet:
+        type: string
+        docs: |
+          A "full" snippet, showing all the parameters, with a full example.
+          ```typescript
+          await client.subpackage.method({
+              expiresIn: 300,
+          });
+          ```
+      parameters: list<ParameterReference>
+  MethodInvocationSnippet:
+    properties:
+      snippetParts: list<LinkedText>
+      returnValue: optional<LinkedText>
+    docs: >
+      The method invocation snippet is one which appears when the endpoint's
+      reference is collapsed.
+
+      It is meant to give a high-level overview of the endpoint -- e.g. the
+      method name and it's return value.
+
+      The snippet itself should be a list of concatable content, which the CLI
+      will handle hyperlinking. Note that this
+
+      will essentially just be a "".join(snippetParts), so you must handle
+      making sure the right `.`, etc. are in the parts.
+
+      Note this is a separate object to make it easier to add additional
+      properties down the road, for example if 
+
+      we wanted to be specific about what portion of the snippet we hyperlink,
+      etc.
+  LinkedText:
+    properties:
+      text: string
+      location: optional<RelativeLocation>
+  ParameterReference:
+    properties:
+      name: string
+      description: optional<string>
+      location: optional<RelativeLocation>
+      type: string
+      required: boolean
+  RelativeLocation:
+    properties:
+      path:
+        type: string
+        docs: >
+          A relative location is a path to a file or directory relative to the
+          root of the repository.
+
+          This is used to specify a link for a type or a function that the
+          `reference.md` can point users to.
+  Language:
+    enum:
+      - JAVA
+      - PYTHON
+      - GO
+      - RUBY
+      - CSHARP
+      - TYPESCRIPT

.mock/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization" : "fern",
-  "version" : "0.0.23"
+  "version" : "0.57.0"
 }