-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge "REST: Split OpenAPI document into domain fragments"
- Loading branch information
Showing
11 changed files
with
2,257 additions
and
322 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
{ | ||
"openapi": "3.1.0", | ||
"info": { | ||
"title": "Wikibase CRUD Domain REST API", | ||
"version": "1.1", | ||
"description": "OpenAPI fragment of the Wikibase CRUD domain REST API" | ||
}, | ||
"paths": { | ||
"/v1/property-data-types": { | ||
"get": { | ||
"operationId": "getPropertyDataTypes", | ||
"tags": [ "Property data types" ], | ||
"summary": "Retrieve the map of Property data types to value types", | ||
"responses": { | ||
"200": { | ||
"description": "The map of Property data types to value types", | ||
"content": { | ||
"application/json": { | ||
"schema": { | ||
"type": "object", | ||
"additionalProperties": { | ||
"type": "string" | ||
} | ||
}, | ||
"example": { | ||
"data-type": "value-type" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"/v1/entities/items": { | ||
"$ref": "resources/items/list.json" | ||
}, | ||
"/v1/entities/items/{item_id}": { | ||
"$ref": "resources/items/single.json" | ||
}, | ||
"/v1/entities/items/{item_id}/sitelinks": { | ||
"$ref": "resources/sitelinks/list.json" | ||
}, | ||
"/v1/entities/items/{item_id}/sitelinks/{site_id}": { | ||
"$ref": "resources/sitelinks/single.json" | ||
}, | ||
"/v1/entities/properties": { | ||
"$ref": "resources/properties/list.json" | ||
}, | ||
"/v1/entities/properties/{property_id}": { | ||
"$ref": "resources/properties/single.json" | ||
}, | ||
"/v1/entities/items/{item_id}/descriptions": { | ||
"$ref": "resources/descriptions/list-for-item.json" | ||
}, | ||
"/v1/entities/properties/{property_id}/descriptions": { | ||
"$ref": "resources/descriptions/list-for-property.json" | ||
}, | ||
"/v1/entities/items/{item_id}/descriptions/{language_code}": { | ||
"$ref": "resources/descriptions/description-in-language-for-item.json" | ||
}, | ||
"/v1/entities/items/{item_id}/descriptions_with_language_fallback/{language_code}": { | ||
"$ref": "resources/descriptions/description-with-fallback-for-item.json" | ||
}, | ||
"/v1/entities/properties/{property_id}/descriptions/{language_code}": { | ||
"$ref": "resources/descriptions/description-in-language-for-property.json" | ||
}, | ||
"/v1/entities/properties/{property_id}/descriptions_with_language_fallback/{language_code}": { | ||
"$ref": "resources/descriptions/description-with-fallback-for-property.json" | ||
}, | ||
"/v1/entities/items/{item_id}/statements": { | ||
"$ref": "resources/statements/list-for-item.json" | ||
}, | ||
"/v1/entities/items/{item_id}/statements/{statement_id}": { | ||
"$ref": "resources/statements/single-for-item.json" | ||
}, | ||
"/v1/entities/items/{item_id}/labels": { | ||
"$ref": "resources/labels/list-for-item.json" | ||
}, | ||
"/v1/entities/properties/{property_id}/labels": { | ||
"$ref": "resources/labels/list-for-property.json" | ||
}, | ||
"/v1/entities/items/{item_id}/labels/{language_code}": { | ||
"$ref": "resources/labels/label-in-language-for-item.json" | ||
}, | ||
"/v1/entities/items/{item_id}/labels_with_language_fallback/{language_code}": { | ||
"$ref": "resources/labels/label-with-fallback-for-item.json" | ||
}, | ||
"/v1/entities/properties/{property_id}/labels/{language_code}": { | ||
"$ref": "resources/labels/label-in-language-for-property.json" | ||
}, | ||
"/v1/entities/properties/{property_id}/labels_with_language_fallback/{language_code}": { | ||
"$ref": "resources/labels/label-with-fallback-for-property.json" | ||
}, | ||
"/v1/entities/items/{item_id}/aliases": { | ||
"$ref": "resources/aliases/list-for-item.json" | ||
}, | ||
"/v1/entities/properties/{property_id}/aliases": { | ||
"$ref": "resources/aliases/list-for-property.json" | ||
}, | ||
"/v1/entities/items/{item_id}/aliases/{language_code}": { | ||
"$ref": "resources/aliases/aliases-in-language-for-item.json" | ||
}, | ||
"/v1/entities/properties/{property_id}/aliases/{language_code}": { | ||
"$ref": "resources/aliases/aliases-in-language-for-property.json" | ||
}, | ||
"/v1/entities/properties/{property_id}/statements": { | ||
"$ref": "resources/statements/list-for-property.json" | ||
}, | ||
"/v1/entities/properties/{property_id}/statements/{statement_id}": { | ||
"$ref": "resources/statements/single-for-property.json" | ||
}, | ||
"/v1/statements/{statement_id}": { | ||
"$ref": "resources/statements/single.json" | ||
} | ||
}, | ||
"components": { | ||
"parameters": { | ||
"$ref": "global/parameters.json" | ||
}, | ||
"requestBodies": { | ||
"$ref": "global/requests.json" | ||
}, | ||
"responses": { | ||
"$ref": "global/responses.json" | ||
}, | ||
"schemas": { | ||
"$ref": "global/schemas.json" | ||
}, | ||
"examples": { | ||
"$ref": "global/examples.json" | ||
} | ||
}, | ||
"tags": { "$ref": "global/tags.json" } | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
{ | ||
"openapi": "3.1.0", | ||
"info": { | ||
"title": "Wikibase Search Domain REST API", | ||
"version": "0.1", | ||
"description": "OpenAPI fragment of the Wikibase Search domain REST API" | ||
}, | ||
"paths": { | ||
"/v0/search/items": { | ||
"get": { | ||
"operationId": "searchItem", | ||
"tags": [ "item search" ], | ||
"summary": "Simple Item search by label", | ||
"responses": { | ||
"200": { | ||
"description": "A list of search results", | ||
"content": { | ||
"application/json": { | ||
"schema": { | ||
"type": "object" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
}, | ||
"tags": [ | ||
{ | ||
"name": "item search", | ||
"description": "Simple item search" | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API. | ||
# See https://redocly.com/docs/cli/ for more information. | ||
|
||
../domains/crud/specs/resources/index.json: | ||
operation-4xx-response: # Excluded as these endpoints have no 4XX error responses. | ||
- '#/~1v1~1openapi.json/get/responses' | ||
- '#/~1v1~1property-data-types/get/responses' | ||
specs/openapi-joined.json: | ||
operation-4xx-response: | ||
- '#/paths/~1v1~1openapi.json/get/responses' | ||
- '#/paths/~1v1~1property-data-types/get/responses' | ||
- '#/paths/~1v0~1search~1items/get/responses' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.