Skip to content

Instantly share code, notes, and snippets.

@rodripf
Last active July 28, 2019 03:43
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save rodripf/cd7a410b5ca7a91a1a4331d4ac7b1bcb to your computer and use it in GitHub Desktop.
Save rodripf/cd7a410b5ca7a91a1a4331d4ac7b1bcb to your computer and use it in GitHub Desktop.
Swagger Open API documentation generated for the Elastic Search v6.5.4 rest API. Generated with this kindly shared project https://github.com/digipolisantwerp/elastic-swagger-generator_aspnetcore . Gist is truncating the file because of its length, please download using the RAW button.
Download the full version from https://mega.nz/#!7kJCBCpL!Ay4lfoUvshqDIM6dRh0oGCtihlxcY0lO-IDNDcMyi-A
{
"swagger": "2.0",
"info": {
"title": "ElasticSearch",
"description": "ACPaaS ElasticSearch Logging Engine API.",
"termsOfService": "?",
"contact": {
"name": "ACPaaS",
"url": "https://acpaas.antwerpen.be",
"email": "da_apie_team@digipolis.be"
},
"license": {
"name": "?",
"url": "?"
},
"version": "5"
},
"basePath": "/logging-app1",
"schemes": [],
"paths": {
"/_bulk": {
"post": {
"tags": [],
"description": "Source: ",
"operationId": "_bulk",
"produces": [
"application/json"
],
"parameters": [
{
"type": "string",
"name": "wait_for_active_shards",
"in": "query",
"description": "Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"
},
{
"type": "string",
"name": "refresh",
"in": "query",
"description": "If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."
},
{
"type": "string",
"name": "routing",
"in": "query",
"description": "Specific routing value"
},
{
"type": "string",
"name": "timeout",
"in": "query",
"description": "Explicit operation timeout"
},
{
"type": "string",
"name": "type",
"in": "query",
"description": "Default document type for items which don't provide one"
},
{
"type": "array",
"name": "_source",
"in": "query",
"items": {
"type": "string"
},
"description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request"
},
{
"type": "array",
"name": "_source_excludes",
"in": "query",
"items": {
"type": "string"
},
"description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request"
},
{
"type": "array",
"name": "_source_includes",
"in": "query",
"items": {
"type": "string"
},
"description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request"
},
{
"type": "string",
"name": "pipeline",
"in": "query",
"description": "The pipeline id to preprocess incoming documents with"
},
{
"type": "boolean",
"name": "pretty",
"in": "query",
"description": "Pretty format the returned JSON response.",
"default": false
},
{
"type": "boolean",
"name": "human",
"in": "query",
"description": "Return human readable values for statistics.",
"default": true
},
{
"type": "boolean",
"name": "error_trace",
"in": "query",
"description": "Include the stack trace of returned errors.",
"default": false
},
{
"type": "string",
"name": "source",
"in": "query",
"description": "The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests."
},
{
"type": "array",
"name": "filter_path",
"in": "query",
"items": {
"type": "string"
},
"description": "A comma-separated list of filters used to reduce the response."
}
],
"responses": {
"500": {
"description": "Technical error."
},
"201": {
"description": "Created."
},
"400": {
"description": "Validation error."
}
}
},
"put": {
"tags": [],
"description": "Source: ",
"operationId": "_bulk2",
"produces": [
"application/json"
],
"parameters": [
{
"type": "string",
"name": "wait_for_active_shards",
"in": "query",
"description": "Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"
},
{
"type": "string",
"name": "refresh",
"in": "query",
"description": "If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes."
},
{
"type": "string",
"name": "routing",
"in": "query",
"description": "Specific routing value"
},
{
"type": "string",
"name": "timeout",
"in": "query",
"description": "Explicit operation timeout"
},
{
"type": "string",
"name": "type",
"in": "query",
"description": "Default document type for items which don't provide one"
},
{
"type": "array",
"name": "_source",
"in": "query",
"items": {
"type": "string"
},
"description": "True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request"
},
{
"type": "array",
"name": "_source_excludes",
"in": "query",
"items": {
"type": "string"
},
"description": "Default list of fields to exclude from the returned _source field, can be overridden on each sub-request"
},
{
"type": "array",
"name": "_source_includes",
"in": "query",
"items": {
"type": "string"
},
"description": "Default list of fields to extract and return from the _source field, can be overridden on each sub-request"
},
{
"type": "string",
"name": "pipeline",
"in": "query",
"description": "The pipeline id to preprocess incoming documents with"
},
{
"type": "boolean",
"name": "pretty",
"in": "query",
"description": "Pretty format the returned JSON response.",
"default": false
},
{
"type": "boolean",
"name": "human",
"in": "query",
"description": "Return human readable values for statistics.",
"default": true
},
{
"type": "boolean",
"name": "error_trace",
"in": "query",
"description": "Include the stack trace of returned errors.",
"default": false
},
{
"type": "string",
"name": "source",
"in": "query",
"description": "The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests."
},
{
"type": "array",
"name": "filter_path",
"in": "query",
"items": {
"type": "string"
},
"description": "A comma-separated list of filters used to reduce the response."
}
],
"responses": {
"500": {
"description": "Technical error."
},
"200": {
"description": "Ok."
},
"400": {
"description": "Validation error."
},
"404": {
"description": "Not Found."
}
}
}
},
"/{index}/_bulk": {
"post": {
"tags": [],
"description": "Source: ",
"operationId": "_bulk3",
"produces": [
"application/json"
],
"parameters": [
{
"type": "string",
"name": "wait_for_active_shards",
"in": "query",
"description": "Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)"
},
{
"type": "string",
"name": "refresh",
"in": "query",
@dantran
Copy link

dantran commented Jul 27, 2019

please help to update the content, it is truncated even with raw or zip bundle

@rodripf
Copy link
Author

rodripf commented Jul 27, 2019

please help to update the content, it is truncated even with raw or zip bundle

I don't get why gist is truncating the file :-/ but here is the full version uploaded to mega.
https://mega.nz/#!7kJCBCpL!Ay4lfoUvshqDIM6dRh0oGCtihlxcY0lO-IDNDcMyi-A
I hope it is useful to you!

@dantran
Copy link

dantran commented Jul 28, 2019

Thanks, I got the file. Unfortunately, I am not able to generate the java model out of it yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment