Explorar el Código

docs(core): Add @since tags to new APIs

Michael Bromley hace 4 años
padre
commit
5ede571bde

+ 12 - 0
CONTRIBUTING.md

@@ -22,6 +22,18 @@ If you would like to contribute a bugfix, please first create an issue detailing
 
 Again, please create a feature request detailing the functionality you intend to add, and state that you would like to implement it. When creating commits, please follow the commit message format below. New feature pull requests should be made against the `minor` branch.
 
+When adding new public APIs to support your new feature, add a `@since 1.2.0` tag (where "1.2.0" corresponds to what will be the next minor version) to the doc block. This will let readers of the documentation know the version in which the API was introduced. See the [docs readme](./docs/README.md) for more details on the valid docs tags.
+
+```TypeScript
+/**
+ * @description
+ * Sets the value of the new API thing.
+ *
+ * @since 1.2.0
+ */
+myNewApi: number;
+```
+
 ## Commit message format
 
 This repo uses [Conventional Commits](https://www.conventionalcommits.org).

+ 1 - 1
packages/dev-server/dev-config.ts

@@ -37,7 +37,7 @@ export const devConfig: VendureConfig = {
     },
     authOptions: {
         disableAuth: false,
-        tokenMethod: 'cookie',
+        tokenMethod: ['bearer', 'cookie'] as const,
         requireVerification: true,
         customPermissions: [],
         cookieOptions: {

+ 4 - 0
packages/elasticsearch-plugin/src/options.ts

@@ -61,6 +61,7 @@ export interface ElasticsearchOptions {
      * [These options](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/index-modules.html#index-modules-settings)
      * are directly passed to index settings. To apply some settings indices will be recreated.
      *
+     * @since 1.2.0
      * @default
      * {}
      */
@@ -71,6 +72,7 @@ export interface ElasticsearchOptions {
      * [mapping](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html)
      * After changing this option indices will be recreated.
      *
+     * @since 1.2.0
      * @default
      * {}
      */
@@ -187,6 +189,7 @@ export interface SearchConfig {
      * The maximum number of Collections to return from the search query. Internally, this
      * value sets the "size" property of an Elasticsearch aggregation.
      *
+     * @since 1.1.0
      * @default
      * 50
      */
@@ -200,6 +203,7 @@ export interface SearchConfig {
      * If this parameter is set to "False", totalItems will be returned as 0.
      * If this parameter is set to integer, accurate count of totalItems will be returned not bigger than integer.
      *
+     * @since 1.2.0
      * @default
      * 10000
      */