Skip to content

Cli doc updates #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 21 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/concepts/geojsonbasics.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ A **FeatureCollection** contains an array of **Features**, contained in a member

A **GeometryCollection** is a collection of zero or more geometry objects like the ones above in an array member called *geometries*

!!! Warning "GeometryCollection is not supported by HERE XYZ Hub. It is just included here for completeness."
!!! Warning "GeometryCollection is not supported by HERE Data Hub. It is just included here for completeness."

### Example GeometryCollection

Expand Down
2 changes: 1 addition & 1 deletion docs/api/concepts/jsonschema.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ It is best practice to include a unique identifier for each schema
{ "$id": "http://yourdomain.com/schemas/myschema.json" }
```

!!! Warning "HERE XYZ does not load external schema resources"
!!! Warning "HERE Data Hub does not load external schema resources"

**$id** can also be used to reference a subschema without using JSON Pointer.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/concepts/namespaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ with the following body
}
```

When you upload a feature to XYZ Hub, we automatically add a property *@ns:com:here:xyz* to it. The following information is recorded in this property:
When you upload a feature to Data Hub, we automatically add a property *@ns:com:here:xyz* to it. The following information is recorded in this property:

+ *createdAt* - date and time the feature was created in milliseconds since 01.01.1970
+ *updatedAt* - date and time the feature was updated in milliseconds since 01.01.1970
Expand Down
2 changes: 1 addition & 1 deletion docs/api/concepts/tiles.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tiles

The XYZ Hub API supports the following tile identifiers:
The Data Hub API supports the following tile identifiers:

* ***web*** for the Mercator projection (used by OpenStreetMaps, Google Maps, Bing Maps and others)
format: level_x_y; for example: 10_100_100 means level 10. x-coordinate 100, y-coordinate 100
Expand Down
2 changes: 1 addition & 1 deletion docs/api/devguide/accessingfeatures.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Accessing Features

This section describes how to get features from HERE XYZ Hub by using a bounding box or a tile, and iterating features.
This section describes how to get features from HERE Data Hub by using a bounding box or a tile, and iterating features.

## Get Features by Bounding Box

Expand Down
6 changes: 3 additions & 3 deletions docs/api/devguide/activitylogguide.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Space configuration

!!! Note "Your account needs access to the XYZ Pro Services."
!!! Note "Your account needs access to the Data Hub Add-on Services."

***

Expand Down Expand Up @@ -29,8 +29,8 @@ To activate it, just create a space with the listener added and enableUUID set t
The storage mode decides how the features will be stored.

* **FEATURE_ONLY**: Will store features with some history relative properties (defined below).
* **DIFF_ONLY**: Will store features with a 'diff'.'ops' property in the XYZ Activity-Log namespace, containing the RFC-6902 diff to its previous object. The features after the HEAD will only contain the XYZ Activity-Log & XYZ namespace properties.
* **FULL**: Will store features with some history relative properties and a 'diff'.'ops' property in the XYZ Activity-Log namespace, containing the RFC-6902 diff to its previous object.
* **DIFF_ONLY**: Will store features with a 'diff'.'ops' property in the Data Hub Activity-Log namespace, containing the RFC-6902 diff to its previous object. The features after the HEAD will only contain the Data Hub Activity-Log & Data Hub namespace properties.
* **FULL**: Will store features with some history relative properties and a 'diff'.'ops' property in the Data Hub Activity-Log namespace, containing the RFC-6902 diff to its previous object.

**ATTENTION**: Applying the diff to the current feature will return the previous (older) feature. This means that adding a new property to a feature, will be shown as 'remove' & 'pathToNewProperty' in the diff of the current.

Expand Down
2 changes: 1 addition & 1 deletion docs/api/devguide/propertiessearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ your space.
Not all Feature properties are necessarily searchable. So before using the property search it
makes sense to check which of the properties in your space can be searched.

*NOTE: XYZ has a space-specific algorithm to automatically decide which of the space's properties
*NOTE: Data Hub has a space-specific algorithm to automatically decide which of the space's properties
are searchable. In case you desire other properties to be searchable please have a look into
the guide at ["Adjust searchable properties"](searchableproperties.md).*

Expand Down
6 changes: 3 additions & 3 deletions docs/api/devguide/searchableproperties.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Adjust searchable feature-properties

!!! Note "Your account needs access to the XYZ Pro Services."
!!! Note "Your account needs access to the Data Hub Add-on Services."

This section describes how to use the extended capability of enabling property-search for
user-specified properties of your GeoJSON features inside a space.
Expand All @@ -18,11 +18,11 @@ the `/spaces/{spaceId}` endpoint.
flags telling whether the property should be searchable or not.

