Skip to content

Commit

Permalink
autogen(docs): generate and format documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Jan 21, 2022
1 parent 29bb94a commit 169d63e
Show file tree
Hide file tree
Showing 12 changed files with 384 additions and 767 deletions.
63 changes: 6 additions & 57 deletions docs/docs/.static/api.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,22 +33,19 @@
"type": "string",
"description": "Namespace of the Relation Tuple",
"name": "namespace",
"in": "query",
"required": true
"in": "query"
},
{
"type": "string",
"description": "Object of the Relation Tuple",
"name": "object",
"in": "query",
"required": true
"in": "query"
},
{
"type": "string",
"description": "Relation of the Relation Tuple",
"name": "relation",
"in": "query",
"required": true
"in": "query"
},
{
"type": "string",
Expand Down Expand Up @@ -695,60 +692,13 @@
}
},
"delete": {
"description": "Use this endpoint to delete a relation tuple.",
"description": "Use this endpoint to delete relation tuples",
"consumes": ["application/x-www-form-urlencoded"],
"produces": ["application/json"],
"schemes": ["http", "https"],
"tags": ["write"],
"summary": "Delete a Relation Tuple",
"operationId": "deleteRelationTuple",
"parameters": [
{
"type": "string",
"description": "Namespace of the Relation Tuple",
"name": "namespace",
"in": "query",
"required": true
},
{
"type": "string",
"description": "Object of the Relation Tuple",
"name": "object",
"in": "query",
"required": true
},
{
"type": "string",
"description": "Relation of the Relation Tuple",
"name": "relation",
"in": "query",
"required": true
},
{
"type": "string",
"description": "SubjectID of the Relation Tuple",
"name": "subject_id",
"in": "query"
},
{
"type": "string",
"description": "Namespace of the Subject Set",
"name": "subject_set.namespace",
"in": "query"
},
{
"type": "string",
"description": "Object of the Subject Set",
"name": "subject_set.object",
"in": "query"
},
{
"type": "string",
"description": "Relation of the Subject Set",
"name": "subject_set.relation",
"in": "query"
}
],
"summary": "Delete Relation Tuples",
"operationId": "deleteRelationTuples",
"responses": {
"204": {
"description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201."
Expand Down Expand Up @@ -995,7 +945,6 @@
},
"RelationQuery": {
"type": "object",
"required": ["namespace"],
"properties": {
"namespace": {
"description": "Namespace of the Relation Tuple",
Expand Down

0 comments on commit 169d63e

Please sign in to comment.