migrate examples to openApi part 12; affects [GitHub Gist] (#9500)

* migrate some services from examples to openApi

* improve and de-dupe service titles

* improve description
This commit is contained in:
chris48s
2023-11-13 14:30:26 +00:00
committed by GitHub
parent 8f921a4078
commit 3512c89054
13 changed files with 246 additions and 140 deletions

View File

@@ -1,5 +1,5 @@
import Joi from 'joi'
import { NotFound, InvalidParameter } from '../index.js'
import { NotFound, InvalidParameter, pathParams } from '../index.js'
import { GithubAuthV3Service } from './github-auth-service.js'
import { documentation, httpErrorsFor } from './github-helpers.js'
@@ -15,23 +15,32 @@ export default class GithubCommitStatus extends GithubAuthV3Service {
pattern: ':user/:repo/:branch/:commit',
}
static examples = [
{
title: 'GitHub commit merge status',
namedParams: {
user: 'badges',
repo: 'shields',
branch: 'master',
commit: '5d4ab86b1b5ddfb3c4a70a70bd19932c52603b8c',
static openApi = {
'/github/commit-status/{user}/{repo}/{branch}/{commit}': {
get: {
summary: 'GitHub commit merge status',
description: documentation,
parameters: pathParams(
{
name: 'user',
example: 'badges',
},
{
name: 'repo',
example: 'shields',
},
{
name: 'branch',
example: 'master',
},
{
name: 'commit',
example: '5d4ab86b1b5ddfb3c4a70a70bd19932c52603b8c',
},
),
},
staticPreview: this.render({
isInBranch: true,
branch: 'master',
}),
keywords: ['branch'],
documentation,
},
]
}
static defaultBadgeData = { label: 'commit status' }