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.

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

add versioning for Agency and Policy API #444

Merged
merged 8 commits into from
Feb 26, 2020
Merged
Changes from 2 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
17 changes: 17 additions & 0 deletions agency/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This specification contains a collection of RESTful APIs used to specify the dig

## Table of Contents

* [General Information](#general-information)
* [Authorization](#authorization)
* [Timestamps](#timestamps)
* [Vehicles](#vehicles)
Expand All @@ -18,6 +19,18 @@ This specification contains a collection of RESTful APIs used to specify the dig
* [Enum definitions](#enum-definitions)
* [Responses](#responses)

## General information

The following information applies to all `agency` API endpoints. Details on providing authorization to endpoints is specified in the [Authorization](#authorization) section.

### Versioning

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

Versioning must be implemented as specified in the [`Provider API versioning section`][Provider/versioning].

Since versioning was not added until the 0.4.1 release, if the Accept header is not set as specified above, the Agency API must respond as if version 0.3 was requested.
Retzoh marked this conversation as resolved.
Show resolved Hide resolved

## Authorization

When making requests, the Agency API expects `provider_id` to be part of the claims in a [JWT](https://jwt.io/) `access_token` in the `Authorization` header, in the form `Authorization: Bearer <access_token>`. The token issuance, expiration and revocation policies are at the discretion of the Agency.
Expand Down Expand Up @@ -299,3 +312,7 @@ A vehicle may have one or more values from the `propulsion`, depending on the nu
| `error` | String | Error message string |
| `error_description` | String | Human readable error description (can be localized) |
| `error_details` | String[] | Array of error details |

[Top][toc]

[provider/versioning]: /provider/README.md#versioning
Retzoh marked this conversation as resolved.
Show resolved Hide resolved