Skip to content
This repository has been archived by the owner on Jul 27, 2020. It is now read-only.

Generate better ID name than "check-account-is-associated-with-any" for "Check if a GitHub account is associated with any Marketplace listing" #346

Closed
gr2m opened this issue Jan 12, 2019 · 2 comments
Projects

Comments

@gr2m
Copy link
Contributor

gr2m commented Jan 12, 2019

Current specification

{
"name": "Check if a GitHub account is associated with any Marketplace listing",
"enabledForApps": false,
"method": "GET",
"path": "/marketplace_listing/accounts/:account_id",
"previews": [],
"params": [
{
"name": "account_id",
"type": "integer",
"required": true,
"description": "",
"location": "url"
},
{
"name": "per_page",
"type": "integer",
"required": false,
"description": "Results per page (max 100)",
"default": 30,
"location": "query"
},
{
"name": "page",
"type": "integer",
"required": false,
"description": "Page number of the results to fetch.",
"default": 1,
"location": "query"
}
],
"description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.",
"responses": [
{
"headers": {
"status": "200 OK",
"content-type": "application/json; charset=utf-8"
},
"body": {
"url": "https://api.github.com/orgs/github",
"type": "Organization",
"id": 4,
"login": "github",
"email": null,
"organization_billing_email": "billing@github.com",
"marketplace_pending_change": {
"effective_date": "2017-11-11T00:00:00Z",
"unit_count": null,
"id": 77,
"plan": {
"url": "https://api.github.com/marketplace_listing/plans/1111",
"accounts_url": "https://api.github.com/marketplace_listing/plans/1111/accounts",
"id": 1111,
"number": 2,
"name": "Startup",
"description": "A professional-grade CI solution",
"monthly_price_in_cents": 699,
"yearly_price_in_cents": 7870,
"price_model": "flat-rate",
"has_free_trial": true,
"state": "published",
"unit_name": null,
"bullets": [
"Up to 10 private repositories",
"3 concurrent builds"
]
}
},
"marketplace_purchase": {
"billing_cycle": "monthly",
"next_billing_date": "2017-11-11T00:00:00Z",
"unit_count": null,
"on_free_trial": true,
"free_trial_ends_on": "2017-11-11T00:00:00Z",
"updated_at": "2017-11-02T01:12:12Z",
"plan": {
"url": "https://api.github.com/marketplace_listing/plans/1313",
"accounts_url": "https://api.github.com/marketplace_listing/plans/1313/accounts",
"id": 1313,
"number": 3,
"name": "Pro",
"description": "A professional-grade CI solution",
"monthly_price_in_cents": 1099,
"yearly_price_in_cents": 11870,
"price_model": "flat-rate",
"has_free_trial": true,
"unit_name": null,
"state": "published",
"bullets": [
"Up to 25 private repositories",
"11 concurrent builds"
]
}
}
}
}
],
"idName": "check-account-is-associated-with-any",
"documentationUrl": "https://developer.github.com/v3/apps/marketplace/#check-if-a-github-account-is-associated-with-any-marketplace-listing"
}

I expected

Maybe something like check-if-account-is-associated-with-any-marketplace-listing? Or check-if-account-has-marketplace-listings?

I think "check" is not the right word here. Other endpoints such as "Check if you are starring a repository" follow the convention that they either return 404 or 204 (no body). In this case the response is useful, so the title should maybe rather be something like "Get Marketplace listing for GitHub account"

This should be discussed with GitHub’s Documentation team before we create a workaround

@gr2m
Copy link
Contributor Author

gr2m commented Jan 12, 2019

This might apply to the other Marketplace endpoints as well

@gr2m gr2m added this to To do in Docs via automation May 22, 2019
@gr2m
Copy link
Contributor Author

gr2m commented May 5, 2020

that's fixed now

@gr2m gr2m closed this as completed May 5, 2020
Docs automation moved this from To do to Done May 5, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
No open projects
Docs
Done
Development

No branches or pull requests

1 participant