Skip to content

Commit c72aff6

Browse files
committed
clean up general info links
1 parent 9166112 commit c72aff6

2 files changed

Lines changed: 15 additions & 39 deletions

File tree

agency/README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,11 @@ This specification uses data types including timestamps, UUIDs, and vehicle stat
2323

2424
`agency` APIs must handle requests for specific versions of the specification from clients.
2525

26-
Versioning must be implemented as specified in the [`General information versioning section`][versioning].
26+
Versioning must be implemented as specified in the [Versioning section][versioning].
2727

28-
### Responses
28+
### Responses and Error Messages
2929

30-
See [responses][responses]
31-
32-
### Error Message Format
33-
34-
See [error message format][error-message-format]
30+
See the [Responses][responses] and [Error Messages][error-messages] sections.
3531

3632
### Authorization
3733

@@ -240,9 +236,9 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
240236
[general]: /general-information.md
241237
[versioning]: /general-information.md#versioning
242238
[responses]: /general-information.md#responses
243-
[error-message-format]: /general-information.md#error-message-format
239+
[error-messages]: /general-information.md#error-messages
244240
[vehicle-types]: /general-information.md#vehicle-types
245241
[vehicle-states]: /general-information.md#vehicle-states
246-
[vehicle-events]: /general-information.md#vehicle-events
242+
[vehicle-events]: /general-information.md#vehicle-state-events
247243
[propulsion-types]: /general-information.md#propulsion-types
248244
[hdop]: https://support.esri.com/en/other-resources/gis-dictionary/term/358112bd-b61c-4081-9679-4fca9e3eb926

policy/README.md

Lines changed: 10 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The following information applies to all `policy` API endpoints.
1919

2020
`policy` APIs must handle requests for specific versions of the specification from clients.
2121

22-
Versioning must be implemented as specified in the [`General information versioning section`][versioning].
22+
Versioning must be implemented as specified in the [Versioning section][versioning].
2323

2424
## Background
2525

@@ -63,31 +63,11 @@ Among other use-cases, configuring a REST API allows an Agency to:
6363

6464
Responses must set the `Content-Type` header, as specified in the [Provider versioning][versioning] section.
6565

66-
#### HTTP Response Codes
66+
#### Responses and Error Messages
6767

68-
The response to a client request must include a valid HTTP status code defined in the [IANA HTTP Status Code Registry][iana]
68+
The response to a client request must include a valid HTTP status code defined in the [IANA HTTP Status Code Registry][iana].
6969

70-
- **200:** OK: operation successful.
71-
- **400:** Bad request.
72-
- **401:** Unauthorized: Invalid, expired, or insufficient scope of token.
73-
- **404:** Not Found: Object(s) do not exist.
74-
- **500:** Internal server error.
75-
76-
#### Error Responses
77-
78-
```json
79-
{
80-
"error": "...",
81-
"error_description": "...",
82-
"error_details": [ "...", "..." ]
83-
}
84-
```
85-
86-
| Field | Type | Field Description |
87-
| ------------------- | -------- | ---------------------- |
88-
| `error` | String | Error message string |
89-
| `error_description` | String | Human readable error description (can be localized) |
90-
| `error_details` | String[] (optional) | Array of error details |
70+
See the [Responses section][responses] for information on valid MDS response codes and the [Error Messages section][error-messages] for information on formatting error messages.
9171

9272
#### Policies
9373

@@ -281,13 +261,13 @@ The internal mechanics of ordering are up to the Policy editing and hosting soft
281261

282262
[Top][toc]
283263

284-
[toc]: #table-of-contents
264+
[beta]: /general-information.md#beta
285265
[iana]: https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
286266
[muni-boundary]: ../provider/README.md#municipality-boundary
267+
[propulsion-types]: /general-information.md#propulsion-types
287268
[timestamps]: /general-information.md#timestamps
288-
[beta]: /general-information.md#beta
289-
[versioning]: /general-information.md#versioning
290-
[vehicle-types]: /general-information.md#vehicle-types
269+
[toc]: #table-of-contents
270+
[vehicle-events]: /general-information.md#vehicle-state-events
291271
[vehicle-states]: /general-information.md#vehicle-states
292-
[vehicle-events]: /general-information.md#vehicle-events
293-
[propulsion-types]: /general-information.md#propulsion-types
272+
[vehicle-types]: /general-information.md#vehicle-types
273+
[versioning]: /general-information.md#versioning

0 commit comments

Comments
 (0)