-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
wip: generate swagger and openapi json on build, include ositemindex.…
…data xml comments, general doc cleanup
- Loading branch information
Showing
7 changed files
with
381 additions
and
46 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "version": 1, | ||
| "isRoot": true, | ||
| "tools": { | ||
| "swashbuckle.aspnetcore.cli": { | ||
| "version": "6.1.4", | ||
| "commands": [ | ||
| "swagger" | ||
| ] | ||
| } | ||
| } | ||
| } |
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
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,183 @@ | ||
| { | ||
| "openapi": "3.0.1", | ||
| "info": { | ||
| "title": "OSItemIndex.API", | ||
| "version": "v1" | ||
| }, | ||
| "paths": { | ||
| "/items": { | ||
| "get": { | ||
| "tags": [ | ||
| "Items" | ||
| ], | ||
| "summary": "Returns a array of all items in the current database, with optional query filtering", | ||
| "parameters": [ | ||
| { | ||
| "name": "Name", | ||
| "in": "query", | ||
| "schema": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| { | ||
| "name": "LooseCompare", | ||
| "in": "query", | ||
| "schema": { | ||
| "type": "boolean" | ||
| } | ||
| }, | ||
| { | ||
| "name": "Duplicate", | ||
| "in": "query", | ||
| "schema": { | ||
| "type": "boolean" | ||
| } | ||
| }, | ||
| { | ||
| "name": "Noted", | ||
| "in": "query", | ||
| "schema": { | ||
| "type": "boolean" | ||
| } | ||
| }, | ||
| { | ||
| "name": "Placeholder", | ||
| "in": "query", | ||
| "schema": { | ||
| "type": "boolean" | ||
| } | ||
| }, | ||
| { | ||
| "name": "Stackable", | ||
| "in": "query", | ||
| "schema": { | ||
| "type": "boolean" | ||
| } | ||
| }, | ||
| { | ||
| "name": "TradeableOnGe", | ||
| "in": "query", | ||
| "schema": { | ||
| "type": "boolean" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Success", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/components/schemas/OsrsBoxItem" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/items/{id}": { | ||
| "get": { | ||
| "tags": [ | ||
| "Items" | ||
| ], | ||
| "summary": "Returns an item matching the specified Item ID", | ||
| "parameters": [ | ||
| { | ||
| "name": "id", | ||
| "in": "path", | ||
| "description": "Item ID", | ||
| "required": true, | ||
| "schema": { | ||
| "type": "integer", | ||
| "format": "int32" | ||
| } | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Success", | ||
| "content": { | ||
| "application/json": { | ||
| "schema": { | ||
| "$ref": "#/components/schemas/OsrsBoxItem" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/version": { | ||
| "get": { | ||
| "tags": [ | ||
| "Items" | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Success" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "components": { | ||
| "schemas": { | ||
| "OsrsBoxItem": { | ||
| "type": "object", | ||
| "properties": { | ||
| "id": { | ||
| "type": "integer", | ||
| "description": "Unique OSRS item ID number.", | ||
| "format": "int32" | ||
| }, | ||
| "name": { | ||
| "type": "string", | ||
| "description": "The name of the item.", | ||
| "nullable": true | ||
| }, | ||
| "duplicate": { | ||
| "type": "boolean", | ||
| "description": "If the item is a duplicate.", | ||
| "nullable": true | ||
| }, | ||
| "noted": { | ||
| "type": "boolean", | ||
| "description": "If the item is noted.", | ||
| "nullable": true | ||
| }, | ||
| "placeholder": { | ||
| "type": "boolean", | ||
| "description": "If the item is a placeholder.", | ||
| "nullable": true | ||
| }, | ||
| "stackable": { | ||
| "type": "boolean", | ||
| "description": "If the item is stackable (in inventory).", | ||
| "nullable": true | ||
| }, | ||
| "tradeable_on_ge": { | ||
| "type": "boolean", | ||
| "description": "If the item is tradeable (only on GE).", | ||
| "nullable": true | ||
| }, | ||
| "last_updated": { | ||
| "type": "string", | ||
| "description": "The last time (UTC) the item was updated (in ISO8601 date format).", | ||
| "format": "date-time", | ||
| "nullable": true | ||
| }, | ||
| "document": { | ||
| "type": "string", | ||
| "description": "OSRSBox item document.", | ||
| "nullable": true | ||
| } | ||
| }, | ||
| "additionalProperties": false | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.