{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Indexes API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Indexes", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Get Indexes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/indexes", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "top", "value": "", "type": "query", "description": "The number of result items to return." }, { "name": "skip", "value": "", "type": "query", "description": "The number of result items to skip." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "The maximum number of result items per page." } ] }, "docs": "List the latest version of each index." }, { "info": { "name": "Microsoft Azure Post Indexes", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/indexes", "headers": [ { "name": "x-ms-client-request-id", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "Client Api Version." } ] }, "docs": "Creates a new search index." }, { "info": { "name": "Microsoft Azure Get Indexes Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/indexes/:name", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "name", "value": "", "type": "path", "description": "Name of the index." } ] }, "docs": "Get latest Index." }, { "info": { "name": "Microsoft Azure Post Indexes Name:getnextversion", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/indexes/:name:getNextVersion", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "name", "value": "", "type": "path", "description": "Name of the index." } ] }, "docs": "Get next Index version." }, { "info": { "name": "Microsoft Azure Get Indexes Name Versions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/indexes/:name/versions", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "name", "value": "", "type": "path", "description": "Name of the index." }, { "name": "listViewType", "value": "", "type": "query", "description": "View type for including/excluding (for example) archived entities." }, { "name": "orderBy", "value": "", "type": "query", "description": "Ordering of list: Please choose OrderBy value from ['createdtime', 'modifiedtime']." }, { "name": "tags", "value": "", "type": "query", "description": "Comma-separated list of tag names (and optionally values). Example: tag1,tag2=value2." }, { "name": "top", "value": "", "type": "query", "description": "The number of result items to return." }, { "name": "skip", "value": "", "type": "query", "description": "The number of result items to skip." }, { "name": "maxpagesize", "value": "", "type": "query", "description": "The maximum number of result items per page." } ] }, "docs": "The most basic operation." }, { "info": { "name": "Microsoft Azure Get Indexes Name Versions Version", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/indexes/:name/versions/:version", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "name", "value": "", "type": "path", "description": "Name of the index." }, { "name": "version", "value": "", "type": "path", "description": "Version of the index." } ] }, "docs": "Fetch a IndexVersion by name." }, { "info": { "name": "Microsoft Azure Put Indexes Name Versions Version", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/indexes/:name/versions/:version", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "name", "value": "", "type": "path", "description": "Name of the index." }, { "name": "version", "value": "", "type": "path", "description": "Version of the index." } ] }, "docs": "Creates or updates a IndexVersion." }, { "info": { "name": "Microsoft Azure Get Indexes Indexname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/indexes(':indexName')", "headers": [ { "name": "x-ms-client-request-id", "value": "" } ], "params": [ { "name": "indexName", "value": "", "type": "path", "description": "The name of the index to retrieve." }, { "name": "api-version", "value": "", "type": "query", "description": "Client Api Version." } ] }, "docs": "Retrieves an index definition." }, { "info": { "name": "Microsoft Azure Put Indexes Indexname", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/indexes(':indexName')", "headers": [ { "name": "x-ms-client-request-id", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" }, { "name": "Prefer", "value": "" } ], "params": [ { "name": "indexName", "value": "", "type": "path", "description": "The definition of the index to create or update." }, { "name": "allowIndexDowntime", "value": "", "type": "query", "description": "Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes." }, { "name": "api-version", "value": "", "type": "query", "description": "Client Api Version." } ] }, "docs": "Creates a new search index or updates an index if it already exists." }, { "info": { "name": "Microsoft Azure Delete Indexes Indexname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/indexes(':indexName')", "headers": [ { "name": "x-ms-client-request-id", "value": "" }, { "name": "If-Match", "value": "" }, { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "indexName", "value": "", "type": "path", "description": "The name of the index to delete." }, { "name": "api-version", "value": "", "type": "query", "description": "Client Api Version." } ] }, "docs": "Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index." }, { "info": { "name": "Microsoft Azure Get Indexes Indexname Search Stats", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/indexes(':indexName')/search.stats", "headers": [ { "name": "x-ms-client-request-id", "value": "" } ], "params": [ { "name": "indexName", "value": "", "type": "path", "description": "The name of the index for which to retrieve statistics." }, { "name": "api-version", "value": "", "type": "query", "description": "Client Api Version." } ] }, "docs": "Returns statistics for the given index, including a document count and storage usage." }, { "info": { "name": "Microsoft Azure Post Indexes Indexname Search Analyze", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/indexes(':indexName')/search.analyze", "headers": [ { "name": "x-ms-client-request-id", "value": "" } ], "params": [ { "name": "indexName", "value": "", "type": "path", "description": "The name of the index for which to test an analyzer." }, { "name": "api-version", "value": "", "type": "query", "description": "Client Api Version." } ] }, "docs": "Shows how an analyzer breaks text into tokens." } ] } ], "bundled": true }