Merge pull request #6304 from hashicorp/d-ns-quota-api

website: document Quota field in ns payloads
This commit is contained in:
Mahmood Ali 2019-09-09 16:54:04 -04:00 committed by GitHub
commit 2ca11b9121
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 3 deletions

View File

@ -54,13 +54,15 @@ $ curl \
"CreateIndex": 31, "CreateIndex": 31,
"Description": "Production API Servers", "Description": "Production API Servers",
"ModifyIndex": 31, "ModifyIndex": 31,
"Name": "api-prod" "Name": "api-prod",
"Quota": ""
}, },
{ {
"CreateIndex": 5, "CreateIndex": 5,
"Description": "Default shared namespace", "Description": "Default shared namespace",
"ModifyIndex": 5, "ModifyIndex": 5,
"Name": "default" "Name": "default",
"Quota": ""
} }
] ]
``` ```
@ -98,6 +100,7 @@ $ curl \
{ {
"CreateIndex": 31, "CreateIndex": 31,
"Description": "Production API Servers", "Description": "Production API Servers",
"Quota": "",
"Hash": "N8WvePwqkp6J354eLJMKyhvsFdPELAos0VuBfMoVKoU=", "Hash": "N8WvePwqkp6J354eLJMKyhvsFdPELAos0VuBfMoVKoU=",
"ModifyIndex": 31, "ModifyIndex": 31,
"Name": "api-prod" "Name": "api-prod"
@ -128,12 +131,15 @@ The table below shows this endpoint's support for
- `Description` `(string: "")` - Specifies an optional human-readable - `Description` `(string: "")` - Specifies an optional human-readable
description of the namespace. description of the namespace.
- `Quota` `(string: "")` - Specifies an quota to attach to the namespace.
### Sample Payload ### Sample Payload
```javascript ```javascript
{ {
"Name": "api-prod", "Name": "api-prod",
"Description": "Production API Servers" "Description": "Production API Servers",
"Quota": "prod-quota"
} }
``` ```