Skip to content

Commit 4413652

Browse files
author
Z
committed
Address review comments
1 parent ba7cf44 commit 4413652

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

namespaces/api-namespace.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,18 @@ For example a `category` element may be classified both as `resourceGroup` and
5050
{
5151
"element": "category",
5252
"meta": {
53-
"class": "api",
53+
"class": [
54+
"api"
55+
],
5456
"title": "Polls API"
5557
},
5658
"content": [
5759
{
5860
"element": "category",
5961
"meta": {
60-
"class": "resourceGroup",
62+
"class": [
63+
"resourceGroup"
64+
],
6165
"title": "Question",
6266
"description": "Resources related to questions in the API."
6367
},
@@ -73,8 +77,8 @@ Copy element represents a copy text. A textual information in API description.
7377
Its content is a string and it MAY include information about the media type
7478
of the copy's content.
7579

76-
If a Copy element the parent's element `description` metadata MAY include its
77-
content.
80+
If an element contains a Copy element, the element's `description` metadata
81+
MAY include the Copy element's content.
7882

7983
The Copy element MAY appear as a content of any element defined in the base
8084
namespaces.
@@ -83,14 +87,13 @@ namespaces.
8387

8488
- `element`: copy (string, fixed)
8589
- `attributes` (object)
86-
- `contentType` (string) - Optional media type of the content E.g. text/html or text/plain.
90+
- `contentType`: *text/plain* (string) - Optional media type of the content.
8791
- `content` (string)
8892

8993
### Example
9094

9195
Given an API description with following layout:
9296

93-
9497
- Group
9598
- Copy "Lorem Ipsum"
9699
- Resource "A"

0 commit comments

Comments
 (0)