Component Search

Request

Search for the components based on the given input and return list of components which includes registered,popular and unpopular.Response will not include vulnerabilities and licenses of the version

Security

bearerAuth

Query

searchBystringNAME|URL|CPE|FORGErequired

Search Type. default is NAME.

Default:"NAME"

Enum:"NAME""URL""CPE""FORGE"

filterstring

Search Filter. This is required for searchBy NAME, default is ALL_TERMS.

Enum:"ALL_TERMS""ANY_TERM""BEGINS_WITH""EXACT_MATCH"

searchTermstring

Any Keyword. This is required for searchBy NAME/URL and optional for CPE. For searchBy CPE, the supplied searchTerm E.g."apache commons" would perform exact match against the component.

includeVersionsboolean

If true , response will include versions as well.

Default:false

vendorstring

Vendor name (Example: gnu)

productstring

Product name (Example: zlib)

Forge Name. is required for searchBy FORGE and optional for NAME/URL/CPE

Enum:"SourceForge""Apache""MySQL AB""Java.net""GNU""Free Software Directory""CodePlex""Savannah""Google Code""Hackage"

projectNamestring

packageNamestring

groupIdstring

Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2 (Example: com.google.firebase)

artifactIdstring

Required param for forges: Google's Maven Repository|Clojars|Ibiblio Maven2 (Example: firebase-abt)

moduleOrDistributionNamestring

Required param for forge: CPAN (Example: exporter-tidy)

packageOrDistributionNamestring

Required param for forge: CRAN | Fedora Koji (Example: acid)

authorstring

Required param for forge: GitHub | GitLab (It accepts Author/Org value (Example: jquery)

repositoryNamestring

Required param for forge: GitHub (Example: jquery-ui)

vendorNamestring

Required param for forge: Packagist (Example: 100hz)

gemNamestring

Required param for forge: RubyGems (Example: x-editable-rails)

cratestring

Required param for forge: crates.io (Example: brewstillery)

limitinteger, (int32), >= 1

Page Size. Number Of Records to fetch per page

Default:100

offsetinteger, (int32), >= 1

Page Number. Index of the page to start with(starts from 1)

Default:1

curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/components/search?searchBy=NAME&filter=ALL_TERMS&searchTerm=string&includeVersions=false&vendor=string&product=string&forgeName=SourceForge&projectName=string&packageName=string&groupId=string&artifactId=string&moduleOrDistributionName=string&packageOrDistributionName=string&author=string&repositoryName=string&vendorName=string&gemName=string&crate=string&limit=100&offset=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

idinteger, (int64)

namestring

descriptionstring

titlestring

urlstring

forgestring

versionListArray of objects(VersionListModel)

licenseListArray of objects(LicenseListModel)

cpeListArray of objects(ComponentCPEModel)

Response

{
  "id": 0,
  "name": "string",
  "description": "string",
  "title": "string",
  "url": "string",
  "forge": "string",
  "versionList": [
    { … }
  ],
  "licenseList": [
    { … }
  ],
  "cpeList": [
    { … }
  ]
}