From 3860ba2d419dba1166f1022c434105665d3bcb67 Mon Sep 17 00:00:00 2001 From: Gray Brooks Date: Wed, 6 Mar 2019 10:31:15 -0500 Subject: [PATCH] add a sentence about versioning --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d4a8ed..02be9ba 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ The api.gsa.gov service also provides: Keys managed by api.data.gov can be re-used with other APIs hosted by this service, which reduces complexity for users. This service also allows the use of a DEMO_KEY for unauthenticated access, without keys, which reduces the "Time To First Hello World" for developers using your API. ### 4. Provide Support For Versioning -All APIs must support versioning. The recommended method of versioning REST APIs is to include a major version number in the URL path. For example "/v1/". An example of this method can be found at: https://gsa.github.io/sam_api/sam/versioning.html. +All APIs must support versioning. The recommended method of versioning REST APIs is to include a major version number in the URL path. For example "/v1/". An example of this method can be found at: https://gsa.github.io/sam_api/sam/versioning.html. Refer to the section on [Standard API Endpoint Design](https://github.com/gsa/api-standards#8-follow-the-standard-api-endpoint-design) for more on where in the URL path to place the versioning. #### Major and Minor Versions Major versions (e.g. v1, v2) should be reserved for breaking changes and major releases. Minor versions (eg. 1.1, 2.3) are not required, but can provide additional information about the API. If used, they should not be in the URL, but should be in the HTTP Headers.