Skip to content

Commit

Permalink
Updated description for general entry types
Browse files Browse the repository at this point in the history
  • Loading branch information
@ml-evs
ml-evs committed Jun 16, 2020
1 parent 861a573 commit af18b6d
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 86 deletions.
16 changes: 8 additions & 8 deletions openapi/index_openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -346,12 +346,12 @@
"id": {
"title": "Id",
"type": "string",
"description": "An entry's ID as defined in section `Definition of Terms`_.\n- **Type**: string.\n- **Requirements/Conventions**:\n\n - **Support**: REQUIRED, MUST NOT be :val:`null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response.\n - See section `Definition of Terms`_.\n\n- **Examples**:\n\n - :val:`\"db/1234567\"`\n - :val:`\"cod/2000000\"`\n - :val:`\"cod/2000000@1234567\"`\n - :val:`\"nomad/L1234567890\"`\n - :val:`\"42\"`"
"description": "An entry's ID as defined in section Definition of Terms.\n\n- **Type**: string.\n\n- **Requirements/Conventions**:\n - **Support**: MUST be supported by all implementations, MUST NOT be `null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response.\n\n- **Examples**:\n - `\"db/1234567\"`\n - `\"cod/2000000\"`\n - `\"cod/2000000@1234567\"`\n - `\"nomad/L1234567890\"`\n - `\"42\"`"
},
"type": {
"title": "Type",
"type": "string",
"description": "The name of the type of an entry.\n- **Type**: string.\n- **Requirements/Conventions**:\n\n - **Support**: REQUIRED, MUST NOT be :val:`null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response.\n - MUST be an existing entry type.\n - The entry of type `<type>` and ID `<id>` MUST be returned in response to a request for :endpoint:`/<type>/<id>` under the versioned base URL.\n\n- **Example**: :val:`\"structures\"`"
"description": "The name of the type of an entry.\n\n- **Type**: string.\n\n- **Requirements/Conventions**:\n - **Support**: MUST be supported by all implementations, MUST NOT be `null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response.\n - MUST be an existing entry type.\n - The entry of type `<type>` and ID `<id>` MUST be returned in response to a request for `/<type>/<id>` under the versioned base URL.\n\n- **Example**: `\"structures\"`"
},
"links": {
"title": "Links",
Expand All @@ -378,7 +378,7 @@
"$ref": "#/components/schemas/EntryResourceAttributes"
}
],
"description": "a dictionary, containing key-value pairs representing the entry's properties, except for type and id.\n\nDatabase-provider-specific properties need to include the database-provider-specific prefix\n(see appendix `Database-Provider-Specific Namespace Prefixes`_)."
"description": "A dictionary, containing key-value pairs representing the entry's properties, except for `type` and `id`.\nDatabase-provider-specific properties need to include the database-provider-specific prefix (see section on Database-Provider-Specific Namespace Prefixes)."
},
"relationships": {
"title": "Relationships",
Expand All @@ -387,7 +387,7 @@
"$ref": "#/components/schemas/EntryRelationships"
}
],
"description": "a dictionary containing references to other entries according to the description in section `Relationships`_\nencoded as `JSON API Relationships <https://jsonapi.org/format/1.0/#document-resource-object-relationships>`__.\nThe OPTIONAL human-readable description of the relationship MAY be provided in the :field:`description` field inside the :field:`meta` dictionary."
"description": "A dictionary containing references to other entries according to the description in section Relationships encoded as [JSON API Relationships](https://jsonapi.org/format/1.0/#document-resource-object-relationships).\nThe OPTIONAL human-readable description of the relationship MAY be provided in the `description` field inside the `meta` dictionary of the JSON API resource identifier object."
}
},
"description": "Resource objects appear in a JSON:API document to represent resources."
Expand All @@ -402,12 +402,12 @@
"immutable_id": {
"title": "Immutable Id",
"type": "string",
"description": "The entry's immutable ID (e.g., an UUID).\nThis is important for databases having preferred IDs that point to \"the latest version\" of a record, but still offer access to older variants.\nThis ID maps to the version-specific record, in case it changes in the future.\n- **Type**: string.\n- **Requirements/Conventions**:\n\n - **Support**: OPTIONAL, i.e., MAY be :val:`null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n\n- **Examples**:\n\n - :val:`\"8bd3e750-b477-41a0-9b11-3a799f21b44f\"`\n - :val:`\"fjeiwoj,54;@=%<>#32\"` (Strings that are not URL-safe are allowed.)"
"description": "The entry's immutable ID (e.g., an UUID). This is important for databases having preferred IDs that point to \"the latest version\" of a record, but still offer access to older variants. This ID maps to the version-specific record, in case it changes in the future.\n\n- **Type**: string.\n\n- **Requirements/Conventions**:\n - **Support**: OPTIONAL support in implementations, i.e., MAY be `null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n\n- **Examples**:\n - `\"8bd3e750-b477-41a0-9b11-3a799f21b44f\"`\n - `\"fjeiwoj,54;@=%<>#32\"` (Strings that are not URL-safe are allowed.)"
},
"last_modified": {
"title": "Last Modified",
"type": "string",
"description": "Date and time representing when the entry was last modified.\n- **Type**: timestamp.\n- **Requirements/Conventions**:\n\n - **Support**: SHOULD be supported, i.e., SHOULD NOT be :val:`null`. Is REQUIRED in this implementation, i.e., MUST NOT be :val:`null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response unless the query parameter :query-param:`response_fields` is present and does not include this property.\n\n- **Example**:\n\n - As part of JSON response format: :VAL:`\"2007-04-05T14:30Z\"` (i.e., encoded as an `RFC 3339 Internet Date/Time Format <https://tools.ietf.org/html/rfc3339#section-5.6>`__ string.)",
"description": "Date and time representing when the entry was last modified.\n\n- **Type**: timestamp.\n\n- **Requirements/Conventions**:\n - **Support**: SHOULD be supported by all implementations, i.e., SHOULD NOT be `null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response unless the query parameter `response_fields` is present and does not include this property.\n\n- **Example**:\n - As part of JSON response format: `\"2007-04-05T14:30:20Z\"` (i.e., encoded as an [RFC 3339 Internet Date/Time Format](https://tools.ietf.org/html/rfc3339#section-5.6) string.)",
"format": "date-time"
}
},
Expand Down Expand Up @@ -905,7 +905,7 @@
"id": {
"title": "Id",
"type": "string",
"description": "An entry's ID as defined in section `Definition of Terms`_.\n- **Type**: string.\n- **Requirements/Conventions**:\n\n - **Support**: REQUIRED, MUST NOT be :val:`null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response.\n - See section `Definition of Terms`_.\n\n- **Examples**:\n\n - :val:`\"db/1234567\"`\n - :val:`\"cod/2000000\"`\n - :val:`\"cod/2000000@1234567\"`\n - :val:`\"nomad/L1234567890\"`\n - :val:`\"42\"`"
"description": "An entry's ID as defined in section Definition of Terms.\n\n- **Type**: string.\n\n- **Requirements/Conventions**:\n - **Support**: MUST be supported by all implementations, MUST NOT be `null`.\n - **Query**: MUST be a queryable property with support for all mandatory filter features.\n - **Response**: REQUIRED in the response.\n\n- **Examples**:\n - `\"db/1234567\"`\n - `\"cod/2000000\"`\n - `\"cod/2000000@1234567\"`\n - `\"nomad/L1234567890\"`\n - `\"42\"`"
},
"type": {
"title": "Type",
Expand Down Expand Up @@ -946,7 +946,7 @@
"$ref": "#/components/schemas/EntryRelationships"
}
],
"description": "a dictionary containing references to other entries according to the description in section `Relationships`_\nencoded as `JSON API Relationships <https://jsonapi.org/format/1.0/#document-resource-object-relationships>`__.\nThe OPTIONAL human-readable description of the relationship MAY be provided in the :field:`description` field inside the :field:`meta` dictionary."
"description": "A dictionary containing references to other entries according to the description in section Relationships encoded as [JSON API Relationships](https://jsonapi.org/format/1.0/#document-resource-object-relationships).\nThe OPTIONAL human-readable description of the relationship MAY be provided in the `description` field inside the `meta` dictionary of the JSON API resource identifier object."
}
},
"description": "A Links endpoint resource object"
Expand Down

0 comments on commit af18b6d

Please sign in to comment.