Skip to content

Commit 67adec3

Browse files
authored
Clarify graph collection removal, add missing collection/View response descriptions, improve OpenAPI rendering (#467)
* Clarify graph collection removal * WIP Add missing response descriptions * Improve OpenAPI rendering * Show default value * Fix logic for determining whether a (sub-)property is required/always present * Render description with page context to generate proper internal links * Handle the corner case of top-level type array without items attribute * Log first 4 lines of OpenAPI block in case of YAML unmarshalling error for context * Substitute relative links with absolute URLs for OpenAPI JSON / Swagger UI * Don't render anchor/fragment identifier of polymorphic endpoints * Convert default values to JSON for properties (but not parameters), use proper attribute for params * Display descriptive HTTP status next to the code * Render possible enum values at end of description * Add missing and improve existing request and response descriptions for collections, Views, named graphs * Add link from jobs API to HTTP request handling * Documenting default values for responses doesn't make much sense
1 parent 1ecc9ee commit 67adec3

File tree

20 files changed

+10876
-1511
lines changed

20 files changed

+10876
-1511
lines changed

site/content/3.10/develop/http-api/graphs/named-graphs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1817,7 +1817,7 @@ paths:
18171817
in: query
18181818
required: false
18191819
description: |
1820-
Drop the collection as well.
1820+
Drop the collection in addition to removing it from the graph.
18211821
The collection is only dropped if it is not used in other graphs.
18221822
schema:
18231823
type: boolean
@@ -2803,7 +2803,7 @@ paths:
28032803
in: query
28042804
required: false
28052805
description: |
2806-
Drop the collection as well.
2806+
Drop the edge collection in addition to removing it from the graph.
28072807
The collection is only dropped if it is not used in other graphs.
28082808
schema:
28092809
type: boolean
@@ -3261,7 +3261,7 @@ paths:
32613261
in: query
32623262
required: false
32633263
description: |
3264-
Drop the collection as well.
3264+
Drop the edge collection in addition to removing it from the graph.
32653265
The collection is only dropped if it is not used in other graphs.
32663266
schema:
32673267
type: boolean

site/content/3.11/develop/http-api/graphs/named-graphs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1817,7 +1817,7 @@ paths:
18171817
in: query
18181818
required: false
18191819
description: |
1820-
Drop the collection as well.
1820+
Drop the collection in addition to removing it from the graph.
18211821
The collection is only dropped if it is not used in other graphs.
18221822
schema:
18231823
type: boolean
@@ -2803,7 +2803,7 @@ paths:
28032803
in: query
28042804
required: false
28052805
description: |
2806-
Drop the collection as well.
2806+
Drop the edge collection in addition to removing it from the graph.
28072807
The collection is only dropped if it is not used in other graphs.
28082808
schema:
28092809
type: boolean
@@ -3261,7 +3261,7 @@ paths:
32613261
in: query
32623262
required: false
32633263
description: |
3264-
Drop the collection as well.
3264+
Drop the edge collection in addition to removing it from the graph.
32653265
The collection is only dropped if it is not used in other graphs.
32663266
schema:
32673267
type: boolean

0 commit comments

Comments
 (0)