Rubberduck logo

Rubberduck.WebApi

Backend API for rubberduckvba.com

version 1.0.0.31345

Public Endpoints

/api/v1/public

/Test

GET
Accepts: application/json
Returns: System.DateTime

Gets the current UTC timestamp, if all goes well.

/Features

GET
Accepts: application/json
Returns: IEnumerable<Feature>

Gets all features, along with their sub-features and feature items.

Parameters
Name Type Description Default
topLevelOnly Boolean true

/Summary

GET
Accepts: application/json
Returns: IEnumerable<FeatureSummary>

Gets all top-level features without their description but with a pagination summary

/Feature/{name}

GET
Accepts: application/json
Returns: {Feature, FeaturePaginationInfo}

Gets a feature

Parameters
Name Type Description Default
name String Feature.Name
subFeaturePage Integer Requests a specific page number for subfeatures 1
subFeaturePageSize Integer Requests a specific page size for subfeatures 6
itemPage Integer Requests a specific page number for feature items 1
itemPageSize Integer Requests a specific page size for feature items 20
newSubFeatures Boolean Filter for new subfeatures false
newItems Boolean Filter for new feature items false

/Summary/{name}

GET
Accepts: application/json
Returns: FeatureSummary

Gets a summary for a feature, with pagination info

Parameters
Name Type Description Default
name String Feature.Name
subFeaturePage Integer Requests a specific page number for subfeatures 1
subFeaturePageSize Integer Requests a specific page size for subfeatures 6
itemPage Integer Requests a specific page number for feature items 1
itemPageSize Integer Requests a specific page size for feature items 20
newSubFeatures Boolean Filter for new subfeatures false
newItems Boolean Filter for new feature items false

/FeatureItem/{name}

GET
Accepts: application/json
Returns: FeatureItem

Gets the specified feature item, including its examples and their respective modules

Parameters
Name Type Description Default
name String FeatureItem.Name

/Tags

GET
Accepts: application/json
Returns: IEnumerable<Tag>

Gets the latest release and prerelease tags, including installer asset downloads

/Indent

POST
Accepts: application/json
Returns: IndenterViewModel

Gets the supplied code, indented as per specified settings

Parameters
Name Type Description Default
viewModel IndenterViewModel The indenter request details

/DefaultIndenterSettings

GET
Accepts: application/json
Returns: IndenterViewModel

Gets a default indenter settings view model

/Search

POST
Accepts: application/json
Returns: SearchResultsViewModel

Searches features and feature items for filtered content

Parameters
Name Type Description Default
search SearchViewModel Search request details

/GetSyntaxHighlighting

POST
Accepts: application/json
Returns: System.String

Parses supplied VBA code and returns it formatted with HTML markup

Parameters
Name Type Description Default
code String Any piece of legal VBA code Rubberduck can parse

Authenticated Endpoints

/api/v1/admin

/Test

GET
Accepts: application/json
Returns: System.DateTime

Gets the current UTC timestamp, but should return HTTP 401 from this page

/SaveFeature

POST
Accepts: application/json
Returns: Feature

Creates a new feature (or sub-feature), or updates an existing one

Parameters
Name Type Description Default
dto Feature The feature (or sub-feature) to save

/DeleteFeature

POST
Accepts: application/json
Returns: Feature

Deletes the specified feature (or sub-feature)

Parameters
Name Type Description Default
dto Feature The feature (or sub-feature) to delete

/SaveFeatureItem

POST
Accepts: application/json
Returns: FeatureItem

Creates a new feature item, or updates an existing one

Parameters
Name Type Description Default
dto FeatureItem The feature item to save

/DeleteFeatureItem

POST
Accepts: application/json
Returns: Feature

Deletes the specified feature item

Parameters
Name Type Description Default
dto FeatureItem The feature item to delete

/Update

POST
Accepts: application/json
Returns:

Gets the latest release and pre-release tags from GitHub, downloads xmldoc assets, processes the feature items - method returns immediately