scm-sdk

0.1.1 • Public • Published

SCM-Manager REST APIs SDK

REST Resources

This API supports a Representational State Transfer (REST) model
for accessing a set of resources through a fixed set of operations.

The following resources are accessible through the RESTful model:

    AuthenticationResource
        + /authentication
        + /authentication/login
        + /authentication/logout
        + /authentication/state

    ChangePasswordResource
        + /action/change-password

    CipherResource
        - /security/cipher/encrypt

    GroupPermissionResource
        - /security/permission/group/{group}
        - /security/permission/group/{group}/{id}

    GroupResource
        + /groups
        + /groups/{id}

    KeyResource
        + /security/key

    PluginResource
        - /plugins
        - /plugins/available
        - /plugins/install/{id}
        - /plugins/installed
        - /plugins/install-package
        - /plugins/install-package.html
        - /plugins/overview
        - /plugins/uninstall/{id}
        - /plugins/update/{id}
        - /plugins/updates

    RepositoryImportResource
        - /import/repositories
        - /import/repositories/{type}
        - /import/repositories/{type}/bundle
        - /import/repositories/{type}/bundle.html
        - /import/repositories/{type}/directory
        - /import/repositories/{type}/url

    RepositoryResource
        + /repositories
        + /repositories/{id}
        - /repositories/{id}/blame
        - /repositories/{id}/branches
        - /repositories/{id}/browse
        - /repositories/{id}/changeset/{revision}
        - /repositories/{id}/changesets
        - /repositories/{id}/content
        - /repositories/{id}/diff
        + /repositories/{id}/healthcheck
        + /repositories/{id}/tags
        + /repositories/{type}/{name}

    SearchResource
        + /search/groups
        + /search/users

    UserPermissionResource
       - /security/permission/user/{user}
       - /security/permission/user/{user}/{id}

    UserResource
        + /users
        + /users/{id}


+ Supported
- Unsupported

There is also a WADL document describing the REST API.

/scm-sdk/

    Package Sidebar

    Install

    npm i scm-sdk

    Weekly Downloads

    1

    Version

    0.1.1

    License

    MIT

    Last publish

    Collaborators

    • b790113g