Openvsx API (1.0.0)

Download OpenAPI specification:Download

Access information on Eclipse Foundation publisher agreements.

Publisher Agreement

Publisher Agreement

Fetch the open-vsx.org publisher agreement for the current user.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
{
  • "PersonID": "string",
  • "DocumentID": "string",
  • "Version": "string",
  • "EffectiveDate": "string",
  • "ReceivedDate": "string",
  • "ScannedDocumentBLOB": "string",
  • "ScannedDocumentMime": "string",
  • "ScannedDocumentFileName": "string",
  • "ScannedDocumentBytes": "string",
  • "Comments": "string"
}

Create a Publisher Agreement

Create an open-vsx.org publisher agreement for the current user.

Authorizations:
OAuth2
Request Body schema: application/json
required

Required information to sign an open-vsx.org publisher agreement.

version
required
string

The version number of the document/agreement.

github_handle
required
string

The GitHub username of the user. This must match what the Eclipse Foundation has on file for the user to successfully sign the puglisher agreement.

Responses

Request samples

Content type
application/json
{
  • "version": "string",
  • "github_handle": "string"
}

Response samples

Content type
application/json
{
  • "PersonID": "string",
  • "DocumentID": "string",
  • "Version": "string",
  • "EffectiveDate": "string",
  • "ReceivedDate": "string",
  • "ScannedDocumentBLOB": "string",
  • "ScannedDocumentMime": "string",
  • "ScannedDocumentFileName": "string",
  • "ScannedDocumentBytes": "string",
  • "Comments": "string"
}

Publisher Agreement for specific user

Retrieve the open-vsx.org publisher agreement of a user. The current user can retrieve his own Publisher Agreement but only an admin can retrieve a Publisher Agreement of another user.

Authorizations:
OAuth2
path Parameters
ef_username
required
string

The Eclipse username.

Responses

Response samples

Content type
application/json
{
  • "PersonID": "string",
  • "DocumentID": "string",
  • "Version": "string",
  • "EffectiveDate": "string",
  • "ReceivedDate": "string",
  • "ScannedDocumentBLOB": "string",
  • "ScannedDocumentMime": "string",
  • "ScannedDocumentFileName": "string",
  • "ScannedDocumentBytes": "string",
  • "Comments": "string"
}

Delete Publisher Agreement for specific user

Delete the open-vsx.org publisher agreement of a user.

Authorizations:
OAuth2
path Parameters
ef_username
required
string

The Eclipse username.

Responses

Profile

User profile

Fetch the profile data for the current user.

Authorizations:
OAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]