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

Small type fix.

Browse Source 
Signed-off-by: Aramis Sennyey <sennyeya@amazon.com>
This commit is contained in:
Aramis Sennyey
2023-02-16 17:31:38 -05:00
committed by Fredrik Adelöw
parent eaefab31c6
commit 9076fab703
4 changed files with 215 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/catalog-backend/openapi.yaml
+98 -20
View File
@@ -207,19 +207,24 @@ components:
that are null signify that no entity existed with that ref.
required:
- items
EntityFacets:
EntityFacet:
type: object
properties:
value:
type: string
count:
type: number
description: Construct a type with a set of properties K of type T
EntityFacets:
type: array
items:
$ref: '#/components/schemas/EntityFacet'
EntityFacetsResponse:
type: object
properties: {}
additionalProperties:
$ref: '#/components/schemas/EntityFacets'
properties:
facets:
type: object
additionalProperties:
$ref: '#/components/schemas/EntityFacets'
required:
- facets
Location:
@@ -270,6 +275,91 @@ components:
read and emitted like this so that the frontend can inform the user that it
located them and can make sure to register them as well if they weren't
already
RecursivePartialEntityRelation:
type: object
properties:
targetRef:
type: string
description: The entity ref of the target of this relation.
type:
type: string
description: The type of the relation.
description: A relation of a specific type to another entity in the catalog.
RecursivePartialEntityMeta:
allOf:
- $ref: '#/components/schemas/JsonObject'
- type: object
properties:
properties:
links:
type: array
items:
$ref: '#/components/schemas/EntityLink'
description: A list of external hyperlinks related to the entity.
tags:
type: array
items:
type: string
description: |-
A list of single-valued strings, to for example classify catalog entities in
various ways.
annotations:
$ref: '#/components/schemas/MapStringString'
labels:
$ref: '#/components/schemas/MapStringString'
description:
type: string
description: |-
A short (typically relatively few words, on one line) description of the
entity.
title:
type: string
description: |-
A display name of the entity, to be presented in user interfaces instead
of the `name` property above, when available.
This field is sometimes useful when the `name` is cumbersome or ends up
being perceived as overly technical. The title generally does not have
as stringent format requirements on it, so it may contain special
characters and be more explanatory. Do keep it very short though, and
avoid situations where a title can be confused with the name of another
entity, or where two entities share a title.
Note that this is only for display purposes, and may be ignored by some
parts of the code. Entity references still always make use of the `name`
property, not the title.
namespace:
type: string
description: The namespace that the entity belongs to.
name:
type: string
description: |-
The name of the entity.
Must be unique within the catalog at any given point in time, for any
given namespace + kind pair. This value is part of the technical
identifier of the entity, and as such it will appear in URLs, database
tables, entity references, and similar. It is subject to restrictions
regarding what characters are allowed.
If you want to use a different, more human readable string with fewer
restrictions on it in user interfaces, see the `title` field below.
etag:
type: string
description: |-
An opaque string that changes for each update operation to any part of
the entity, including metadata.
This field can not be set by the user at creation time, and the server
will reject an attempt to do so. The field will be populated in read
operations. The field can (optionally) be specified when performing
update or delete operations, and the server will then reject the
operation if it does not match the current stored value.
uid:
type: string
description: |-
A globally unique ID for the entity.
This field can not be set by the user at creation time, and the server
will reject an attempt to do so. The field will be populated in read
operations. The field can (optionally) be specified when performing
update or delete operations, but the server is free to reject requests
that do so in such a way that it breaks semantics.
description: Metadata fields common to all versions/kinds of entity.
RecursivePartial_Entity_:
type: object
properties:
@@ -282,13 +372,13 @@ components:
type: string
description: The high level entity type being described.
metadata:
$ref: '#/components/schemas/EntityMeta'
$ref: '#/components/schemas/RecursivePartialEntityMeta'
spec:
$ref: '#/components/schemas/JsonObject'
relations:
type: array
items:
$ref: '#/components/schemas/EntityRelation'
$ref: '#/components/schemas/RecursivePartialEntityRelation'
description: The relations that this entity has with other entities.
description: Makes all keys of an entire hierarchy optional.
AnalyzeLocationEntityField:
@@ -298,7 +388,7 @@ components:
type: string
description: |-
A text to show to the user to inform about the choices made. Like, it could say
"Found a CODEOWNERS file that covers this target, so we suggest leaving this
"Found a CODEOWNERS file that covers this target, so we suggest leaving this
field empty; which would currently make it owned by X" where X is taken from the
codeowners file.
value:
@@ -395,7 +485,6 @@ components:
type: http
scheme: bearer
bearerFormat: JWT
paths:
/refresh:
post:
@@ -404,7 +493,6 @@ paths:
'200':
description: Refreshed
security:
# From https://stackoverflow.com/questions/47659324/how-to-specify-an-endpoints-authorization-is-optional-in-openapi-v3
- {}
- JWT: []
parameters: []
@@ -414,7 +502,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/RefreshOptions'
/entities:
get:
operationId: GetEntities
@@ -456,7 +543,6 @@ paths:
required: false
schema:
type: string
/entities/by-uid/{uid}:
get:
operationId: GetEntityByUid
@@ -490,7 +576,6 @@ paths:
required: true
schema:
type: string
/entities/by-name/{kind}/{namespace}/{name}:
get:
operationId: GetEntityByName
@@ -520,7 +605,6 @@ paths:
required: true
schema:
type: string
/entities/by-name/{kind}/{namespace}/{name}/ancestry:
get:
operationId: GetEntityAncestryByName
@@ -550,7 +634,6 @@ paths:
required: true
schema:
type: string
/entities/by-refs:
post:
operationId: GetEntitiesByRefs
@@ -578,7 +661,6 @@ paths:
type: array
items:
type: string
/entity-facets:
get:
operationId: GetEntityFacets
@@ -603,7 +685,6 @@ paths:
required: false
schema:
type: string
/locations:
post:
operationId: CreateLocation
@@ -675,7 +756,6 @@ paths:
- {}
- JWT: []
parameters: []
/locations/{id}:
get:
operationId: GetLocation
@@ -709,7 +789,6 @@ paths:
required: true
schema:
type: string
/analyze-location:
post:
operationId: AnalyzeLocation
@@ -738,7 +817,6 @@ paths:
required:
- catalogFileName
- location
/validate-entity:
post:
operationId: ValidateEntity
plugins/catalog-backend/src/service/createRouter.ts
+6 -2
View File
@@ -189,7 +189,9 @@ export async function createRouter(
fields: parseEntityTransformParams(req.query, request.fields),
authorizationToken: token,
});
res.status(200).json(response);
// These responses are interacting weirdly with the underlying interface passed to them,
// we just need to re-load the TS server's short term memory.
res.status(200).json({ ...response });
})
.get('/entity-facets', async (req, res) => {
const response = await entitiesCatalog.facets({
@@ -197,7 +199,9 @@ export async function createRouter(
facets: parseEntityFacetParams(req.query),
authorizationToken: getBearerToken(req.header('authorization')),
});
res.status(200).json(response);
// These responses are interacting weirdly with the underlying interface passed to them,
// we just need to re-load the TS server's short term memory.
res.status(200).json({ ...response });
});
}
plugins/catalog-backend/src/service/schema/openapi.ts
+95 -7
View File
@@ -250,7 +250,7 @@ export default {
},
required: ['items'],
},
EntityFacets: {
EntityFacet: {
type: 'object',
properties: {
value: {
@@ -260,13 +260,22 @@ export default {
type: 'number',
},
},
description: 'Construct a type with a set of properties K of type T',
},
EntityFacets: {
type: 'array',
items: {
$ref: '#/components/schemas/EntityFacet',
},
},
EntityFacetsResponse: {
type: 'object',
properties: {},
additionalProperties: {
$ref: '#/components/schemas/EntityFacets',
properties: {
facets: {
type: 'object',
additionalProperties: {
$ref: '#/components/schemas/EntityFacets',
},
},
},
required: ['facets'],
},
@@ -320,6 +329,85 @@ export default {
description:
"If the folder pointed to already contained catalog info yaml files, they are\nread and emitted like this so that the frontend can inform the user that it\nlocated them and can make sure to register them as well if they weren't\nalready",
},
RecursivePartialEntityRelation: {
type: 'object',
properties: {
targetRef: {
type: 'string',
description: 'The entity ref of the target of this relation.',
},
type: {
type: 'string',
description: 'The type of the relation.',
},
},
description:
'A relation of a specific type to another entity in the catalog.',
},
RecursivePartialEntityMeta: {
allOf: [
{
$ref: '#/components/schemas/JsonObject',
},
{
type: 'object',
properties: {
links: {
type: 'array',
items: {
$ref: '#/components/schemas/EntityLink',
},
description:
'A list of external hyperlinks related to the entity.',
},
tags: {
type: 'array',
items: {
type: 'string',
},
description:
'A list of single-valued strings, to for example classify catalog entities in\nvarious ways.',
},
annotations: {
$ref: '#/components/schemas/MapStringString',
},
labels: {
$ref: '#/components/schemas/MapStringString',
},
description: {
type: 'string',
description:
'A short (typically relatively few words, on one line) description of the\nentity.',
},
title: {
type: 'string',
description:
'A display name of the entity, to be presented in user interfaces instead\nof the `name` property above, when available.\nThis field is sometimes useful when the `name` is cumbersome or ends up\nbeing perceived as overly technical. The title generally does not have\nas stringent format requirements on it, so it may contain special\ncharacters and be more explanatory. Do keep it very short though, and\navoid situations where a title can be confused with the name of another\nentity, or where two entities share a title.\nNote that this is only for display purposes, and may be ignored by some\nparts of the code. Entity references still always make use of the `name`\nproperty, not the title.',
},
namespace: {
type: 'string',
description: 'The namespace that the entity belongs to.',
},
name: {
type: 'string',
description:
'The name of the entity.\nMust be unique within the catalog at any given point in time, for any\ngiven namespace + kind pair. This value is part of the technical\nidentifier of the entity, and as such it will appear in URLs, database\ntables, entity references, and similar. It is subject to restrictions\nregarding what characters are allowed.\nIf you want to use a different, more human readable string with fewer\nrestrictions on it in user interfaces, see the `title` field below.',
},
etag: {
type: 'string',
description:
'An opaque string that changes for each update operation to any part of\nthe entity, including metadata.\nThis field can not be set by the user at creation time, and the server\nwill reject an attempt to do so. The field will be populated in read\noperations. The field can (optionally) be specified when performing\nupdate or delete operations, and the server will then reject the\noperation if it does not match the current stored value.',
},
uid: {
type: 'string',
description:
'A globally unique ID for the entity.\nThis field can not be set by the user at creation time, and the server\nwill reject an attempt to do so. The field will be populated in read\noperations. The field can (optionally) be specified when performing\nupdate or delete operations, but the server is free to reject requests\nthat do so in such a way that it breaks semantics.',
},
},
},
],
description: 'Metadata fields common to all versions/kinds of entity.',
},
RecursivePartial_Entity_: {
type: 'object',
properties: {
@@ -333,7 +421,7 @@ export default {
description: 'The high level entity type being described.',
},
metadata: {
$ref: '#/components/schemas/EntityMeta',
$ref: '#/components/schemas/RecursivePartialEntityMeta',
},
spec: {
$ref: '#/components/schemas/JsonObject',
@@ -341,7 +429,7 @@ export default {
relations: {
type: 'array',
items: {
$ref: '#/components/schemas/EntityRelation',
$ref: '#/components/schemas/RecursivePartialEntityRelation',
},
description:
'The relations that this entity has with other entities.',
plugins/openapi-router-common/src/router.ts
+16 -4
View File
@@ -14,7 +14,7 @@
* limitations under the License.
*/
import { OpenAPIV3, OpenAPIV3_1 } from 'openapi-types';
import { Router } from 'express';
import { ErrorRequestHandler, RequestHandler, Router } from 'express';
import core, { ParamsDictionary } from 'express-serve-static-core';
import { FromSchema, JSONSchema7 } from 'json-schema-to-ts';
import {
@@ -283,6 +283,17 @@ type DocRequestHandler<
Record<string, string>
>;
export type RequestHandlerParams<
P = ParamsDictionary,
ResBody = any,
ReqBody = any,
ReqQuery = ParsedQs,
LocalsObj extends Record<string, any> = Record<string, any>,
> =
| RequestHandler<P, ResBody, ReqBody, ReqQuery, LocalsObj>
| ErrorRequestHandler<P, ResBody, ReqBody, ReqQuery, LocalsObj>
| Array<RequestHandler<P> | ErrorRequestHandler<P>>;
export class ApiRouter<Doc extends RequiredDoc> {
private _router = Router();
@@ -298,7 +309,7 @@ export class ApiRouter<Doc extends RequiredDoc> {
path: Path,
...handlers: DocRequestHandler<Doc, Path, 'get'>[]
) {
console.log(path);
console.log(path, this.spec);
this._router.get(path, ...handlers);
return this;
}
@@ -361,8 +372,8 @@ export class ApiRouter<Doc extends RequiredDoc> {
return this;
}
use(...handlers: core.RequestHandler[]) {
return this._router.use(handlers);
use(...handlers: RequestHandlerParams[]) {
return this._router.use(...handlers);
}
build() {
@@ -373,6 +384,7 @@ export class ApiRouter<Doc extends RequiredDoc> {
interface RouterOptions {}
export async function createRouter(options: RouterOptions) {
console.log(options);
const router = ApiRouter.fromSpec<DeepWriteable<typeof doc>>(
// As const forces the doc to readonly which conflicts with imported types.
doc as DeepWriteable<typeof doc>,