Skip to content
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.

Sign up for GitHub

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

Doc/fix list indentation #2563

Merged
merged 1 commit into from
Oct 5, 2016
Merged

Doc/fix list indentation #2563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions doc/manuals/admin/perf_tuning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@ to decide what to prioritize.
However, in order to help administrators in this task, the following indexes are recommended:

* Collection [entities](database_model.md#entities-collection)
* `_id.id`
* `_id.type`
* `_id.servicePath`
* `attrNames`
* `creDate`
* `_id.id`
* `_id.type`
* `_id.servicePath`
* `attrNames`
* `creDate`

The only index that Orion Context Broker actually ensures is the "2dsphere" in the `location.coords`
field in the entities collection, due to functional needs [geo-location functionality](../user/geolocation.md).
Expand Down
16 changes: 8 additions & 8 deletions doc/manuals/user/filtering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

* [Introduction](#introduction)
* [NGSIv2 filtering](#ngsiv2-filtering)
* [Simple Query Language](#simple-query-language)
* [Geographical Queries](#geographical-queries)
* [Simple Query Language](#simple-query-language)
* [Geographical Queries](#geographical-queries)
* [NGSIv1 filtering](#ngsiv1-filtering)
* [Existence type filter](#existence-type-filter)
* [No-Existence type filter](#no-existence-type-filter)
* [Entity type filter](#entity-type-filter)
* [Geo-location filter](#geo-location-filter)
* [Geo-location filter NGSIv2](#geo-location-filter-ngsiv2)
* [String query filter](#string-filters)
* [Existence type filter](#existence-type-filter)
* [No-Existence type filter](#no-existence-type-filter)
* [Entity type filter](#entity-type-filter)
* [Geo-location filter](#geo-location-filter)
* [Geo-location filter NGSIv2](#geo-location-filter-ngsiv2)
* [String query filter](#string-filters)

## Introduction

Expand Down
47 changes: 24 additions & 23 deletions doc/manuals/user/ngsiv2_implementation_notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,34 +76,35 @@ The particular validations that Orion implements on NGSIv2 subscription payloads

* **description**: optional (max length 1024)
* **subject**: mandatory
* **entities**: mandatory
* **id** or **idPattern**: one of them is mandatory (but both at the same time is not allowed). id
must follow NGSIv2 restrictions for IDs. idPattern must be not empty and a valid regex.
* **type**: optional (but if present it must follow NGSIv2 restrictions for IDs)
* **condition**: optional (but if present it must have a content, i.e. `{}` is not allowed)
* **attrs**: optional (but if present it must be a list; empty list is allowed)
* **expression**: optional (but if present it must have a content, i.e. `{}` is not allowed)
* **q**: optional (but if present it must be not empty, i.e. `""` is not allowed)
* **georel**: optional (but if present it must be not empty, i.e. `""` is not allowed)
* **geometry**: optional (but if present it must be not empty, i.e. `""` is not allowed)
* **coords**: optional (but if present it must be not empty, i.e. `""` is not allowed)
* **entities**: mandatory
* **id** or **idPattern**: one of them is mandatory (but both at the same time is not allowed). id
must follow NGSIv2 restrictions for IDs. idPattern must be not empty and a valid regex.
* **type**: optional (but if present it must follow NGSIv2 restrictions for IDs)
* **condition**: optional (but if present it must have a content, i.e. `{}` is not allowed)
* **attrs**: optional (but if present it must be a list; empty list is allowed)
* **expression**: optional (but if present it must have a content, i.e. `{}` is not allowed)
* **q**: optional (but if present it must be not empty, i.e. `""` is not allowed)
* **georel**: optional (but if present it must be not empty, i.e. `""` is not allowed)
* **geometry**: optional (but if present it must be not empty, i.e. `""` is not allowed)
* **coords**: optional (but if present it must be not empty, i.e. `""` is not allowed)
* **notification**:
* **http**: must be present if `httpCustom` is omitted, forbidden otherwise
* **url**: mandatory (must be a valid URL)
* **httpCustom**: must be present if `http` is omitted, forbidden otherwise
* **url**: mandatory (must be not empty)
* **headers**: optional (but if present it must have a content, i.e. `{}` is not allowed)
* **qs**: optional (but if present it must have a content, i.e. `{}` is not allowed)
* **method**: optional (but if present it must be a valid HTTP method)
* **payload**: optional (empty string is allowed)
* **attrs**: optional (but if present it must be a list; empty list is allowed)
* **metadata**: optional (but if present it must be a list; empty list is allowed)
* **exceptAttrs**: optional (but it cannot be present if `attrs` is also used; if present it must be a non-empty list)
* **attrsFormat**: optional (but if present it must be a valid attrs format keyword)
* **http**: must be present if `httpCustom` is omitted, forbidden otherwise
* **url**: mandatory (must be a valid URL)
* **httpCustom**: must be present if `http` is omitted, forbidden otherwise
* **url**: mandatory (must be not empty)
* **headers**: optional (but if present it must have a content, i.e. `{}` is not allowed)
* **qs**: optional (but if present it must have a content, i.e. `{}` is not allowed)
* **method**: optional (but if present it must be a valid HTTP method)
* **payload**: optional (empty string is allowed)
* **attrs**: optional (but if present it must be a list; empty list is allowed)
* **metadata**: optional (but if present it must be a list; empty list is allowed)
* **exceptAttrs**: optional (but it cannot be present if `attrs` is also used; if present it must be a non-empty list)
* **attrsFormat**: optional (but if present it must be a valid attrs format keyword)
* **throttling**: optional (must be an integer)
* **expires**: optional (must be a date or empty string "")
* **status**: optional (must be a valid status keyword)


# actionType metadata

From NGSIv2 specification section "Special metadata in notifications", regarding `actionType` metadata:
Expand Down
42 changes: 21 additions & 21 deletions doc/manuals/user/walkthrough_apiv1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,31 @@
* [Issuing commands to the broker](#issuing-commands-to-the-broker)
* [Context management using NGSI10](#context-management-using-ngsi10)
* [NGSI10 standard operations](#ngsi10-standard-operations)
* [Entity Creation](#entity-creation)
* [Query Context operation](#query-context-operation)
* [Update Context elements](#update-context-elements)
* [Context Subscriptions](#context-subscriptions)
* [Summary of NGSI10 standard operations URLs](#summary-of-ngsi10-standard-operations-urls)
* [Entity Creation](#entity-creation)
* [Query Context operation](#query-context-operation)
* [Update Context elements](#update-context-elements)
* [Context Subscriptions](#context-subscriptions)
* [Summary of NGSI10 standard operations URLs](#summary-of-ngsi10-standard-operations-urls)
* [NGSI10 convenience operations](#ngsi10-convenience-operations)
* [Convenience Entity Creation](#convenience-entity-creation)
* [Convenience Query Context](#convenience-query-context)
* [Getting all entities](#getting-all-entities)
* [Browsing all types and detailed information on a type](#browsing-all-types-and-detailed-information-on-a-type)
* [Convenience Update Context](#convenience-update-context)
* [Convenience operations for context subscriptions](#convenience-operations-for-context-subscriptions)
* [Summary of NGSI10 convenience operations URLs](#summary-of-ngsi10-convenience-operations-urls)
* [Convenience Entity Creation](#convenience-entity-creation)
* [Convenience Query Context](#convenience-query-context)
* [Getting all entities](#getting-all-entities)
* [Browsing all types and detailed information on a type](#browsing-all-types-and-detailed-information-on-a-type)
* [Convenience Update Context](#convenience-update-context)
* [Convenience operations for context subscriptions](#convenience-operations-for-context-subscriptions)
* [Summary of NGSI10 convenience operations URLs](#summary-of-ngsi10-convenience-operations-urls)
* [Context availability management using NGSI9](#context-availability-management-using-ngsi9)
* [NGSI9 standard operations](#ngsi9-standard-operations)
* [Register Context operation](#register-context-operation)
* [Discover Context Availability operation](#discover-context-availability-operation)
* [Context availability subscriptions](#context-availability-subscriptions)
* [Summary of NGSI9 standard operations URLs](#summary-of-ngsi9-standard-operations-urls)
* [Register Context operation](#register-context-operation)
* [Discover Context Availability operation](#discover-context-availability-operation)
* [Context availability subscriptions](#context-availability-subscriptions)
* [Summary of NGSI9 standard operations URLs](#summary-of-ngsi9-standard-operations-urls)
* [NGSI9 convenience operations](#ngsi9-convenience-operations)
* [Convenience Register Context](#convenience-register-context)
* [Only-type entity registrations using convenience operations](#only-type-entity-registrations-using-convenience-operations)
* [Convenience Discover Context Availability](#convenience-discover-context-availability)
* [Convenience operations for context availability subscriptions](#convenience-operations-for-context-availability-subscriptions)
* [Summary of NGSI9 convenience operations URLs](#summary-of-ngsi9-convenience-operations-urls)
* [Convenience Register Context](#convenience-register-context)
* [Only-type entity registrations using convenience operations](#only-type-entity-registrations-using-convenience-operations)
* [Convenience Discover Context Availability](#convenience-discover-context-availability)
* [Convenience operations for context availability subscriptions](#convenience-operations-for-context-availability-subscriptions)
* [Summary of NGSI9 convenience operations URLs](#summary-of-ngsi9-convenience-operations-urls)

## Introduction

Expand Down