Project-level Package Methods

Method to get all project packages

GET /registry/project/{ownerAlias}/{projectAlias}/package

The request returns a list of project packages, with the ability to configure the number of objects displayed per page.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias

Responses

STATUS 200 JSON example:

Response example

    
{
    "_embedded": {
        "simplePackageInfoModelList": [
            {
                "id": "23920af6-aaaa-aaaa-aaaa-396811188f65",
                "name": "Package",
                "version": "1.0.0",
                "groupId": "group",
                "artifactId": "artefact",
                "type": "generic",
                "ownerUuid": "fc7f17df-aaaa-aaaa-aaaa-111042a265b8",
                "ownerType": "PROJECT"
            },
            {
                "id": "deb52e29-aaaa-aaaa-aaaa-737eac0eb8f7",
                "name": "Example",
                "version": "1.0.3",
                "groupId": "example",
                "artifactId": "example",
                "type": "nuget",
                "ownerUuid": "fc7f17df-aaaa-aaaa-aaaa-189042a111b8",
                "ownerType": "PROJECT"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to get a project package by UUID

GET /registry/project/{ownerAlias}/{projectAlias}/package/{packageUuid}

The request returns information about a project package.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageUuid`	String	Package identifier

Responses

STATUS 200 JSON example:

Response example

    
{
    "id": "7eeda8b0-aaaa-aaaa-aaaa-bd1fed06bf95",
    "name": "Package",
    "version": "1.0.1",
    "groupId": "Package",
    "artifactId": "Package",
    "type": "generic",
    "ownerUuid": "fc7f17df-aaaa-aaaa-aaaa-189042a111b8",
    "ownerType": "PROJECT"
}

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to get a list of project package versions

GET /registry/project/{ownerAlias}/{projectAlias}/package/{packageUuid}/version-list

The request returns information about package versions and their contents, with the ability to configure the number of objects displayed per page.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageUuid`	String	Package identifier

Responses

STATUS 200 JSON example:

Response example

    
{
    "_embedded": {
        "simplePackageVersionModelList": [
            {
                "id": "fb97db0e-aaaa-aaaa-aaaa-9a95f4f36e9a",
                "baseVersion": "1.2.3",
                "version": "1.2.3",
                "lowerVersion": "1.2.3",
                "downloadCount": 12,
                "languageVersion": null,
                "packageUploadType": "MANUALLY",
                "packageFiles": [
                    {
                        "id": "6dd3bea5-aaaa-aaaa-aaaa-c49a0025279c",
                        "name": "gitflic-helper",
                        "size": 631382,
                        "hashMd5": "518e87b56adeaaaaaaaa9b6575399e1e",
                        "hashSHA1": "d06a0844f92daaaaaaaaaaaaaaaa275c448ce0e1",
                        "hashSHA256": "ad98cee24564aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac56a27d22ac1",
                        "packageUploadType": "MANUALLY",
                        "createdAt": "2024-08-01T06:57:07.150295"
                    }
                ],
                "internal": null
            },
            {
                "id": "800cad33-aaaa-aaaa-aaaa-8ba5864b4914",
                "baseVersion": "2.4.7",
                "version": "2.4.7",
                "lowerVersion": "2.4.7",
                "downloadCount": 31,
                "languageVersion": null,
                "packageUploadType": "API",
                "packageFiles": [
                    {
                        "id": "684068a6-aaaa-aaaa-aaaa-bebea0e2b46a",
                        "name": "gitflic.ssh",
                        "size": 4325,
                        "hashMd5": "d41d8cd98f00aaaaaaaa0998ecf8427e",
                        "hashSHA1": "da39a3ee5e6baaaaaaaaaaaaaaaa1890afd80709",
                        "hashSHA256": "e3b0c44298fcaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa991b7852b855",
                        "packageUploadType": "API",
                        "createdAt": "2024-07-31T14:02:49.393146"
                    }
                ],
                "internal": null
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to get a project package version

GET /registry/project/{ownerAlias}/{projectAlias}/package/{packageUuid}/{packageVersion}

The request returns information about a package version and its contents.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageUuid`	String	Package identifier
`packageVersion`	String	Package version

Responses

STATUS 200 JSON example:

Response example

    
{
    "id": "fb97db0e-aaaa-aaaa-aaaa-9a95f4f36e9a",
    "baseVersion": "1.2.3",
    "version": "1.2.3",
    "lowerVersion": "1.2.3",
    "downloadCount": 12,
    "languageVersion": null,
    "packageUploadType": "MANUALLY",
    "packageFiles": [
        {
            "id": "6dd3bea5-aaaa-aaaa-aaaa-c49a0025279c",
            "name": "gitflic-helper",
            "size": 631382,
            "hashMd5": "518e87b56adeaaaaaaaa9b6575399e1e",
            "hashSHA1": "d06a0844f92daaaaaaaaaaaaaaaa275c448ce0e1",
            "hashSHA256": "ad98cee24564aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac56a27d22ac1",
            "packageUploadType": "MANUALLY",
            "createdAt": "2024-08-01T06:57:07.150295"
        }
    ],
    "internal": null
}

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to get information about the contents of a project package

GET /registry/project/{ownerAlias}/{projectAlias}/package/{packageUuid}/package-file

The request returns information about the contents of different package versions, with the ability to configure the number of objects displayed per page.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageUuid`	String	Package identifier

Responses

STATUS 200 JSON example:

Response example

    
{
    "_embedded": {
        "simplePackageFileModelList": [
            {
                "id": "6dd3bea5-aaaa-aaaa-aaaa-c49a0025279c",
                "name": "gitflic-helper",
                "size": 631382,
                "hashMd5": "518e87b56adeaaaaaaaa9b6575399e1e",
                "hashSHA1": "d06a0844f92daaaaaaaaaaaaaaaa275c448ce0e1",
                "hashSHA256": "ad98cee24564aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac56a27d22ac1",
                "packageUploadType": "MANUALLY",
                "createdAt": "2024-08-01T06:57:07.150295"
            },
            {
                "id": "684068a6-aaaa-aaaa-aaaa-bebea0e2b46a",
                "name": "gitflic.ssh",
                "size": 4325,
                "hashMd5": "d41d8cd98f00aaaaaaaa0998ecf8427e",
                "hashSHA1": "da39a3ee5e6baaaaaaaaaaaaaaaa1890afd80709",
                "hashSHA256": "e3b0c44298fcaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa991b7852b855",
                "packageUploadType": "API",
                "createdAt": "2024-07-31T14:02:49.393146"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to delete a project package

POST /registry/project/{ownerAlias}/{projectAlias}/package/{packageUuid}/delete

This method deletes a project package.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageUuid`	String	Package identifier

Responses

STATUS 200 - Package deleted.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to delete a project package version

POST /registry/project/{ownerAlias}/{projectAlias}/package/{packageUuid}/{packageVersion}/delete

This method deletes a package version of a project package.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageUuid`	String	Package identifier
`packageVersion`	String	Package version

Responses

STATUS 200 - Version deleted.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to delete the contents of a project package version

POST /registry/project/{ownerAlias}/{projectAlias}/package/{packageUuid}/{packageVersion}/{fileUuid}/delete

This method deletes the contents of a package version of a project package.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageUuid`	String	Package identifier
`packageVersion`	String	Package version
`fileUuid`	String	File identifier

Responses

STATUS 200 - File deleted.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to get the contents of a generic package

GET /registry/project/{ownerAlias}/{projectAlias}/package/generic/{packageName}/{packageVersion}/{fileName}

The request returns a file from a generic package.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageName`	String	Package name
`packageVersion`	String	Package version
`fileName`	String	File name

Responses

STATUS 200 - Package contents received.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to update the contents of a generic package

PUT /registry/project/{ownerAlias}/{projectAlias}/package/generic/{packageName}/{packageVersion}/{fileName}

The request uploads an attached file to the specified version of a generic package. This method can be used to create a new package version or the package itself, provided non-existing data is specified.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageName`	String	Package name
`packageVersion`	String	Package version
`fileName`	String	File name

Responses

STATUS 200 - Package uploaded.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to get the contents of a PyPI package

GET /registry/project/{ownerAlias}/{projectAlias}/package/pypi/{packageName}/{packageVersion}/{fileName}

The request returns a file from a PyPI package.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageName`	String	Package name
`packageVersion`	String	Package version
`fileName`	String	File name

Responses

STATUS 200 - Package contents received.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to update the contents of a PyPI package

PUT /registry/project/{ownerAlias}/{projectAlias}/package/pypi/{packageName}/{packageVersion}/{fileName}

The request uploads an attached file to the specified version of a PyPI package. This method can be used to create a new package version or the package itself, provided non-existing data is specified.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageName`	String	Package name
`packageVersion`	String	Package version
`fileName`	String	File name

Responses

STATUS 200 - Package uploaded.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to get the contents of a Maven package

GET /registry/project/{ownerAlias}/{projectAlias}/package/maven/{packageUuid}/{packageVersion}/{fileUuid}/download

The request returns a file from a Maven package.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageUuid`	String	Package identifier
`packageVersion`	String	Package version
`fileUuid`	String	File identifier

Responses

STATUS 200 - Package contents received.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to update the contents of a Maven package

PUT /registry/project/{ownerAlias}/{projectAlias}/package/maven/{groupId}/{artifactId}/{version}/{fileName}

The request uploads an attached file to the specified version of a Maven package. This method can be used to create a new package version or the package itself, provided non-existing data is specified.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`groupId`	String	Group identifier
`artifactId`	String	Artifact identifier
`version`	String	Package version
`fileName`	String	File name

Responses

STATUS 200 - Package uploaded.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to get the contents of an npm package

Depending on the presence of a package group (scope), use one of the following methods:

Get a package without a group (scope):

GET /registry/project/{ownerAlias}/{projectAlias}/package/npm/{packageName}/{packageVersion}/{fileName}

Get a package with a group (scope):

GET /registry/project/{ownerAlias}/{projectAlias}/package/npm/{packageName}/{packageScope}/{packageVersion}/{fileName}

The request returns a file from an npm package.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageName`	String	Package name
`packageScope`	String	Package group (scope)
`packageVersion`	String	Package version
`fileName`	String	File name

Responses

STATUS 200 - Package contents received.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to update the contents of an npm package

Depending on the presence of a package group (scope), use one of the following methods:

Update a package without a group (scope):

PUT /registry/project/{ownerAlias}/{projectAlias}/package/npm/{packageName}/{packageVersion}/{fileName}

Update a package with a group (scope):

PUT /registry/project/{ownerAlias}/{projectAlias}/package/npm/{packageName}/{packageScope}/{packageVersion}/{fileName}

The request uploads an attached file to the specified version of an npm package. This method can be used to create a new package version or the package itself, provided non-existing data is specified.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageName`	String	Package name
`paсkageScope`	String	Scope
`packageVersion`	String	Package version
`fileName`	String	File name

Responses

STATUS 200 - Package uploaded.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to create a composer package by tag

POST /project/{ownerAlias}/{projectAlias}/package/-/composer?tag={tagName}

This method builds a composer package from repository files by the specified tag and places it in the project's Container and Package Registry.

Note: This request must be sent to the URL where the registry is located: * for SaaS version - https://registry.gitflic.ru * for self-hosted - localhost:8080

The port for the self-hosted version may differ.

Example:

https://registry.gitflic.ru/project/adminuser/test_project/package/-/composer?tag=1.2.3

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`tagName`	String	Tag name

Authorization for this method is via Basic Auth. For the Authorization header, you must provide base64-encoded credentials - Basic {login}:{transportToken}

Example

    
Credentials adminuser@admin.local:qwerty123 in plain text will look like this in base64 in the header:
Authorization - Basic YWRtaW51c2VyQGFkbWluLmxvY2FsOnF3ZXJ0eTEyMw==

Credentials	Type	Description
`login`	String	User alias
`transportToken`	String	Transport token

Instructions for obtaining a token can be found on the page.

Responses

STATUS 200 - Package created and added to the Container and Package Registry.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to update the contents of a Composer package

PUT /registry/project/{ownerAlias}/{projectAlias}/package/composer/{packageVersion}

The request uploads an attached file to the specified version of a Composer package. This method can be used to create a new package version or the package itself, provided non-existing data is specified.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageVersion`	String	Package version

Responses

STATUS 200 - Package uploaded.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to get the contents of a Composer package

GET /registry/project/{ownerAlias}/{projectAlias}/package/composer/{groupId}/{artifactId}/{packageVersion}

The request returns a file from a Composer package.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`groupId`	String	Group identifier
`artifactId`	String	Artifact identifier
`packageVersion`	String	Package version

Responses

STATUS 200 - Package contents received.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to update the contents of a NuGet package

PUT /registry/project/{ownerAlias}/{projectAlias}/package/nuget

The request uploads an attached file to the specified version of a NuGet package. This method can be used to create a new package version or the package itself, provided non-existing data is specified.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias

Responses

STATUS 200 - Package uploaded.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to get the contents of a NuGet package

GET /registry/project/{ownerAlias}/{projectAlias}/package/nuget/{packageName}/{packageVersion}

The request returns a file from a NuGet package.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageName`	String	Package name
`packageVersion`	String	Package version

Responses

STATUS 200 - Package contents received.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to update the contents of a OneScript package

PUT /registry/project/{ownerAlias}/{projectAlias}/package/opm/{fileName}

The request uploads an attached file to the specified version of a OneScript package. This method can be used to create a new package version or the package itself, provided non-existing data is specified.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`fileName`	String	File name

Responses

STATUS 200 - Package uploaded.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to get the contents of a OneScript package

GET /registry/project/{ownerAlias}/{projectAlias}/package/opm/{packageName}/{packageVersion}/{fileName}

The request returns a file from a OneScript package.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`packageName`	String	Package name
`packageVersion`	String	Package version
`fileName`	String	File name

Responses

STATUS 200 - Package contents received.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to update the contents of a Cran package

PUT /registry/project/{ownerAlias}/{projectAlias}/package/cran/{languageVersion}/{fileName}

The request returns a file from a Cran package.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`languageVersion`	String	Language version
`fileName`	String	File name

Responses

STATUS 200 - Package uploaded.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Method to get the contents of a Cran package

GET /registry/project/{ownerAlias}/{projectAlias}/package/cran/{fileName}?languageVersion={languageVersion}&platform={platform}

The request uploads an attached file to the specified version of a Cran package. This method can be used to create a new package version or the package itself, provided non-existing data is specified.

Path Variable	Type	Description
`ownerAlias`	String	Project owner's alias
`projectAlias`	String	Project alias
`fileName`	String	File name
`languageVersion`	String	Language version
`platform`	String	Required only for downloading files in .tgz and .zip format. Platform for which the package was created. Possible values: macosx, windows

Responses

STATUS 200 - Package contents received.

STATUS 403 - No access rights.

STATUS 404 - No data found for the request.

Automated translation!

This page was translated using automatic translation tools. The text may contain inaccuracies.