Skip to content

Commit

Permalink
docs(explorer): Add documentation for the attributeStyle search param…
Browse files Browse the repository at this point in the history
…eter
  • Loading branch information
steveoh committed Aug 8, 2024
1 parent 8776288 commit 37ec3a1
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions src/explorer/src/content/docs/docs/v1/endpoints/searching.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,31 @@ A distance in meters to buffer the input geometry. 2000 meters is the maximum bu
- **Default**: `0`
- **Example**: `10`

### attributeStyle

The format the input field name keys are returned as in the `result` array `attributes` dictionary. This is useful for having consistent access to the response data keys in code.

- **Type**: `string`
- **Default**: `lower`
- **Can be one of**: `lower`, `upper`, `input`
- **Example (lower)**:

```json
[{ "attributes": { "name": "SALT LAKE" } }]
```

- **Example (upper)**:

```json
[{ "attributes": { "NAME": "SALT LAKE" } }]
```

- **Example (input)**: where the `fields` input is `Name`

```json
[{ "attributes": { "Name": "SALT LAKE" } }]
```

### spatialReference

<SpatialReference />
Expand Down

0 comments on commit 37ec3a1

Please sign in to comment.