paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 18 Packages Projects Releases Wiki Activity

Merge pull request #17719 from backstage/rugvip/todo-schema

Browse Source 
todo-backend: add OpenAPI schema
This commit is contained in:
Patrik Oldsberg
2023-05-11 13:57:36 +02:00
committed by GitHub
parent c6a1c87bd6 b61788b0a3
commit f00a906c5c
6 changed files with 350 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/honest-comics-ring.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-todo-backend': patch
---
Added OpenAPI schema
plugins/todo-backend/package.json
+1
View File
@@ -45,6 +45,7 @@
"yn": "^4.0.0"
},
"devDependencies": {
"@backstage/backend-openapi-utils": "workspace:^",
"@backstage/cli": "workspace:^",
"@types/supertest": "^2.0.8",
"msw": "^1.0.0",
plugins/todo-backend/src/schema/openapi.generated.ts
+208
View File
@@ -0,0 +1,208 @@
/*
* Copyright 2023 The Backstage Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// ******************************************************************
// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
// ******************************************************************
export default {
openapi: '3.0.3',
info: {
title: '@backstage/plugin-todo-backend',
version: '1',
description:
'The Backstage backend plugin that provides source code todo comment browsing.',
license: {
name: 'Apache-2.0',
url: 'http://www.apache.org/licenses/LICENSE-2.0.html',
},
contact: {},
},
servers: [
{
url: '/',
},
],
components: {
examples: {},
headers: {},
parameters: {},
requestBodies: {},
responses: {},
schemas: {
TodoItem: {
type: 'object',
properties: {
text: {
type: 'string',
description: 'The contents of the TODO comment',
},
tag: {
type: 'string',
description: 'The tag used, e.g. TODO, FIXME',
},
author: {
type: 'string',
description: 'References author, if any',
},
viewUrl: {
type: 'string',
description: 'URL used to view the file',
},
lineNumber: {
type: 'integer',
description: 'The line number of the file that the TODO occurs at',
},
repoFilePath: {
type: 'string',
description:
'The path of the file containing the TODO within the repo',
},
},
required: ['text', 'tag'],
additionalProperties: false,
},
},
securitySchemes: {
JWT: {
type: 'http',
scheme: 'bearer',
bearerFormat: 'JWT',
},
},
},
paths: {
'/v1/todos': {
get: {
operationId: 'ListTodos',
responses: {
'200': {
description: 'Ok',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
items: {
type: 'array',
items: {
$ref: '#/components/schemas/TodoItem',
},
},
totalCount: {
type: 'integer',
},
offset: {
type: 'integer',
},
limit: {
type: 'integer',
},
},
required: ['items', 'totalCount', 'offset', 'limit'],
additionalProperties: false,
},
},
},
},
'400': {
description: 'Bad request',
content: {
'application/json': {
schema: {
type: 'object',
properties: {
error: {
type: 'object',
properties: {
message: {
type: 'string',
},
},
},
},
},
},
},
},
},
security: [
{},
{
JWT: [],
},
],
parameters: [
{
name: 'entity',
in: 'query',
required: true,
schema: {
type: 'string',
minLength: 1,
description: 'A reference to the entity to list TODO items for',
},
},
{
name: 'orderBy',
in: 'query',
required: false,
schema: {
type: 'string',
pattern: '^(text|tag|author|viewUrl|repoFilePath)=(asc|desc)$',
description:
'The field and direction used to sort the listed TODO items',
},
},
{
name: 'filter',
in: 'query',
required: false,
schema: {
type: 'array',
description:
'A list of filters used to narrow down the listed TODO items',
items: {
type: 'string',
pattern: '^(text|tag|author|viewUrl|repoFilePath)=.+$',
},
},
},
{
name: 'offset',
in: 'query',
required: false,
schema: {
type: 'integer',
minimum: 0,
description: 'The offset at which to start listing TODO items',
},
},
{
name: 'limit',
in: 'query',
required: false,
schema: {
type: 'integer',
minimum: 1,
description: 'The number of TODO items to list',
},
},
],
},
},
},
} as const;
plugins/todo-backend/src/schema/openapi.yaml
+132
View File
@@ -0,0 +1,132 @@
openapi: 3.0.3
info:
title: '@backstage/plugin-todo-backend'
version: '1'
description: The Backstage backend plugin that provides source code todo comment browsing.
license:
name: Apache-2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
contact: {}
servers:
- url: /
components:
examples: {}
headers: {}
parameters: {}
requestBodies: {}
responses: {}
schemas:
TodoItem:
type: object
properties:
text:
type: string
description: The contents of the TODO comment
tag:
type: string
description: The tag used, e.g. TODO, FIXME
author:
type: string
description: References author, if any
viewUrl:
type: string
description: URL used to view the file
lineNumber:
type: integer
description: The line number of the file that the TODO occurs at
repoFilePath:
type: string
description: The path of the file containing the TODO within the repo
required:
- text
- tag
additionalProperties: false
securitySchemes:
JWT:
type: http
scheme: bearer
bearerFormat: JWT
paths:
/v1/todos:
get:
operationId: ListTodos
responses:
'200':
description: Ok
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/TodoItem'
totalCount:
type: integer
offset:
type: integer
limit:
type: integer
required:
- items
- totalCount
- offset
- limit
additionalProperties: false
'400':
description: Bad request
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
message:
type: string
security:
- {}
- JWT: []
parameters:
- name: entity
in: query
required: true
schema:
type: string
minLength: 1
description: A reference to the entity to list TODO items for
- name: orderBy
in: query
required: false
schema:
type: string
pattern: '^(text|tag|author|viewUrl|repoFilePath)=(asc|desc)$'
description: The field and direction used to sort the listed TODO items
- name: filter
in: query
required: false
schema:
type: array
description: A list of filters used to narrow down the listed TODO items
items:
type: string
pattern: '^(text|tag|author|viewUrl|repoFilePath)=.+$'
- name: offset
in: query
required: false
schema:
type: integer
minimum: 0
description: The offset at which to start listing TODO items
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
description: The number of TODO items to list
plugins/todo-backend/src/service/router.ts
+3 -1
View File
@@ -25,6 +25,8 @@ import {
parseIntegerParam,
parseOrderByParam,
} from '../lib/utils';
import spec from '../schema/openapi.generated';
import type { ApiRouter } from '@backstage/backend-openapi-utils';
/** @public */
export interface RouterOptions {
@@ -37,7 +39,7 @@ export async function createRouter(
): Promise<express.Router> {
const { todoService } = options;
const router = Router();
const router = Router() as ApiRouter<typeof spec>;
router.use(express.json());
router.get('/v1/todos', async (req, res) => {
yarn.lock
+1
View File
@@ -9564,6 +9564,7 @@ __metadata:
resolution: "@backstage/plugin-todo-backend@workspace:plugins/todo-backend"
dependencies:
"@backstage/backend-common": "workspace:^"
"@backstage/backend-openapi-utils": "workspace:^"
"@backstage/backend-plugin-api": "workspace:^"
"@backstage/catalog-client": "workspace:^"
"@backstage/catalog-model": "workspace:^"