Browse Source

docs: Minor docs fixes

Michael Bromley 4 years ago
parent
commit
9b4a6a8905

+ 3 - 2
packages/admin-ui-plugin/src/plugin.ts

@@ -36,12 +36,13 @@ import {
 export interface AdminUiPluginOptions {
     /**
      * @description
-     * The route to the admin ui.
+     * The route to the Admin UI.
      */
     route: string;
     /**
      * @description
-     * The port on which the server will listen. If not
+     * The port on which the server will listen. This port will be proxied by the AdminUiPlugin to the same port that
+     * the Vendure server is running on.
      */
     port: number;
     /**

+ 6 - 6
packages/core/src/config/custom-field/custom-field-types.ts

@@ -117,14 +117,14 @@ export type CustomFieldConfig =
  *
  * All custom fields share some common properties:
  *
- * * `name: string`: The name of the field
- * * `type: string`: A string of type {@link CustomFieldType}
- * * `list: boolean`: If set to `true`, then the field will be an array of the specified type
+ * * `name: string`: The name of the field.
+ * * `type: string`: A string of type {@link CustomFieldType}.
+ * * `list: boolean`: If set to `true`, then the field will be an array of the specified type.
  * * `label?: LocalizedString[]`: An array of localized labels for the field.
  * * `description?: LocalizedString[]`: An array of localized descriptions for the field.
- * * `public?: boolean`: Whether or not the custom field is available via the Shop API. Defaults to `true`
- * * `readonly?: boolean`: Whether or not the custom field can be updated via the GraphQL APIs. Defaults to `false`
- * * `internal?: boolean`: Whether or not the custom field is exposed at all via the GraphQL APIs. Defaults to `false`
+ * * `public?: boolean`: Whether or not the custom field is available via the Shop API. Defaults to `true`.
+ * * `readonly?: boolean`: Whether or not the custom field can be updated via the GraphQL APIs. Defaults to `false`.
+ * * `internal?: boolean`: Whether or not the custom field is exposed at all via the GraphQL APIs. Defaults to `false`.
  * * `defaultValue?: any`: The default value when an Entity is created with this field.
  * * `nullable?: boolean`: Whether the field is nullable in the database. If set to `false`, then a `defaultValue` should be provided.
  * * `validate?: (value: any) => string | LocalizedString[] | void`: A custom validation function. If the value is valid, then