From ca306cd15e2d9f15cf511df80c7a1e31dcd9b5fe Mon Sep 17 00:00:00 2001 From: john gravois Date: Mon, 14 Jan 2019 21:17:18 -0800 Subject: [PATCH] docs(:book:): make it clearer that it takes two steps to create a feature service AFFECTS PACKAGES: @esri/arcgis-rest-feature-service-admin ISSUES CLOSED: #408 --- packages/arcgis-rest-feature-service-admin/src/addTo.ts | 7 +++---- packages/arcgis-rest-feature-service-admin/src/create.ts | 9 ++++++--- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/packages/arcgis-rest-feature-service-admin/src/addTo.ts b/packages/arcgis-rest-feature-service-admin/src/addTo.ts index 2a58025c29..3d36f9815f 100644 --- a/packages/arcgis-rest-feature-service-admin/src/addTo.ts +++ b/packages/arcgis-rest-feature-service-admin/src/addTo.ts @@ -1,4 +1,4 @@ -/* Copyright (c) 2018 Environmental Systems Research Institute, Inc. +/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc. * Apache-2.0 */ import { request, cleanUrl } from "@esri/arcgis-rest-request"; @@ -42,7 +42,7 @@ export interface IAddToServiceDefinitionResult { * tables: [] * }); * ``` - * Add layer(s) and/or table(s) to a hosted feature service. + * Add layer(s) and/or table(s) to a hosted feature service. See the [REST Documentation](https://developers.arcgis.com/rest/services-reference/add-to-definition-feature-service-.htm) for more information. * * @param url - URL of feature service * @param requestOptions - Options for the request @@ -54,8 +54,7 @@ export function addToServiceDefinition( requestOptions: IAddToServiceDefinitionRequestOptions ): Promise { const adminUrl = - cleanUrl(url).replace("/rest/services", "/rest/admin/services") + - "/addToDefinition"; + `${cleanUrl(url).replace(`/rest/services`, `/rest/admin/services`)}/addToDefinition`; requestOptions.params = { addToDefinition: {}, diff --git a/packages/arcgis-rest-feature-service-admin/src/create.ts b/packages/arcgis-rest-feature-service-admin/src/create.ts index 0f5f3aee82..44a3c26434 100644 --- a/packages/arcgis-rest-feature-service-admin/src/create.ts +++ b/packages/arcgis-rest-feature-service-admin/src/create.ts @@ -1,4 +1,4 @@ -/* Copyright (c) 2018 Environmental Systems Research Institute, Inc. +/* Copyright (c) 2018-2019 Environmental Systems Research Institute, Inc. * Apache-2.0 */ import { request, getPortalUrl } from "@esri/arcgis-rest-request"; @@ -146,7 +146,10 @@ export interface ICreateServiceResult { /** * ```js - * import { createFeatureService } from '@esri/arcgis-rest-feature-service-admin'; + * import { + * createFeatureService, + * addToServiceDefinition + * } from '@esri/arcgis-rest-feature-service-admin'; * // * createFeatureService({ * authentication: userSession, @@ -156,7 +159,7 @@ export interface ICreateServiceResult { * } * }); * ``` - * Create a new hosted feature service. + * Create a new [hosted feature service](https://developers.arcgis.com/rest/users-groups-and-items/create-service.htm). After the service has been created, call [`addToServiceDefinition()`](../addToServiceDefinition/) if you'd like to update it's schema. * @param requestOptions - Options for the request * @returns A Promise that resolves with service details once the service has been created */