The following sample shows how to define `someProperty1` to be searchable and `someProperty2` to
be not searchable. In case you're wondering about the latter: That could be necessary to tell XYZ
be not searchable. In case you're wondering about the latter: That could be necessary to tell Data Hub
to revoke the decision of making `someProperty2` searchable in the automated algorithm.

**TL;DR**
*XYZ has a space-specific algorithm to automatically decide which of the space's properties
*Data Hub has a space-specific algorithm to automatically decide which of the space's properties
are searchable. In case you desire other properties to be searchable the `searchableProperties` map
can be used to define that.*

Expand Down
4 changes: 2 additions & 2 deletions docs/api/devguide/spatialsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The easiest way for providing a search Geometry is submitting it via a POST-Requ

### Referencing an existing Geometry for a Spatial Search

Another way to provide a search Geometry is to read it from a existing Feature, which is stored in a XYZ-Space
Another way to provide a search Geometry is to read it from a existing Feature, which is stored in a Data Hub Space
that you have access to. This is recommended if your search Geometry is a really complex one, or if you want to store
frequently used Geometries for spatial searches.

Expand All @@ -47,7 +47,7 @@ Spatial-Search by referencing a position (lat,lon) & defining a radius indicated
GET /spaces/{spaceId}/spatial?lon={Longitude}&lat={Latitude}&radius={raduisInMeters}
```

Spatial-Search by referencing a Feature from a XYZ-Space:
Spatial-Search by referencing a Feature from a Data Hub Space:
```HTTP
GET /spaces/{spaceId}/spatial?refSpaceId={referencedSpace}&refFeatureId
={referencedFeatureId}
Expand Down
2 changes: 1 addition & 1 deletion docs/api/devguide/usingclustering.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Using Feature Clustering

This section describes how to retrieve features from XYZ Hub inside a tile or bounding-box in a
This section describes how to retrieve features from Data Hub inside a tile or bounding-box in a
clustered form.

## Get clustered Features in a Bounding Box
Expand Down
4 changes: 2 additions & 2 deletions docs/api/getting-token.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
HERE XYZ Hub APIs use project tokens that are tied to your Account or HERE Accounts SSO identity. Make sure to keep your credentials safe and don't include them directly in any web pages as they are the key to generate new access tokens.
HERE Data Hub APIs use project tokens that are tied to your Account or HERE Accounts SSO identity. Make sure to keep your credentials safe and don't include them directly in any web pages as they are the key to generate new access tokens.

Usually you would use two tokens:

Expand All @@ -7,7 +7,7 @@ Usually you would use two tokens:

## Token Administration

Log into the **XYZ Hub Token Generator** site with your `Email address` and `Password` or `HERE Accounts SSO identity`:
Log into the **Data Hub Token Generator** site with your `Email address` and `Password` or `HERE Accounts SSO identity`:

