|
9 | 9 | |
10 | 10 | DDI is an international standard for describing statistical and social science data. |
11 | 11 | |
| 12 | + ## Response Formats |
| 13 | + |
| 14 | + The API supports DDI-specific response formats: |
| 15 | + - `application/vnd.ddi.structure+json;version=3.3` - DDI JSON format (default if no Accept header is provided) |
| 16 | + - `application/vnd.ddi.structure+xml;version=3.3` - DDI XML format |
| 17 | + |
| 18 | + If no `Accept` header is provided, the API returns DDI JSON format by default. |
| 19 | + |
12 | 20 | servers: |
13 | 21 | - description: Mock API Server |
14 | 22 | url: http://ddi-api.making-sense.info/ddi/v1 |
|
54 | 62 | Variables describe the structure of data elements within a dataset. They include information such as name, label, description, and references to associated concepts. |
55 | 63 | |
56 | 64 | Variables can be filtered by various criteria including study, dataset, or concept references. |
| 65 | + |
| 66 | + **Response Format**: If no `Accept` header is provided, returns DDI JSON format (`application/vnd.ddi.structure+json;version=3.3`) by default. |
57 | 67 | parameters: |
58 | 68 | - $ref: "#/components/parameters/urn" |
59 | 69 | - $ref: "#/components/parameters/agencyID" |
|
84 | 94 | - An ID (if agencyID and version are provided as query parameters) |
85 | 95 | |
86 | 96 | Returns detailed information about the variable including its structure, concepts, and related metadata. |
| 97 | + |
| 98 | + **Response Format**: If no `Accept` header is provided, returns DDI JSON format (`application/vnd.ddi.structure+json;version=3.3`) by default. |
87 | 99 | parameters: |
88 | 100 | - $ref: "#/components/parameters/variableID-path" |
89 | 101 | - $ref: "#/components/parameters/agencyID" |
@@ -885,7 +897,10 @@ components: |
885 | 897 |
|
886 | 898 | responses: |
887 | 899 | "200-variables": |
888 | | - description: OK - List of variables |
| 900 | + description: | |
| 901 | + OK - List of variables. |
| 902 | + |
| 903 | + **Default format**: If no `Accept` header is provided, returns DDI JSON format (`application/vnd.ddi.structure+json;version=3.3`). |
889 | 904 | content: |
890 | 905 | application/vnd.ddi.structure+xml;version=3.3: |
891 | 906 | description: | |
@@ -933,6 +948,7 @@ components: |
933 | 948 | </l:Variable> |
934 | 949 | </g:ResourcePackage> |
935 | 950 | application/vnd.ddi.structure+json;version=3.3: |
| 951 | + description: DDI JSON format (default if no Accept header is provided) |
936 | 952 | schema: |
937 | 953 | type: array |
938 | 954 | items: |
@@ -986,6 +1002,7 @@ components: |
986 | 1002 | </l:Variable> |
987 | 1003 | </g:ResourcePackage> |
988 | 1004 | application/vnd.ddi.structure+json;version=3.3: |
| 1005 | + description: DDI JSON format (default if no Accept header is provided) |
989 | 1006 | schema: |
990 | 1007 | $ref: "#/components/schemas/Variable" |
991 | 1008 | "200-concepts": |
|
0 commit comments