{ "swagger": "2.0", "info": { "title": "Feed", "description": "", "termsOfService": "https://go.microsoft.com/fwlink/?LinkId=329770", "contact": { "name": "nugetvss", "email": "nugetvss@microsoft.com" }, "license": { "name": "MICROSOFT SOFTWARE LICENSE TERMS", "url": "https://go.microsoft.com/fwlink/?LinkId=329770" }, "version": "7.1-preview" }, "host": "feeds.dev.azure.com", "x-ms-vss-area": "Packaging", "x-ms-vss-resource-area-id": "7ab4e64e-c4d8-4f50-ae73-5ef2e21642a5", "basePath": "/", "tags": [ { "name": "Artifact Details" }, { "name": "Change Tracking" }, { "name": "Feed Management" }, { "name": "Feed Recycle Bin" }, { "name": "Recycle Bin" }, { "name": "Retention Policies" }, { "name": "Service Settings" } ], "schemes": [ "https" ], "paths": { "/{organization}/_apis/packaging/globalpermissions": { "get": { "tags": [ "Service Settings" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "globalPermissions", "x-ms-vss-method": "GetGlobalPermissions", "x-ms-preview": true, "description": "Get all service-wide feed creation and administration permissions.", "operationId": "Service Settings_GetGlobalPermissions", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "query", "name": "includeIds", "description": "Set to true to add IdentityIds to the permission objects.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/GlobalPermission" } } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] }, "patch": { "tags": [ "Service Settings" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "globalPermissions", "x-ms-vss-method": "SetGlobalPermissions", "x-ms-preview": true, "description": "Set service-wide permissions that govern feed creation and administration.", "operationId": "Service Settings_SetGlobalPermissions", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "New permissions for the organization.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/GlobalPermission" } } }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/GlobalPermission" } } } }, "security": [ { "oauth2": [ "vso.packaging_manage" ] } ] } }, "/{organization}/{project}/_apis/packaging/feedchanges": { "get": { "tags": [ "Change Tracking" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "feedChanges", "x-ms-vss-method": "GetFeedChanges", "x-ms-preview": true, "description": "Query to determine which feeds have changed since the last call, tracked through the provided continuationToken. Only changes to a feed itself are returned and impact the continuationToken, not additions or alterations to packages within the feeds.\n\nIf the project parameter is present, gets all feed changes in the given project.\nIf omitted, gets all feed changes in the organization.", "operationId": "Change Tracking_Get Feed Changes", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "includeDeleted", "description": "If true, get changes for all feeds including deleted feeds. The default value is false.", "required": false, "type": "boolean" }, { "in": "query", "name": "continuationToken", "description": "A continuation token which acts as a bookmark to a previously retrieved change. This token allows the user to continue retrieving changes in batches, picking up where the previous batch left off. If specified, all the changes that occur strictly after the token will be returned. If not specified or 0, iteration will start with the first change.", "required": false, "type": "integer", "format": "int64" }, { "in": "query", "name": "batchSize", "description": "Number of package changes to fetch. The default value is 1000. The maximum value is 2000.", "required": false, "type": "integer", "format": "int32" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/FeedChangesResponse" } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/feedchanges/{feedId}": { "get": { "tags": [ "Change Tracking" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "feedChanges", "x-ms-vss-method": "GetFeedChange", "x-ms-preview": true, "description": "Query a feed to determine its current state.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Change Tracking_Get Feed Change", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or ID of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/FeedChange" } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/feedrecyclebin": { "get": { "tags": [ "Feed Recycle Bin" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "feedRecycleBin", "x-ms-vss-method": "GetFeedsFromRecycleBin", "x-ms-preview": true, "description": "Query for feeds within the recycle bin.\n\nIf the project parameter is present, gets all feeds in recycle bin in the given project.\nIf omitted, gets all feeds in recycle bin in the organization.", "operationId": "Feed Recycle Bin_List", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/Feed" } } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/feedrecyclebin/{feedId}": { "delete": { "tags": [ "Feed Recycle Bin" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "feedRecycleBin", "x-ms-vss-method": "PermanentDeleteFeed", "x-ms-preview": true, "description": "", "operationId": "Feed Recycle Bin_Permanent Delete Feed", "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation" } }, "security": [ { "oauth2": [ "vso.packaging_manage" ] } ] }, "patch": { "tags": [ "Feed Recycle Bin" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "feedRecycleBin", "x-ms-vss-method": "RestoreDeletedFeed", "x-ms-preview": true, "description": "", "operationId": "Feed Recycle Bin_Restore Deleted Feed", "consumes": [ "application/json-patch+json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/JsonPatchDocument" } }, { "in": "path", "name": "feedId", "description": "", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation" } }, "security": [ { "oauth2": [ "vso.packaging_manage" ] } ] } }, "/{organization}/{project}/_apis/packaging/feeds": { "post": { "tags": [ "Feed Management" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "feeds", "x-ms-vss-method": "CreateFeed", "x-ms-preview": true, "description": "Create a feed, a container for various package types.\n\nFeeds can be created in a project if the project parameter is included in the request url.\nIf the project parameter is omitted, the feed will not be associated with a project and will be created at the organization level.", "operationId": "Feed Management_Create Feed", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "A JSON object containing both required and optional attributes for the feed. Name is the only required value.", "required": true, "schema": { "$ref": "#/definitions/Feed" } }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/Feed" } } }, "security": [ { "oauth2": [ "vso.packaging_write" ] } ] }, "get": { "tags": [ "Feed Management" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "feeds", "x-ms-vss-method": "GetFeeds", "x-ms-preview": true, "description": "Get all feeds in an account where you have the provided role access.\n\nIf the project parameter is present, gets all feeds in the given project.\nIf omitted, gets all feeds in the organization.", "operationId": "Feed Management_Get Feeds", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "feedRole", "description": "Filter by this role, either Administrator(4), Contributor(3), or Reader(2) level permissions.", "required": false, "type": "string", "enum": [ "custom", "none", "reader", "contributor", "administrator", "collaborator" ], "x-ms-enum": { "name": "FeedRole", "values": [ { "value": "custom", "description": "Unsupported." }, { "value": "none", "description": "Unsupported." }, { "value": "reader", "description": "Readers can only read packages and view settings." }, { "value": "contributor", "description": "Contributors can do anything to packages in the feed including adding new packages, but they may not modify feed settings." }, { "value": "administrator", "description": "Administrators have total control over the feed." }, { "value": "collaborator", "description": "Collaborators have the same permissions as readers, but can also ingest packages from configured upstream sources." } ] } }, { "in": "query", "name": "includeDeletedUpstreams", "description": "Include upstreams that have been deleted in the response.", "required": false, "type": "boolean" }, { "in": "query", "name": "includeUrls", "description": "Resolve names if true", "required": false, "type": "boolean" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/Feed" } } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/feeds/{feedId}": { "delete": { "tags": [ "Feed Management" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "feeds", "x-ms-vss-method": "DeleteFeed", "x-ms-preview": true, "description": "Remove a feed and all its packages. The feed moves to the recycle bin and is reversible.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Feed Management_Delete Feed", "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation" } }, "security": [ { "oauth2": [ "vso.packaging_manage" ] } ] }, "get": { "tags": [ "Feed Management" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "feeds", "x-ms-vss-method": "GetFeed", "x-ms-preview": true, "description": "Get the settings for a specific feed.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Feed Management_Get Feed", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "includeDeletedUpstreams", "description": "Include upstreams that have been deleted in the response.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/Feed" } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] }, "patch": { "tags": [ "Feed Management" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "feeds", "x-ms-vss-method": "UpdateFeed", "x-ms-preview": true, "description": "Change the attributes of a feed.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Feed Management_Update Feed", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "A JSON object containing the feed settings to be updated.", "required": true, "schema": { "$ref": "#/definitions/FeedUpdate" } }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/Feed" } } }, "security": [ { "oauth2": [ "vso.packaging_manage" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/packagechanges": { "get": { "tags": [ "Change Tracking" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "packageChanges", "x-ms-vss-method": "GetPackageChanges", "x-ms-preview": true, "description": "Get a batch of package changes made to a feed. The changes returned are 'most recent change' so if an Add is followed by an Update before you begin enumerating, you'll only see one change in the batch. While consuming batches using the continuation token, you may see changes to the same package version multiple times if they are happening as you enumerate.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Change Tracking_Get Package Changes", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "continuationToken", "description": "A continuation token which acts as a bookmark to a previously retrieved change. This token allows the user to continue retrieving changes in batches, picking up where the previous batch left off. If specified, all the changes that occur strictly after the token will be returned. If not specified or 0, iteration will start with the first change.", "required": false, "type": "integer", "format": "int64" }, { "in": "query", "name": "batchSize", "description": "Number of package changes to fetch. The default value is 1000. The maximum value is 2000.", "required": false, "type": "integer", "format": "int32" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/PackageChangesResponse" } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/packagemetricsbatch": { "post": { "tags": [ "Artifact Details" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "packageMetricsBatch", "x-ms-vss-method": "QueryPackageMetrics", "x-ms-preview": true, "description": "", "operationId": "Artifact Details_Query Package Metrics", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/PackageMetricsQuery" } }, { "in": "path", "name": "feedId", "description": "", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/PackageMetrics" } } } }, "security": [ { "oauth2": [ "vso.packaging_write" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/packages": { "get": { "tags": [ "Artifact Details" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "packages", "x-ms-vss-method": "GetPackages", "x-ms-preview": true, "description": "Get details about all of the packages in the feed. Use the various filters to include or exclude information from the result set.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Artifact Details_Get Packages", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "protocolType", "description": "One of the supported artifact package types.", "required": false, "type": "string" }, { "in": "query", "name": "packageNameQuery", "description": "Filter to packages that contain the provided string. Characters in the string must conform to the package name constraints.", "required": false, "type": "string" }, { "in": "query", "name": "normalizedPackageName", "description": "[Obsolete] Used for legacy scenarios and may be removed in future versions.", "required": false, "type": "string" }, { "in": "query", "name": "includeUrls", "description": "True to return REST Urls with the response. Default is True.", "required": false, "type": "boolean" }, { "in": "query", "name": "includeAllVersions", "description": "True to return all versions of the package in the response. Default is false (latest version only).", "required": false, "type": "boolean" }, { "in": "query", "name": "isListed", "description": "Only applicable for NuGet packages, setting it for other package types will result in a 404. If false, delisted package versions will be returned. Use this to filter the response when includeAllVersions is set to true. Default is unset (do not return delisted packages).", "required": false, "type": "boolean" }, { "in": "query", "name": "getTopPackageVersions", "description": "Changes the behavior of $top and $skip to return all versions of each package up to $top. Must be used in conjunction with includeAllVersions=true", "required": false, "type": "boolean" }, { "in": "query", "name": "isRelease", "description": "Only applicable for Nuget packages. Use this to filter the response when includeAllVersions is set to true. Default is True (only return packages without prerelease versioning).", "required": false, "type": "boolean" }, { "in": "query", "name": "includeDescription", "description": "Return the description for every version of each package in the response. Default is False.", "required": false, "type": "boolean" }, { "in": "query", "name": "$top", "description": "Get the top N packages (or package versions where getTopPackageVersions=true)", "required": false, "type": "integer", "format": "int32" }, { "in": "query", "name": "$skip", "description": "Skip the first N packages (or package versions where getTopPackageVersions=true)", "required": false, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeDeleted", "description": "Return deleted or unpublished versions of packages in the response. Default is False.", "required": false, "type": "boolean" }, { "in": "query", "name": "isCached", "description": "[Obsolete] Used for legacy scenarios and may be removed in future versions.", "required": false, "type": "boolean" }, { "in": "query", "name": "directUpstreamId", "description": "Filter results to return packages from a specific upstream.", "required": false, "type": "string", "format": "uuid" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/Package" } } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/packages/{packageId}": { "get": { "tags": [ "Artifact Details" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "packages", "x-ms-vss-method": "GetPackage", "x-ms-preview": true, "description": "Get details about a specific package.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Artifact Details_Get Package", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "packageId", "description": "The package Id (GUID Id, not the package name).", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "includeAllVersions", "description": "True to return all versions of the package in the response. Default is false (latest version only).", "required": false, "type": "boolean" }, { "in": "query", "name": "includeUrls", "description": "True to return REST Urls with the response. Default is True.", "required": false, "type": "boolean" }, { "in": "query", "name": "isListed", "description": "Only applicable for NuGet packages, setting it for other package types will result in a 404. If false, delisted package versions will be returned. Use this to filter the response when includeAllVersions is set to true. Default is unset (do not return delisted packages).", "required": false, "type": "boolean" }, { "in": "query", "name": "isRelease", "description": "Only applicable for Nuget packages. Use this to filter the response when includeAllVersions is set to true. Default is True (only return packages without prerelease versioning).", "required": false, "type": "boolean" }, { "in": "query", "name": "includeDeleted", "description": "Return deleted or unpublished versions of packages in the response. Default is False.", "required": false, "type": "boolean" }, { "in": "query", "name": "includeDescription", "description": "Return the description for every version of each package in the response. Default is False.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/Package" } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/versionmetricsbatch": { "post": { "tags": [ "Artifact Details" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "versionMetricsBatch", "x-ms-vss-method": "QueryPackageVersionMetrics", "x-ms-preview": true, "description": "", "operationId": "Artifact Details_Query Package Version Metrics", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/PackageVersionMetricsQuery" } }, { "in": "path", "name": "feedId", "description": "", "required": true, "type": "string" }, { "in": "path", "name": "packageId", "description": "", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/PackageVersionMetrics" } } } }, "security": [ { "oauth2": [ "vso.packaging_write" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/versions": { "get": { "tags": [ "Artifact Details" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "versions", "x-ms-vss-method": "GetPackageVersions", "x-ms-preview": true, "description": "Get a list of package versions, optionally filtering by state.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Artifact Details_Get Package Versions", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "packageId", "description": "Id of the package (GUID Id, not name).", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "includeUrls", "description": "True to include urls for each version. Default is true.", "required": false, "type": "boolean" }, { "in": "query", "name": "isListed", "description": "Only applicable for NuGet packages. If false, delisted package versions will be returned.", "required": false, "type": "boolean" }, { "in": "query", "name": "isDeleted", "description": "If set specifies whether to return only deleted or non-deleted versions of packages in the response. Default is unset (return all versions).", "required": false, "type": "boolean" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/PackageVersion" } } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/versions/{packageVersionId}": { "get": { "tags": [ "Artifact Details" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "versions", "x-ms-vss-method": "GetPackageVersion", "x-ms-preview": true, "description": "Get details about a specific package version.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Artifact Details_Get Package Version", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "packageId", "description": "Id of the package (GUID Id, not name).", "required": true, "type": "string" }, { "in": "path", "name": "packageVersionId", "description": "Id of the package version (GUID Id, not name).", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "includeUrls", "description": "True to include urls for each version. Default is true.", "required": false, "type": "boolean" }, { "in": "query", "name": "isListed", "description": "Only applicable for NuGet packages. If false, delisted package versions will be returned.", "required": false, "type": "boolean" }, { "in": "query", "name": "isDeleted", "description": "This does not have any effect on the requested package version, for other versions returned specifies whether to return only deleted or non-deleted versions of packages in the response. Default is unset (return all versions).", "required": false, "type": "boolean" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/PackageVersion" } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/Packages/{packageId}/Versions/{packageVersionId}/provenance": { "get": { "tags": [ "Artifact Details" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "provenance", "x-ms-vss-method": "GetPackageVersionProvenance", "x-ms-preview": true, "description": "Gets provenance for a package version.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Artifact Details_GetPackageVersionProvenance", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "packageId", "description": "Id of the package (GUID Id, not name).", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "packageVersionId", "description": "Id of the package version (GUID Id, not name).", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/PackageVersionProvenance" } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/permissions": { "get": { "tags": [ "Feed Management" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "permissions", "x-ms-vss-method": "GetFeedPermissions", "x-ms-preview": true, "description": "Get the permissions for a feed.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Feed Management_Get Feed Permissions", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "includeIds", "description": "True to include user Ids in the response. Default is false.", "required": false, "type": "boolean" }, { "in": "query", "name": "excludeInheritedPermissions", "description": "True to only return explicitly set permissions on the feed. Default is false.", "required": false, "type": "boolean" }, { "in": "query", "name": "identityDescriptor", "description": "Filter permissions to the provided identity.", "required": false, "type": "string" }, { "in": "query", "name": "includeDeletedFeeds", "description": "If includeDeletedFeeds is true, then feedId must be specified by name and not by Guid.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/FeedPermission" } } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] }, "patch": { "tags": [ "Feed Management" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "permissions", "x-ms-vss-method": "SetFeedPermissions", "x-ms-preview": true, "description": "Update the permissions on a feed.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Feed Management_Set Feed Permissions", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Permissions to set.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/FeedPermission" } } }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/FeedPermission" } } } }, "security": [ { "oauth2": [ "vso.packaging_manage" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages": { "delete": { "tags": [ "Recycle Bin" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "recycleBinPackages", "x-ms-vss-method": "EmptyRecycleBin", "x-ms-preview": true, "description": "Queues a job to remove all package versions from a feed's recycle bin", "operationId": "Recycle Bin_Empty Recycle Bin", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/OperationReference" } } }, "security": [ { "oauth2": [ "vso.packaging_manage" ] } ] }, "get": { "tags": [ "Recycle Bin" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "recycleBinPackages", "x-ms-vss-method": "GetRecycleBinPackages", "x-ms-preview": true, "description": "Query for packages within the recycle bin.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Recycle Bin_Get Recycle Bin Packages", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "protocolType", "description": "Type of package (e.g. NuGet, npm, ...).", "required": false, "type": "string" }, { "in": "query", "name": "packageNameQuery", "description": "Filter to packages matching this name.", "required": false, "type": "string" }, { "in": "query", "name": "includeUrls", "description": "True to return REST Urls with the response. Default is True.", "required": false, "type": "boolean" }, { "in": "query", "name": "$top", "description": "Get the top N packages.", "required": false, "type": "integer", "format": "int32" }, { "in": "query", "name": "$skip", "description": "Skip the first N packages.", "required": false, "type": "integer", "format": "int32" }, { "in": "query", "name": "includeAllVersions", "description": "True to return all versions of the package in the response. Default is false (latest version only).", "required": false, "type": "boolean" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/Package" } } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages/{packageId}": { "get": { "tags": [ "Recycle Bin" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "recycleBinPackages", "x-ms-vss-method": "GetRecycleBinPackage", "x-ms-preview": true, "description": "Get information about a package and all its versions within the recycle bin.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Recycle Bin_Get Recycle Bin Package", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "packageId", "description": "The package Id (GUID Id, not the package name).", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "includeUrls", "description": "True to return REST Urls with the response. Default is True.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/Package" } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages/{packageId}/Versions": { "get": { "tags": [ "Recycle Bin" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "recycleBinVersions", "x-ms-vss-method": "GetRecycleBinPackageVersions", "x-ms-preview": true, "description": "Get a list of package versions within the recycle bin.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Recycle Bin_Get Recycle Bin Package Versions", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "packageId", "description": "The package Id (GUID Id, not the package name).", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "includeUrls", "description": "True to return REST Urls with the response. Default is True.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/RecycleBinPackageVersion" } } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/RecycleBin/Packages/{packageId}/Versions/{packageVersionId}": { "get": { "tags": [ "Recycle Bin" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "recycleBinVersions", "x-ms-vss-method": "GetRecycleBinPackageVersion", "x-ms-preview": true, "description": "Get information about a package version within the recycle bin.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Recycle Bin_Get Recycle Bin Package Version", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "packageId", "description": "The package Id (GUID Id, not the package name).", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "packageVersionId", "description": "The package version Id 9guid Id, not the version string).", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "in": "query", "name": "includeUrls", "description": "True to return REST Urls with the response. Default is True.", "required": false, "type": "boolean" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/RecycleBinPackageVersion" } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/retentionpolicies": { "delete": { "tags": [ "Retention Policies" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "retentionPolicies", "x-ms-vss-method": "DeleteFeedRetentionPolicies", "x-ms-preview": true, "description": "Delete the retention policy for a feed.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Retention Policies_Delete Retention Policy", "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or ID of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation" } }, "security": [ { "oauth2": [ "vso.packaging_manage" ] } ] }, "get": { "tags": [ "Retention Policies" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "retentionPolicies", "x-ms-vss-method": "GetFeedRetentionPolicies", "x-ms-preview": true, "description": "Get the retention policy for a feed.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Retention Policies_Get Retention Policy", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or ID of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/FeedRetentionPolicy" } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] }, "put": { "tags": [ "Retention Policies" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "retentionPolicies", "x-ms-vss-method": "SetFeedRetentionPolicies", "x-ms-preview": true, "description": "Set the retention policy for a feed.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Retention Policies_Set Retention Policy", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "Feed retention policy.", "required": true, "schema": { "$ref": "#/definitions/FeedRetentionPolicy" } }, { "in": "path", "name": "feedId", "description": "Name or ID of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/FeedRetentionPolicy" } } }, "security": [ { "oauth2": [ "vso.packaging_write" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/views": { "post": { "tags": [ "Feed Management" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "views", "x-ms-vss-method": "CreateFeedView", "x-ms-preview": true, "description": "Create a new view on the referenced feed.\n\nThe project parameter must be supplied if the feed was created in a project.", "operationId": "Feed Management_Create Feed View", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "View to be created.", "required": true, "schema": { "$ref": "#/definitions/FeedView" } }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/FeedView" } } }, "security": [ { "oauth2": [ "vso.packaging_write" ] } ] }, "get": { "tags": [ "Feed Management" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "views", "x-ms-vss-method": "GetFeedViews", "x-ms-preview": true, "description": "Get all views for a feed.\n\nThe project parameter must be supplied if the feed was created in a project.", "operationId": "Feed Management_Get Feed Views", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "array", "items": { "$ref": "#/definitions/FeedView" } } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] } }, "/{organization}/{project}/_apis/packaging/Feeds/{feedId}/views/{viewId}": { "delete": { "tags": [ "Feed Management" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "views", "x-ms-vss-method": "DeleteFeedView", "x-ms-preview": true, "description": "Delete a feed view.\n\nThe project parameter must be supplied if the feed was created in a project.", "operationId": "Feed Management_Delete Feed View", "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "viewId", "description": "Name or Id of the view.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation" } }, "security": [ { "oauth2": [ "vso.packaging_manage" ] } ] }, "get": { "tags": [ "Feed Management" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "views", "x-ms-vss-method": "GetFeedView", "x-ms-preview": true, "description": "Get a view by Id.\n\nThe project parameter must be supplied if the feed was created in a project.", "operationId": "Feed Management_Get Feed View", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "viewId", "description": "Name or Id of the view.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/FeedView" } } }, "security": [ { "oauth2": [ "vso.packaging" ] } ] }, "patch": { "tags": [ "Feed Management" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "views", "x-ms-vss-method": "UpdateFeedView", "x-ms-preview": true, "description": "Update a view.\n\nThe project parameter must be supplied if the feed was created in a project.", "operationId": "Feed Management_Update Feed View", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "body", "name": "body", "description": "New settings to apply to the specified view.", "required": true, "schema": { "$ref": "#/definitions/FeedView" } }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "viewId", "description": "Name or Id of the view.", "required": true, "type": "string" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "$ref": "#/definitions/FeedView" } } }, "security": [ { "oauth2": [ "vso.packaging_manage" ] } ] } }, "/{organization}/{project}/_apis/public/packaging/Feeds/{feedId}/Packages/{packageId}/badge": { "get": { "tags": [ "Artifact Details" ], "x-ms-docs-override-version": "7.1-preview.1", "x-ms-vss-resource": "badge", "x-ms-vss-method": "GetBadge", "x-ms-preview": true, "description": "Generate a SVG badge for the latest version of a package. The generated SVG is typically used as the image in an HTML link which takes users to the feed containing the package to accelerate discovery and consumption.\n\nThe project parameter must be supplied if the feed was created in a project.\nIf the feed is not associated with any project, omit the project parameter from the request.", "operationId": "Artifact Details_Get Badge", "produces": [ "image/svg+xml" ], "parameters": [ { "in": "path", "name": "organization", "description": "The name of the Azure DevOps organization.", "required": true, "type": "string" }, { "in": "path", "name": "feedId", "description": "Name or Id of the feed.", "required": true, "type": "string" }, { "in": "path", "name": "packageId", "description": "Id of the package (GUID Id, not name).", "required": true, "type": "string", "format": "uuid" }, { "in": "path", "name": "project", "description": "Project ID or project name", "required": true, "x-ms-required": false, "type": "string" }, { "$ref": "#/parameters/api-Version-preview.1" } ], "responses": { "200": { "description": "successful operation", "schema": { "type": "string", "format": "Stream" } } }, "security": [] } } }, "definitions": { "BuildPackage": { "description": "", "type": "object", "properties": { "feedName": { "description": "Display name of the feed.", "type": "string" }, "packageDescription": { "description": "Package version description.", "type": "string" }, "packageName": { "description": "Display name of the package.", "type": "string" }, "packageVersion": { "description": "Version of the package.", "type": "string" }, "projectId": { "description": "TFS project id.", "type": "string", "format": "uuid" }, "protocolType": { "description": "Type of the package.", "type": "string" } } }, "Feed": { "description": "A container for artifacts.", "type": "object", "allOf": [ { "$ref": "#/definitions/FeedCore" } ], "properties": { "_links": { "description": "Related REST links.", "$ref": "#/definitions/ReferenceLinks" }, "badgesEnabled": { "description": "If set, this feed supports generation of package badges.", "type": "boolean" }, "defaultViewId": { "description": "The view that the feed administrator has indicated is the default experience for readers.", "type": "string", "format": "uuid" }, "deletedDate": { "description": "The date that this feed was deleted.", "type": "string", "format": "date-time" }, "description": { "description": "A description for the feed. Descriptions must not exceed 255 characters.", "type": "string" }, "hideDeletedPackageVersions": { "description": "If set, the feed will hide all deleted/unpublished versions", "type": "boolean" }, "permanentDeletedDate": { "description": "The date that this feed was permanently deleted.", "type": "string", "format": "date-time" }, "permissions": { "description": "Explicit permissions for the feed.", "type": "array", "items": { "$ref": "#/definitions/FeedPermission" } }, "scheduledPermanentDeleteDate": { "description": "The date that this feed is scheduled to be permanently deleted.", "type": "string", "format": "date-time" }, "upstreamEnabledChangedDate": { "description": "If set, time that the UpstreamEnabled property was changed. Will be null if UpstreamEnabled was never changed after Feed creation.", "type": "string", "format": "date-time" }, "url": { "description": "The URL of the base feed in GUID form.", "type": "string" } } }, "FeedBatchData": { "description": "", "type": "object", "properties": { "data": { "$ref": "#/definitions/FeedBatchOperationData" }, "operation": { "enum": [ "saveCachedPackages" ], "x-ms-enum": { "name": "FeedBatchOperation", "values": [ { "value": "saveCachedPackages", "description": "" } ] } } } }, "FeedBatchOperationData": { "description": "", "type": "object", "properties": {} }, "FeedChange": { "description": "A container that encapsulates the state of the feed after a create, update, or delete.", "type": "object", "properties": { "changeType": { "description": "The type of operation.", "enum": [ "addOrUpdate", "delete", "permanentDelete" ], "x-ms-enum": { "name": "ChangeType", "values": [ { "value": "addOrUpdate", "description": "A package version was added or updated." }, { "value": "delete", "description": "A package version was deleted." }, { "value": "permanentDelete", "description": "A feed was permanently deleted. This is not used for package version." } ] } }, "feed": { "description": "The state of the feed after a after a create, update, or delete operation completed.", "$ref": "#/definitions/Feed" }, "feedContinuationToken": { "description": "A token that identifies the next change in the log of changes.", "type": "integer", "format": "int64" }, "latestPackageContinuationToken": { "description": "A token that identifies the latest package change for this feed. This can be used to quickly determine if there have been any changes to packages in a specific feed.", "type": "integer", "format": "int64" } } }, "FeedChangesResponse": { "description": "A result set containing the feed changes for the range that was requested.", "type": "object", "properties": { "_links": { "$ref": "#/definitions/ReferenceLinks" }, "count": { "description": "The number of changes in this set.", "type": "integer", "format": "int32" }, "feedChanges": { "description": "A container that encapsulates the state of the feed after a create, update, or delete.", "type": "array", "items": { "$ref": "#/definitions/FeedChange" } }, "nextFeedContinuationToken": { "description": "When iterating through the log of changes this value indicates the value that should be used for the next continuation token.", "type": "integer", "format": "int64" } } }, "FeedCore": { "description": "An object that contains all of the settings for a specific feed.", "type": "object", "properties": { "capabilities": { "description": "Supported capabilities of a feed.", "enum": [ "none", "upstreamV2", "underMaintenance", "defaultCapabilities" ], "x-ms-enum": { "name": "FeedCapabilities", "values": [ { "value": "none", "description": "No flags exist for this feed" }, { "value": "upstreamV2", "description": "This feed can serve packages from upstream sources Upstream packages must be manually promoted to views" }, { "value": "underMaintenance", "description": "This feed is currently under maintenance and may have reduced functionality" }, { "value": "defaultCapabilities", "description": "The capabilities given to a newly created feed" } ] } }, "fullyQualifiedId": { "description": "This will either be the feed GUID or the feed GUID and view GUID depending on how the feed was accessed.", "type": "string" }, "fullyQualifiedName": { "description": "Full name of the view, in feed@view format.", "type": "string" }, "id": { "description": "A GUID that uniquely identifies this feed.", "type": "string", "format": "uuid" }, "isReadOnly": { "description": "If set, all packages in the feed are immutable. It is important to note that feed views are immutable; therefore, this flag will always be set for views.", "type": "boolean" }, "name": { "description": "A name for the feed. feed names must follow these rules: Must not exceed 64 characters Must not contain whitespaces Must not start with an underscore or a period Must not end with a period Must not contain any of the following illegal characters: , |, /, \\\\, ?, :, &, $, *, \\\", #, [, ] ]]>", "type": "string" }, "project": { "description": "The project that this feed is associated with.", "$ref": "#/definitions/ProjectReference" }, "upstreamEnabled": { "description": "This should always be true. Setting to false will override all sources in UpstreamSources.", "type": "boolean" }, "upstreamSources": { "description": "A list of sources that this feed will fetch packages from. An empty list indicates that this feed will not search any additional sources for packages.", "type": "array", "items": { "$ref": "#/definitions/UpstreamSource" } }, "view": { "description": "Definition of the view.", "$ref": "#/definitions/FeedView" }, "viewId": { "description": "View Id.", "type": "string", "format": "uuid" }, "viewName": { "description": "View name.", "type": "string" } } }, "FeedIdsResult": { "description": "", "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "projectId": { "type": "string", "format": "uuid" }, "projectName": { "type": "string" } } }, "FeedPermission": { "description": "Permissions for a feed.", "type": "object", "properties": { "displayName": { "description": "Display name for the identity.", "type": "string" }, "identityDescriptor": { "description": "Identity associated with this role.", "$ref": "#/definitions/IdentityDescriptor" }, "identityId": { "description": "Id of the identity associated with this role.", "type": "string", "format": "uuid" }, "isInheritedRole": { "description": "Boolean indicating whether the role is inherited or set directly.", "type": "boolean" }, "role": { "description": "The role for this identity on a feed.", "enum": [ "custom", "none", "reader", "contributor", "administrator", "collaborator" ], "x-ms-enum": { "name": "FeedRole", "values": [ { "value": "custom", "description": "Unsupported." }, { "value": "none", "description": "Unsupported." }, { "value": "reader", "description": "Readers can only read packages and view settings." }, { "value": "contributor", "description": "Contributors can do anything to packages in the feed including adding new packages, but they may not modify feed settings." }, { "value": "administrator", "description": "Administrators have total control over the feed." }, { "value": "collaborator", "description": "Collaborators have the same permissions as readers, but can also ingest packages from configured upstream sources." } ] } } } }, "FeedRetentionPolicy": { "description": "Retention policy settings.", "type": "object", "properties": { "ageLimitInDays": { "description": "This attribute is deprecated and is not honoured by retention", "type": "integer", "format": "int32" }, "countLimit": { "description": "Maximum versions to preserve per package and package type.", "type": "integer", "format": "int32" }, "daysToKeepRecentlyDownloadedPackages": { "description": "Number of days to preserve a package version after its latest download.", "type": "integer", "format": "int32" } } }, "FeedUpdate": { "description": "Update a feed definition with these new values.", "type": "object", "properties": { "allowUpstreamNameConflict": { "description": "If set, the feed will allow upload of packages that exist on the upstream", "type": "boolean" }, "badgesEnabled": { "description": "If set, this feed supports generation of package badges.", "type": "boolean" }, "defaultViewId": { "description": "The view that the feed administrator has indicated is the default experience for readers.", "type": "string", "format": "uuid" }, "description": { "description": "A description for the feed. Descriptions must not exceed 255 characters.", "type": "string" }, "hideDeletedPackageVersions": { "description": "If set, feed will hide all deleted/unpublished versions", "type": "boolean" }, "id": { "description": "A GUID that uniquely identifies this feed.", "type": "string", "format": "uuid" }, "name": { "description": "A name for the feed. feed names must follow these rules: Must not exceed 64 characters Must not contain whitespaces Must not start with an underscore or a period Must not end with a period Must not contain any of the following illegal characters: , |, /, \\\\, ?, :, &, $, *, \\\", #, [, ] ]]>", "type": "string" }, "upstreamEnabled": { "description": "If set, the feed can proxy packages from an upstream feed", "type": "boolean" }, "upstreamSources": { "description": "A list of sources that this feed will fetch packages from. An empty list indicates that this feed will not search any additional sources for packages.", "type": "array", "items": { "$ref": "#/definitions/UpstreamSource" } } } }, "FeedView": { "description": "A view on top of a feed.", "type": "object", "properties": { "_links": { "description": "Related REST links.", "$ref": "#/definitions/ReferenceLinks" }, "id": { "description": "Id of the view.", "type": "string", "format": "uuid" }, "name": { "description": "Name of the view.", "type": "string" }, "type": { "description": "Type of view.", "enum": [ "none", "release", "implicit" ], "x-ms-enum": { "name": "FeedViewType", "values": [ { "value": "none", "description": "Default, unspecified view type." }, { "value": "release", "description": "View used as a promotion destination to classify released artifacts." }, { "value": "implicit", "description": "Internal view type that is automatically created and managed by the system." } ] } }, "url": { "description": "Url of the view.", "type": "string" }, "visibility": { "description": "Visibility status of the view.", "enum": [ "private", "collection", "organization", "aadTenant" ], "x-ms-enum": { "name": "FeedVisibility", "values": [ { "value": "private", "description": "Only accessible by the permissions explicitly set by the feed administrator." }, { "value": "collection", "description": "Feed is accessible by all the valid users present in the organization where the feed resides (for example across organization 'myorg' at 'dev.azure.com/myorg')" }, { "value": "organization", "description": "Feed is accessible by all the valid users present in the enterprise where the feed resides. Note that legacy naming and back compat leaves the name of this value out of sync with its new meaning." }, { "value": "aadTenant", "description": "Feed is accessible by all the valid users present in the Azure Active Directory tenant." } ] } } } }, "GlobalPermission": { "description": "Permissions for feed service-wide operations such as the creation of new feeds.", "type": "object", "properties": { "identityDescriptor": { "description": "Identity of the user with the provided Role.", "$ref": "#/definitions/IdentityDescriptor" }, "identityId": { "description": "IdentityId corresponding to the IdentityDescriptor", "type": "string", "format": "uuid" }, "role": { "description": "Role associated with the Identity.", "enum": [ "custom", "none", "feedCreator", "administrator" ], "x-ms-enum": { "name": "GlobalRole", "values": [ { "value": "custom", "description": "Invalid default value." }, { "value": "none", "description": "Explicit no permissions." }, { "value": "feedCreator", "description": "Ability to create new feeds." }, { "value": "administrator", "description": "Read and manage any feed" } ] } } } }, "IdentityDescriptor": { "description": "An Identity descriptor is a wrapper for the identity type (Windows SID, Passport) along with a unique identifier such as the SID or PUID.", "type": "object", "properties": { "identifier": { "description": "The unique identifier for this identity, not exceeding 256 chars, which will be persisted.", "type": "string" }, "identityType": { "description": "Type of descriptor (for example, Windows, Passport, etc.).", "type": "string" } } }, "JsonPatchDocument": { "description": "The JSON model for JSON Patch Operations", "type": "object", "allOf": [ { "type": "array", "items": { "$ref": "#/definitions/JsonPatchOperation" } } ], "properties": {} }, "JsonPatchOperation": { "description": "The JSON model for a JSON Patch operation", "type": "object", "properties": { "from": { "description": "The path to copy from for the Move/Copy operation.", "type": "string" }, "op": { "description": "The patch operation", "enum": [ "add", "remove", "replace", "move", "copy", "test" ], "x-ms-enum": { "name": "Operation", "values": [ { "value": "add", "description": "" }, { "value": "remove", "description": "" }, { "value": "replace", "description": "" }, { "value": "move", "description": "" }, { "value": "copy", "description": "" }, { "value": "test", "description": "" } ] } }, "path": { "description": "The path for the operation. In the case of an array, a zero based index can be used to specify the position in the array (e.g. /biscuits/0/name). The \"-\" character can be used instead of an index to insert at the end of the array (e.g. /biscuits/-).", "type": "string" }, "value": { "description": "The value for the operation. This is either a primitive or a JToken.", "type": "object" } } }, "MinimalPackageVersion": { "description": "Core data about any package, including its id and version information and basic state.", "type": "object", "properties": { "directUpstreamSourceId": { "description": "Upstream source this package was ingested from.", "type": "string", "format": "uuid" }, "id": { "description": "Id for the package.", "type": "string", "format": "uuid" }, "isCachedVersion": { "description": "[Obsolete] Used for legacy scenarios and may be removed in future versions.", "type": "boolean" }, "isDeleted": { "description": "True if this package has been deleted.", "type": "boolean" }, "isLatest": { "description": "True if this is the latest version of the package by package type sort order.", "type": "boolean" }, "isListed": { "description": "(NuGet and Cargo Only) True if this package is listed.", "type": "boolean" }, "normalizedVersion": { "description": "Normalized version using normalization rules specific to a package type.", "type": "string" }, "packageDescription": { "description": "Package description.", "type": "string" }, "publishDate": { "description": "UTC Date the package was published to the service.", "type": "string", "format": "date-time" }, "storageId": { "description": "Internal storage id.", "type": "string" }, "version": { "description": "Display version.", "type": "string" }, "views": { "description": "List of views containing this package version.", "type": "array", "items": { "$ref": "#/definitions/FeedView" } } } }, "OperationReference": { "description": "Reference for an async operation.", "type": "object", "properties": { "id": { "description": "Unique identifier for the operation.", "type": "string", "format": "uuid" }, "pluginId": { "description": "Unique identifier for the plugin.", "type": "string", "format": "uuid" }, "status": { "description": "The current status of the operation.", "enum": [ "notSet", "queued", "inProgress", "cancelled", "succeeded", "failed" ], "x-ms-enum": { "name": "OperationStatus", "values": [ { "value": "notSet", "description": "The operation does not have a status set." }, { "value": "queued", "description": "The operation has been queued." }, { "value": "inProgress", "description": "The operation is in progress." }, { "value": "cancelled", "description": "The operation was cancelled by the user." }, { "value": "succeeded", "description": "The operation completed successfully." }, { "value": "failed", "description": "The operation completed with a failure." } ] } }, "url": { "description": "URL to get the full operation object.", "type": "string" } } }, "Package": { "description": "A package, which is a container for one or more package versions.", "type": "object", "properties": { "_links": { "description": "Related REST links.", "$ref": "#/definitions/ReferenceLinks" }, "id": { "description": "Id of the package.", "type": "string", "format": "uuid" }, "isCached": { "description": "Used for legacy scenarios and may be removed in future versions.", "type": "boolean" }, "name": { "description": "The display name of the package.", "type": "string" }, "normalizedName": { "description": "The normalized name representing the identity of this package within its package type.", "type": "string" }, "protocolType": { "description": "Type of the package.", "type": "string" }, "starCount": { "description": "[Obsolete] - this field is unused and will be removed in a future release.", "type": "integer", "format": "int32" }, "url": { "description": "Url for this package.", "type": "string" }, "versions": { "description": "All versions for this package within its feed.", "type": "array", "items": { "$ref": "#/definitions/MinimalPackageVersion" } } } }, "PackageChange": { "description": "A single change to a feed's packages.", "type": "object", "properties": { "package": { "description": "Package that was changed.", "$ref": "#/definitions/Package" }, "packageVersionChange": { "description": "Change that was performed on a package version.", "$ref": "#/definitions/PackageVersionChange" } } }, "PackageChangesResponse": { "description": "A set of change operations to a feed's packages.", "type": "object", "properties": { "_links": { "description": "Related REST links.", "$ref": "#/definitions/ReferenceLinks" }, "count": { "description": "Number of changes in this batch.", "type": "integer", "format": "int32" }, "nextPackageContinuationToken": { "description": "Token that should be used in future calls for this feed to retrieve new changes.", "type": "integer", "format": "int64" }, "packageChanges": { "description": "List of changes.", "type": "array", "items": { "$ref": "#/definitions/PackageChange" } } } }, "PackageDependency": { "description": "A dependency on another package version.", "type": "object", "properties": { "group": { "description": "Dependency package group (an optional classification within some package types).", "type": "string" }, "packageName": { "description": "Dependency package name.", "type": "string" }, "versionRange": { "description": "Dependency package version range.", "type": "string" } } }, "PackageFile": { "description": "A package file for a specific package version, only relevant to package types that contain multiple files per version.", "type": "object", "properties": { "children": { "description": "Hierarchical representation of files.", "type": "array", "items": { "$ref": "#/definitions/PackageFile" } }, "name": { "description": "File name.", "type": "string" }, "protocolMetadata": { "description": "Extended data unique to a specific package type.", "$ref": "#/definitions/ProtocolMetadata" } } }, "PackageMetrics": { "description": "All metrics for a certain package id", "type": "object", "properties": { "downloadCount": { "description": "Total count of downloads per package id.", "type": "number", "format": "double" }, "downloadUniqueUsers": { "description": "Number of downloads per unique user per package id.", "type": "number", "format": "double" }, "lastDownloaded": { "description": "UTC date and time when package was last downloaded.", "type": "string", "format": "date-time" }, "packageId": { "description": "Package id.", "type": "string", "format": "uuid" } } }, "PackageMetricsQuery": { "description": "Query to get package metrics", "type": "object", "properties": { "packageIds": { "description": "List of package ids", "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PackageVersion": { "description": "A specific version of a package.", "type": "object", "allOf": [ { "$ref": "#/definitions/MinimalPackageVersion" } ], "properties": { "_links": { "description": "Related links", "$ref": "#/definitions/ReferenceLinks" }, "author": { "description": "Package version author.", "type": "string" }, "deletedDate": { "description": "UTC date that this package version was deleted.", "type": "string", "format": "date-time" }, "dependencies": { "description": "List of dependencies for this package version.", "type": "array", "items": { "$ref": "#/definitions/PackageDependency" } }, "description": { "description": "Package version description.", "type": "string" }, "files": { "description": "Files associated with this package version, only relevant for multi-file package types.", "type": "array", "items": { "$ref": "#/definitions/PackageFile" } }, "otherVersions": { "description": "Other versions of this package.", "type": "array", "items": { "$ref": "#/definitions/MinimalPackageVersion" } }, "protocolMetadata": { "description": "Extended data specific to a package type.", "$ref": "#/definitions/ProtocolMetadata" }, "sourceChain": { "description": "List of upstream sources through which a package version moved to land in this feed.", "type": "array", "items": { "$ref": "#/definitions/UpstreamSource" } }, "summary": { "description": "Package version summary.", "type": "string" }, "tags": { "description": "Package version tags.", "type": "array", "items": { "type": "string" } }, "url": { "description": "Package version url.", "type": "string" } } }, "PackageVersionChange": { "description": "A change to a single package version.", "type": "object", "properties": { "changeType": { "description": "The type of change that was performed.", "enum": [ "addOrUpdate", "delete", "permanentDelete" ], "x-ms-enum": { "name": "ChangeType", "values": [ { "value": "addOrUpdate", "description": "A package version was added or updated." }, { "value": "delete", "description": "A package version was deleted." }, { "value": "permanentDelete", "description": "A feed was permanently deleted. This is not used for package version." } ] } }, "continuationToken": { "description": "Token marker for this change, allowing the caller to send this value back to the service and receive changes beyond this one.", "type": "integer", "format": "int64" }, "packageVersion": { "description": "Package version that was changed.", "$ref": "#/definitions/PackageVersion" } } }, "PackageVersionMetrics": { "description": "All metrics for a certain package version id", "type": "object", "properties": { "downloadCount": { "description": "Total count of downloads per package version id.", "type": "number", "format": "double" }, "downloadUniqueUsers": { "description": "Number of downloads per unique user per package version id.", "type": "number", "format": "double" }, "lastDownloaded": { "description": "UTC date and time when package version was last downloaded.", "type": "string", "format": "date-time" }, "packageId": { "description": "Package id.", "type": "string", "format": "uuid" }, "packageVersionId": { "description": "Package version id.", "type": "string", "format": "uuid" } } }, "PackageVersionMetricsQuery": { "description": "Query to get package version metrics", "type": "object", "properties": { "packageVersionIds": { "description": "List of package version ids", "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "PackageVersionProvenance": { "description": "Provenance for a published package version", "type": "object", "properties": { "feedId": { "description": "Name or Id of the feed.", "type": "string", "format": "uuid" }, "packageId": { "description": "Id of the package (GUID Id, not name).", "type": "string", "format": "uuid" }, "packageVersionId": { "description": "Id of the package version (GUID Id, not name).", "type": "string", "format": "uuid" }, "provenance": { "description": "Provenance information for this package version.", "$ref": "#/definitions/Provenance" } } }, "ProjectReference": { "description": "", "type": "object", "properties": { "id": { "description": "Gets or sets id of the project.", "type": "string", "format": "uuid" }, "name": { "description": "Gets or sets name of the project.", "type": "string" }, "visibility": { "description": "Gets or sets visibility of the project.", "type": "string" } } }, "ProtocolMetadata": { "description": "Extended metadata for a specific package type.", "type": "object", "properties": { "data": { "description": "Extended metadata for a specific package type, formatted to the associated schema version definition.", "type": "object" }, "schemaVersion": { "description": "Schema version.", "type": "integer", "format": "int32" } } }, "Provenance": { "description": "Data about the origin of a published package", "type": "object", "properties": { "data": { "description": "Other provenance data.", "type": "object", "additionalProperties": { "type": "string" } }, "provenanceSource": { "description": "Type of provenance source, for example \"InternalBuild\", \"InternalRelease\"", "type": "string" }, "publisherUserIdentity": { "description": "Identity of user that published the package", "type": "string", "format": "uuid" }, "userAgent": { "description": "HTTP User-Agent used when pushing the package.", "type": "string" } } }, "RecycleBinPackageVersion": { "description": "A single package version within the recycle bin.", "type": "object", "allOf": [ { "$ref": "#/definitions/PackageVersion" } ], "properties": { "scheduledPermanentDeleteDate": { "description": "UTC date on which the package will automatically be removed from the recycle bin and permanently deleted.", "type": "string", "format": "date-time" } } }, "ReferenceLinks": { "description": "The class to represent a collection of REST reference links.", "type": "object", "properties": { "links": { "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.", "type": "object", "additionalProperties": { "type": "object" } } } }, "SaveCachedPackagesData": { "description": "", "type": "object", "allOf": [ { "$ref": "#/definitions/FeedBatchOperationData" } ], "properties": { "normalizedPackageNames": { "type": "array", "items": { "type": "string" } }, "viewsForPromotion": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "UpstreamSource": { "description": "Upstream source definition, including its Identity, package type, and other associated information.", "type": "object", "properties": { "deletedDate": { "description": "UTC date that this upstream was deleted.", "type": "string", "format": "date-time" }, "displayLocation": { "description": "Locator for connecting to the upstream source in a user friendly format, that may potentially change over time", "type": "string" }, "id": { "description": "Identity of the upstream source.", "type": "string", "format": "uuid" }, "internalUpstreamCollectionId": { "description": "For an internal upstream type, track the Azure DevOps organization that contains it.", "type": "string", "format": "uuid" }, "internalUpstreamFeedId": { "description": "For an internal upstream type, track the feed id being referenced.", "type": "string", "format": "uuid" }, "internalUpstreamProjectId": { "description": "For an internal upstream type, track the project of the feed being referenced.", "type": "string", "format": "uuid" }, "internalUpstreamViewId": { "description": "For an internal upstream type, track the view of the feed being referenced.", "type": "string", "format": "uuid" }, "location": { "description": "Consistent locator for connecting to the upstream source.", "type": "string" }, "name": { "description": "Display name.", "type": "string" }, "protocol": { "description": "Package type associated with the upstream source.", "type": "string" }, "serviceEndpointId": { "description": "The identity of the service endpoint that holds credentials to use when accessing the upstream.", "type": "string", "format": "uuid" }, "serviceEndpointProjectId": { "description": "Specifies the projectId of the Service Endpoint.", "type": "string", "format": "uuid" }, "status": { "description": "Specifies the status of the upstream.", "enum": [ "ok", "disabled" ], "x-ms-enum": { "name": "UpstreamStatus", "values": [ { "value": "ok", "description": "Upstream source is ok." }, { "value": "disabled", "description": "Upstream source is disabled." } ] } }, "statusDetails": { "description": "Provides a human-readable reason for the status of the upstream.", "type": "array", "items": { "$ref": "#/definitions/UpstreamStatusDetail" } }, "upstreamSourceType": { "description": "Source type, such as Public or Internal.", "enum": [ "public", "internal" ], "x-ms-enum": { "name": "UpstreamSourceType", "values": [ { "value": "public", "description": "Publicly available source." }, { "value": "internal", "description": "Azure DevOps upstream source." } ] } } } }, "UpstreamStatusDetail": { "description": "", "type": "object", "properties": { "reason": { "description": "Provides a human-readable reason for the status of the upstream.", "type": "string" } } }, "VssJsonCollectionWrapper": { "description": "This class is used to serialize collections as a single JSON object on the wire.", "type": "object", "allOf": [ { "$ref": "#/definitions/VssJsonCollectionWrapperBase" } ], "properties": { "value": { "description": "The serialized item.", "type": "string", "format": "T" } } }, "VssJsonCollectionWrapperBase": { "description": "", "type": "object", "properties": { "count": { "description": "The number of serialized items.", "type": "integer", "format": "int32" } } } }, "parameters": { "api-Version-preview.1": { "name": "api-version", "in": "query", "description": "Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.", "required": true, "type": "string" } }, "securityDefinitions": { "accessToken": { "type": "basic", "description": "Personal access token. Use any value for the user name and the token as the password." }, "oauth2": { "type": "oauth2", "flow": "accessCode", "authorizationUrl": "https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion", "tokenUrl": "https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer", "scopes": { "vso.packaging_write": "Grants the ability to create and read feeds and packages.", "vso.packaging": "Grants the ability to read feeds and packages. Also grants the ability to search packages.", "vso.packaging_manage": "Grants the ability to create, read, update, and delete feeds and packages." } } }, "security": [ { "accessToken": [] } ], "externalDocs": { "description": "Azure DevOps REST APIs", "url": "https://aka.ms/azure-devops-rest-apis" } }