[`https://xyz.api.here.com/token-ui/`](https://xyz.api.here.com/token-ui/)

Expand Down
4 changes: 2 additions & 2 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
XYZ Hub is a real-time cloud-based location hub for discovering, storing, retrieving, manipulating and publishing private or public mapping data.
Data Hub is a real-time cloud-based location hub for discovering, storing, retrieving, manipulating and publishing private or public mapping data.

It uses the concepts of **Spaces** to store your data. A Space is your own geospatial
data repository, which you can quickly create when needed to store data.

To interact with the HERE XYZ Hub API directly from your application you just need to interact with our public REST APIs. They are simple and straightforward to use from any application environment - you only need to know how to make RESTful requests.
To interact with the HERE Data Hub API directly from your application you just need to interact with our public REST APIs. They are simple and straightforward to use from any application environment - you only need to know how to make RESTful requests.

## Authentication

Expand Down
6 changes: 3 additions & 3 deletions docs/api/links.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# HERE XYZ Links
# HERE Data Hub Links

Here is a list of links for working with HERE XYZ
Here is a list of links for working with HERE Data Hub

## API and Service

Expand All @@ -14,7 +14,7 @@ Here is a list of links for working with HERE XYZ
### ReDoc API documentation
[`https://xyz.api.here.com/hub/static/redoc/`](https://xyz.api.here.com/hub/static/redoc/)

## XYZ Tools
## Data Hub Tools

### Token Generation UI

Expand Down
2 changes: 1 addition & 1 deletion docs/api/quickstart/acquiringcredentials.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Acquiring Credentials

All users of the HERE XYZ Hub must get authentication and authorization credentials. These credentials are assigned per application, and a bearer token is obtained by using the app_id and app_code issued by the HERE Developer Portal
All users of the HERE Data Hub must get authentication and authorization credentials. These credentials are assigned per application, and a bearer token is obtained by using the app_id and app_code issued by the HERE Developer Portal

The bearer token is provided as a value of the “Authorization” header parameter using the “Bearer” authentication scheme:

Expand Down
4 changes: 2 additions & 2 deletions docs/api/quickstart/activitylog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Use Activity-Log

!!! Note "Your account needs access to the XYZ Pro Services."
!!! Note "Your account needs access to the Data Hub Add-on Services."

1. Create a new space with the activity-log listener and enableUUID set to true:

Expand Down Expand Up @@ -47,7 +47,7 @@ GET /spaces
{
"id": "<activityLogSpaceId>",
"title": "activity-log for space <newSpaceId>",
"description": "This is an automatically created space for the history of space __<newSpaceId>__. \nCreated on 2019-12-02 at 07:31 \n***\nModified features will be stored in this space by their original _uuid_. \nThe original namespace properties of XYZ will be stored within the value 'original' of the namespace '@ns:com:here:xyz:log'. \nIMPORTANT Deleting this space while activity-log is enabled, causes the absence of history. \n***",
"description": "This is an automatically created space for the history of space __<newSpaceId>__. \nCreated on 2019-12-02 at 07:31 \n***\nModified features will be stored in this space by their original _uuid_. \nThe original namespace properties of Data Hub will be stored within the value 'original' of the namespace '@ns:com:here:xyz:log'. \nIMPORTANT Deleting this space while activity-log is enabled, causes the absence of history. \n***",
"createdAt": 1575271894028,
"updatedAt": 1575271894028,
"searchableProperties": {
Expand Down
2 changes: 1 addition & 1 deletion docs/api/quickstart/writetospace.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ The response is a FeatureCollection, containing all created features.
}
```

When you upload a feature to XYZ Hub, we automatically add a property *@ns:com:here:xyz* to it. The following information is recorded in this property:
When you upload a feature to Data Hub, we automatically add a property *@ns:com:here:xyz* to it. The following information is recorded in this property:

+ *createdAt* - date and time the feature was created in milliseconds since 01.01.1970
+ *updatedAt* - date and time the feature was updated in milliseconds since 01.01.1970
Expand Down
8 changes: 4 additions & 4 deletions docs/api/walkthrough/schemavalidation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Use Schema Validation

!!! Note "Your account needs access to the XYZ Pro Services."
!!! Note "Your account needs access to the Data Hub Add-on Services."

To use Schema Validation you need to put additional data into the space
definition. Please add a processor with the ID *schema-validator* and put
Expand Down Expand Up @@ -61,7 +61,7 @@ POST /spaces
{
"id": "schema-validator",
"params": {
"schemaUrl": "<Location of schema in the XYZ managed S3 bucket>"
"schemaUrl": "<Location of schema in the Data Hub managed S3 bucket>"
}
}

Expand All @@ -71,7 +71,7 @@ POST /spaces
```

Please note that the field *schema* has been replaced with a field *schemaUrl*
that points to a private copy in the XYZ S3 bucket.
that points to a private copy in the Data Hub S3 bucket.

## Validating your data

Expand Down Expand Up @@ -233,7 +233,7 @@ PATCH /spaces/{spaceId}
{
"id": "schema-validator",
"params": {
"schemaUrl": "<Location of updated schema in the XYZ managed S3 bucket>"
"schemaUrl": "<Location of updated schema in the Data Hub managed S3 bucket>"
}
}

Expand Down
2 changes: 1 addition & 1 deletion docs/api/walkthrough/searchbytags.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ GET /spaces/{spaceId}/search?tags=mountain

## Advanced Search

This was just the simplest version of a search by tags. Imagine having all the restaurants of your city or your region in your space. Of course you have tagged them diligently by food category, food type and cuisine. A user of your application could be interested in eating Indian food tonight if it was vegan. He would settle for vegetarian if there were only non-vegan Indian restaurants. The search request for the HERE XYZ Hub could look something like that:
This was just the simplest version of a search by tags. Imagine having all the restaurants of your city or your region in your space. Of course you have tagged them diligently by food category, food type and cuisine. A user of your application could be interested in eating Indian food tonight if it was vegan. He would settle for vegetarian if there were only non-vegan Indian restaurants. The search request for the HERE Data Hub could look something like that:

### Request

Expand Down
Binary file added docs/assets/gifs/cli-activitylog-enable.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gifs/cli-activitylog-reconfigure.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gifs/cli-configure-show.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gifs/cli-searchable-add.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gifs/cli-searchable-delete.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gifs/cli-tagrule-add.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/gifs/cli-tagrule-update.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading