diff --git a/plugins/scaffolder-backend/src/schema/openapi.yaml b/plugins/scaffolder-backend/src/schema/openapi.yaml index 21d344b5bc..36187adb5d 100644 --- a/plugins/scaffolder-backend/src/schema/openapi.yaml +++ b/plugins/scaffolder-backend/src/schema/openapi.yaml @@ -28,6 +28,7 @@ components: in: query description: Offset event ID to stream events after. required: false + allowReserved: true schema: type: integer kind: @@ -112,7 +113,7 @@ components: type: string description: type: string - examples: + '''examples''': type: array items: $ref: '#/components/schemas/ActionExample' @@ -170,139 +171,139 @@ components: - log - directoryContents - output - EntityLink: - type: object - properties: - type: - type: string - description: An optional value to categorize links into specific groups - icon: - type: string - description: An optional semantic key that represents a visual icon. - title: - type: string - description: An optional descriptive title for the link. - url: - type: string - description: The url to the external site, document, etc. - required: - - url - description: A link to external information that is related to the entity. - additionalProperties: false - EntityMeta: - 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 - 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. - required: - - name - description: Metadata fields common to all versions/kinds of entity. - additionalProperties: {} - EntityRelation: - 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. - required: - - targetRef - - type - description: A relation of a specific type to another entity in the catalog. - additionalProperties: false - Entity: - type: object - properties: - relations: - type: array - items: - $ref: '#/components/schemas/EntityRelation' - description: The relations that this entity has with other entities. - spec: - $ref: '#/components/schemas/JsonObject' - metadata: - $ref: '#/components/schemas/EntityMeta' - kind: - type: string - description: The high level entity type being described. - apiVersion: - type: string - description: |- - The version of specification format for this particular entity that - this is written against. - required: - - metadata - - kind - - apiVersion - description: The parts of the format that's common to all versions/kinds of entity. + # EntityLink: + # type: object + # properties: + # type: + # type: string + # description: An optional value to categorize links into specific groups + # icon: + # type: string + # description: An optional semantic key that represents a visual icon. + # title: + # type: string + # description: An optional descriptive title for the link. + # url: + # type: string + # description: The url to the external site, document, etc. + # required: + # - url + # description: A link to external information that is related to the entity. + # additionalProperties: false + # EntityMeta: + # 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 + # 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. + # required: + # - name + # description: Metadata fields common to all versions/kinds of entity. + # additionalProperties: {} + # EntityRelation: + # 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. + # required: + # - targetRef + # - type + # description: A relation of a specific type to another entity in the catalog. + # additionalProperties: false + # Entity: + # type: object + # properties: + # relations: + # type: array + # items: + # $ref: '#/components/schemas/EntityRelation' + # description: The relations that this entity has with other entities. + # spec: + # $ref: '#/components/schemas/JsonObject' + # metadata: + # $ref: '#/components/schemas/EntityMeta' + # kind: + # type: string + # description: The high level entity type being described. + # apiVersion: + # type: string + # description: |- + # The version of specification format for this particular entity that + # this is written against. + # required: + # - metadata + # - kind + # - apiVersion + # description: The parts of the format that's common to all versions/kinds of entity. Error: type: object properties: @@ -382,12 +383,12 @@ components: required: - tasks description: The response shape for the `listTasks` call to the `scaffolder-backend` - MapStringString: - type: object - properties: {} - additionalProperties: - type: string - description: Construct a type with a set of properties K of type T + # MapStringString: + # type: object + # properties: {} + # additionalProperties: + # type: string + # description: Construct a type with a set of properties K of type T ScaffolderScaffoldOptions: type: object properties: @@ -606,24 +607,24 @@ components: - completion - log - recovered - TaskRecovery: - type: object - # properties: - # EXPERIMENTAL_strategy: - # $ref: '#/components/schemas/TaskRecoverStrategy' - description: |- - When task didn't have a chance to complete due to system restart you can define the strategy what to do with such tasks, - by defining a strategy. + # TaskRecovery: + # type: object + # # properties: + # # EXPERIMENTAL_strategy: + # # $ref: '#/components/schemas/TaskRecoverStrategy' + # description: |- + # When task didn't have a chance to complete due to system restart you can define the strategy what to do with such tasks, + # by defining a strategy. - By default, it is none, what means to not recover but updating the status from 'processing' to 'failed'. - TaskRecoverStrategy: - type: string - description: | - - none: not recover, let the task be marked as failed - - startOver: do recover, start the execution of the task from the first step. - enum: - - none - - startOver + # By default, it is none, what means to not recover but updating the status from 'processing' to 'failed'. + # TaskRecoverStrategy: + # type: string + # description: | + # - none: not recover, let the task be marked as failed + # - startOver: do recover, start the execution of the task from the first step. + # enum: + # - none + # - startOver TaskSecrets: allOf: - type: object @@ -697,37 +698,37 @@ components: - processing - skipped description: The status of each step of the Task - TaskStep: - type: object - properties: - id: - type: string - description: A unique identifier for this step. - name: - type: string - description: A display name to show the user. - action: - type: string - description: The underlying action ID that will be called as part of running this step. - input: - $ref: '#/components/schemas/JsonObject' - description: Additional data that will be passed to the action. - # if: - # oneOf: - # - type: string - # - type: boolean - # description: When this is false, or if the templated value string evaluates to something that is falsy the step will be skipped. - each: - oneOf: - - type: string - - $ref: '#/components/schemas/JsonArray' - description: Run step repeatedly. - required: - - id - - name - - action - description: An individual step of a scaffolder task, as stored in the database. - additionalProperties: {} + # TaskStep: + # type: object + # properties: + # id: + # type: string + # description: A unique identifier for this step. + # name: + # type: string + # description: A display name to show the user. + # action: + # type: string + # description: The underlying action ID that will be called as part of running this step. + # input: + # $ref: '#/components/schemas/JsonObject' + # description: Additional data that will be passed to the action. + # # if: + # # oneOf: + # # - type: string + # # - type: boolean + # # description: When this is false, or if the templated value string evaluates to something that is falsy the step will be skipped. + # each: + # oneOf: + # - type: string + # - $ref: '#/components/schemas/JsonArray' + # description: Run step repeatedly. + # required: + # - id + # - name + # - action + # description: An individual step of a scaffolder task, as stored in the database. + # additionalProperties: {} # TemplateEntityStepV1beta3: # allOf: # - $ref: '#/components/schemas/JsonObject' @@ -825,29 +826,29 @@ components: # description: |- # Backstage catalog Template kind Entity. Templates are used by the Scaffolder # plugin to create new entities, such as Components. - TemplateInfo: - type: object - properties: - entityRef: - type: string - description: The entityRef of the template. - baseUrl: - type: string - description: Where the template is stored, so we can resolve relative paths for things like `fetch:template` paths. - entity: - type: object - properties: - metadata: - $ref: '#/components/schemas/EntityMeta' - description: The metadata of the Template. - required: - - metadata - description: The Template entity. - required: - - entityRef - description: |- - Information about a template that is stored on a task specification. - Includes a stringified entityRef, and the baseUrl which is usually the relative path of the template definition + # TemplateInfo: + # type: object + # properties: + # entityRef: + # type: string + # description: The entityRef of the template. + # baseUrl: + # type: string + # description: Where the template is stored, so we can resolve relative paths for things like `fetch:template` paths. + # entity: + # type: object + # properties: + # metadata: + # $ref: '#/components/schemas/EntityMeta' + # description: The metadata of the Template. + # required: + # - metadata + # description: The Template entity. + # required: + # - entityRef + # description: |- + # Information about a template that is stored on a task specification. + # Includes a stringified entityRef, and the baseUrl which is usually the relative path of the template definition TemplateParameterSchema: type: object properties: diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/models/Entity.model.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/models/Entity.model.ts deleted file mode 100644 index f386f3dd17..0000000000 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/models/Entity.model.ts +++ /dev/null @@ -1,45 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** -import { EntityMeta } from '../models/EntityMeta.model'; -import { EntityRelation } from '../models/EntityRelation.model'; - -/** - * The parts of the format that's common to all versions/kinds of entity. - * @public - */ -export interface Entity { - /** - * The relations that this entity has with other entities. - */ - relations?: Array; - /** - * A type representing all allowed JSON object values. - */ - spec?: { [key: string]: any }; - metadata: EntityMeta; - /** - * The high level entity type being described. - */ - kind: string; - /** - * The version of specification format for this particular entity that this is written against. - */ - apiVersion: string; -} diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/models/EntityLink.model.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/models/EntityLink.model.ts deleted file mode 100644 index 53d7d1f9ff..0000000000 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/models/EntityLink.model.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** - -/** - * A link to external information that is related to the entity. - * @public - */ -export interface EntityLink { - /** - * An optional value to categorize links into specific groups - */ - type?: string; - /** - * An optional semantic key that represents a visual icon. - */ - icon?: string; - /** - * An optional descriptive title for the link. - */ - title?: string; - /** - * The url to the external site, document, etc. - */ - url: string; -} diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/models/EntityMeta.model.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/models/EntityMeta.model.ts deleted file mode 100644 index cc8dd555a6..0000000000 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/models/EntityMeta.model.ts +++ /dev/null @@ -1,69 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** -import { EntityLink } from '../models/EntityLink.model'; - -/** - * Metadata fields common to all versions/kinds of entity. - * @public - */ -export interface EntityMeta { - [key: string]: any; - - /** - * A list of external hyperlinks related to the entity. - */ - links?: Array; - /** - * A list of single-valued strings, to for example classify catalog entities in various ways. - */ - tags?: Array; - /** - * Construct a type with a set of properties K of type T - */ - annotations?: { [key: string]: string }; - /** - * Construct a type with a set of properties K of type T - */ - labels?: { [key: string]: string }; - /** - * A short (typically relatively few words, on one line) description of the entity. - */ - description?: string; - /** - * 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. - */ - title?: string; - /** - * The namespace that the entity belongs to. - */ - namespace?: string; - /** - * 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. - */ - name: string; - /** - * 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. - */ - etag?: string; - /** - * 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. - */ - uid?: string; -} diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/models/EntityRelation.model.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/models/EntityRelation.model.ts deleted file mode 100644 index fe98a84481..0000000000 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/models/EntityRelation.model.ts +++ /dev/null @@ -1,34 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** - -/** - * A relation of a specific type to another entity in the catalog. - * @public - */ -export interface EntityRelation { - /** - * The entity ref of the target of this relation. - */ - targetRef: string; - /** - * The type of the relation. - */ - type: string; -} diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskRecoverStrategy.model.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskRecoverStrategy.model.ts deleted file mode 100644 index e00b2dfa88..0000000000 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskRecoverStrategy.model.ts +++ /dev/null @@ -1,32 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** - -/** - * @public - */ -export type TaskRecoverStrategy = 'none' | 'startOver'; - -/** - * @public - */ -export const TaskRecoverStrategy = { - None: 'none' as TaskRecoverStrategy, - StartOver: 'startOver' as TaskRecoverStrategy, -}; diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskStep.model.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskStep.model.ts deleted file mode 100644 index c36049b9a6..0000000000 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskStep.model.ts +++ /dev/null @@ -1,46 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** -import { TaskStepEach } from '../models/TaskStepEach.model'; - -/** - * An individual step of a scaffolder task, as stored in the database. - * @public - */ -export interface TaskStep { - [key: string]: any; - - /** - * A unique identifier for this step. - */ - id: string; - /** - * A display name to show the user. - */ - name: string; - /** - * The underlying action ID that will be called as part of running this step. - */ - action: string; - /** - * A type representing all allowed JSON object values. - */ - input?: { [key: string]: any }; - each?: TaskStepEach; -} diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskStepEach.model.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskStepEach.model.ts deleted file mode 100644 index 398a19ee88..0000000000 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TaskStepEach.model.ts +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** -import { JsonValue } from '../models/JsonValue.model'; - -/** - * Run step repeatedly. - * @public - */ -export type TaskStepEach = Array | string; diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TemplateInfo.model.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/models/TemplateInfo.model.ts deleted file mode 100644 index ea5b9da6e9..0000000000 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TemplateInfo.model.ts +++ /dev/null @@ -1,36 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** -import { TemplateInfoEntity } from '../models/TemplateInfoEntity.model'; - -/** - * Information about a template that is stored on a task specification. Includes a stringified entityRef, and the baseUrl which is usually the relative path of the template definition - * @public - */ -export interface TemplateInfo { - /** - * The entityRef of the template. - */ - entityRef: string; - /** - * Where the template is stored, so we can resolve relative paths for things like `fetch:template` paths. - */ - baseUrl?: string; - entity?: TemplateInfoEntity; -} diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TemplateInfoEntity.model.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/models/TemplateInfoEntity.model.ts deleted file mode 100644 index 993b995512..0000000000 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/models/TemplateInfoEntity.model.ts +++ /dev/null @@ -1,28 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** -import { EntityMeta } from '../models/EntityMeta.model'; - -/** - * The Template entity. - * @public - */ -export interface TemplateInfoEntity { - metadata: EntityMeta; -} diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/models/index.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/models/index.ts index 7f5a2de608..d9a4ff832c 100644 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/models/index.ts +++ b/plugins/scaffolder-backend/src/schema/openapi/generated/models/index.ts @@ -32,10 +32,6 @@ export * from '../models/DryRunResult.model'; export * from '../models/DryRunResultLogInner.model'; export * from '../models/DryRunResultLogInnerBody.model'; export * from '../models/DryRunResultLogInnerBodyAllOf.model'; -export * from '../models/Entity.model'; -export * from '../models/EntityLink.model'; -export * from '../models/EntityMeta.model'; -export * from '../models/EntityRelation.model'; export * from '../models/ErrorError.model'; export * from '../models/ErrorRequest.model'; export * from '../models/ErrorResponse.model'; @@ -51,14 +47,9 @@ export * from '../models/SerializedFile.model'; export * from '../models/SerializedTask.model'; export * from '../models/SerializedTaskEvent.model'; export * from '../models/TaskEventType.model'; -export * from '../models/TaskRecoverStrategy.model'; export * from '../models/TaskSecrets.model'; export * from '../models/TaskSecretsAllOf.model'; export * from '../models/TaskStatus.model'; -export * from '../models/TaskStep.model'; -export * from '../models/TaskStepEach.model'; -export * from '../models/TemplateInfo.model'; -export * from '../models/TemplateInfoEntity.model'; export * from '../models/TemplateParameterSchema.model'; export * from '../models/TemplateParameterSchemaStepsInner.model'; export * from '../models/ValidationError.model'; diff --git a/plugins/scaffolder-backend/src/schema/openapi/generated/router.ts b/plugins/scaffolder-backend/src/schema/openapi/generated/router.ts index 29c7d9af93..104bfcd29b 100644 --- a/plugins/scaffolder-backend/src/schema/openapi/generated/router.ts +++ b/plugins/scaffolder-backend/src/schema/openapi/generated/router.ts @@ -60,6 +60,7 @@ export const spec = { in: 'query', description: 'Offset event ID to stream events after.', required: false, + allowReserved: true, schema: { type: 'integer', }, @@ -172,7 +173,7 @@ export const spec = { description: { type: 'string', }, - examples: { + "'examples'": { type: 'array', items: { $ref: '#/components/schemas/ActionExample', @@ -253,139 +254,6 @@ export const spec = { }, required: ['log', 'directoryContents', 'output'], }, - EntityLink: { - type: 'object', - properties: { - type: { - type: 'string', - description: - 'An optional value to categorize links into specific groups', - }, - icon: { - type: 'string', - description: - 'An optional semantic key that represents a visual icon.', - }, - title: { - type: 'string', - description: 'An optional descriptive title for the link.', - }, - url: { - type: 'string', - description: 'The url to the external site, document, etc.', - }, - }, - required: ['url'], - description: - 'A link to external information that is related to the entity.', - additionalProperties: false, - }, - EntityMeta: { - 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.', - }, - }, - required: ['name'], - description: 'Metadata fields common to all versions/kinds of entity.', - additionalProperties: {}, - }, - EntityRelation: { - 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.', - }, - }, - required: ['targetRef', 'type'], - description: - 'A relation of a specific type to another entity in the catalog.', - additionalProperties: false, - }, - Entity: { - type: 'object', - properties: { - relations: { - type: 'array', - items: { - $ref: '#/components/schemas/EntityRelation', - }, - description: - 'The relations that this entity has with other entities.', - }, - spec: { - $ref: '#/components/schemas/JsonObject', - }, - metadata: { - $ref: '#/components/schemas/EntityMeta', - }, - kind: { - type: 'string', - description: 'The high level entity type being described.', - }, - apiVersion: { - type: 'string', - description: - 'The version of specification format for this particular entity that\nthis is written against.', - }, - }, - required: ['metadata', 'kind', 'apiVersion'], - description: - "The parts of the format that's common to all versions/kinds of entity.", - }, Error: { type: 'object', properties: { @@ -502,14 +370,6 @@ export const spec = { description: 'The response shape for the `listTasks` call to the `scaffolder-backend`', }, - MapStringString: { - type: 'object', - properties: {}, - additionalProperties: { - type: 'string', - }, - description: 'Construct a type with a set of properties K of type T', - }, ScaffolderScaffoldOptions: { type: 'object', properties: { @@ -629,17 +489,6 @@ export const spec = { description: 'TaskEventType', enum: ['cancelled', 'completion', 'log', 'recovered'], }, - TaskRecovery: { - type: 'object', - description: - "When task didn't have a chance to complete due to system restart you can define the strategy what to do with such tasks,\nby defining a strategy.\n\nBy default, it is none, what means to not recover but updating the status from 'processing' to 'failed'.", - }, - TaskRecoverStrategy: { - type: 'string', - description: - '- none: not recover, let the task be marked as failed\n- startOver: do recover, start the execution of the task from the first step.\n', - enum: ['none', 'startOver'], - }, TaskSecrets: { allOf: [ { @@ -671,71 +520,6 @@ export const spec = { ], description: 'The status of each step of the Task', }, - TaskStep: { - type: 'object', - properties: { - id: { - type: 'string', - description: 'A unique identifier for this step.', - }, - name: { - type: 'string', - description: 'A display name to show the user.', - }, - action: { - type: 'string', - description: - 'The underlying action ID that will be called as part of running this step.', - }, - input: { - $ref: '#/components/schemas/JsonObject', - description: 'Additional data that will be passed to the action.', - }, - each: { - oneOf: [ - { - type: 'string', - }, - { - $ref: '#/components/schemas/JsonArray', - }, - ], - description: 'Run step repeatedly.', - }, - }, - required: ['id', 'name', 'action'], - description: - 'An individual step of a scaffolder task, as stored in the database.', - additionalProperties: {}, - }, - TemplateInfo: { - type: 'object', - properties: { - entityRef: { - type: 'string', - description: 'The entityRef of the template.', - }, - baseUrl: { - type: 'string', - description: - 'Where the template is stored, so we can resolve relative paths for things like `fetch:template` paths.', - }, - entity: { - type: 'object', - properties: { - metadata: { - $ref: '#/components/schemas/EntityMeta', - description: 'The metadata of the Template.', - }, - }, - required: ['metadata'], - description: 'The Template entity.', - }, - }, - required: ['entityRef'], - description: - 'Information about a template that is stored on a task specification.\nIncludes a stringified entityRef, and the baseUrl which is usually the relative path of the template definition', - }, TemplateParameterSchema: { type: 'object', properties: { diff --git a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/Entity.model.ts b/plugins/scaffolder-common/client/src/schema/openapi/generated/models/Entity.model.ts deleted file mode 100644 index f386f3dd17..0000000000 --- a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/Entity.model.ts +++ /dev/null @@ -1,45 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** -import { EntityMeta } from '../models/EntityMeta.model'; -import { EntityRelation } from '../models/EntityRelation.model'; - -/** - * The parts of the format that's common to all versions/kinds of entity. - * @public - */ -export interface Entity { - /** - * The relations that this entity has with other entities. - */ - relations?: Array; - /** - * A type representing all allowed JSON object values. - */ - spec?: { [key: string]: any }; - metadata: EntityMeta; - /** - * The high level entity type being described. - */ - kind: string; - /** - * The version of specification format for this particular entity that this is written against. - */ - apiVersion: string; -} diff --git a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/EntityLink.model.ts b/plugins/scaffolder-common/client/src/schema/openapi/generated/models/EntityLink.model.ts deleted file mode 100644 index 53d7d1f9ff..0000000000 --- a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/EntityLink.model.ts +++ /dev/null @@ -1,42 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** - -/** - * A link to external information that is related to the entity. - * @public - */ -export interface EntityLink { - /** - * An optional value to categorize links into specific groups - */ - type?: string; - /** - * An optional semantic key that represents a visual icon. - */ - icon?: string; - /** - * An optional descriptive title for the link. - */ - title?: string; - /** - * The url to the external site, document, etc. - */ - url: string; -} diff --git a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/EntityMeta.model.ts b/plugins/scaffolder-common/client/src/schema/openapi/generated/models/EntityMeta.model.ts deleted file mode 100644 index cc8dd555a6..0000000000 --- a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/EntityMeta.model.ts +++ /dev/null @@ -1,69 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** -import { EntityLink } from '../models/EntityLink.model'; - -/** - * Metadata fields common to all versions/kinds of entity. - * @public - */ -export interface EntityMeta { - [key: string]: any; - - /** - * A list of external hyperlinks related to the entity. - */ - links?: Array; - /** - * A list of single-valued strings, to for example classify catalog entities in various ways. - */ - tags?: Array; - /** - * Construct a type with a set of properties K of type T - */ - annotations?: { [key: string]: string }; - /** - * Construct a type with a set of properties K of type T - */ - labels?: { [key: string]: string }; - /** - * A short (typically relatively few words, on one line) description of the entity. - */ - description?: string; - /** - * 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. - */ - title?: string; - /** - * The namespace that the entity belongs to. - */ - namespace?: string; - /** - * 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. - */ - name: string; - /** - * 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. - */ - etag?: string; - /** - * 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. - */ - uid?: string; -} diff --git a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/EntityRelation.model.ts b/plugins/scaffolder-common/client/src/schema/openapi/generated/models/EntityRelation.model.ts deleted file mode 100644 index fe98a84481..0000000000 --- a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/EntityRelation.model.ts +++ /dev/null @@ -1,34 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** - -/** - * A relation of a specific type to another entity in the catalog. - * @public - */ -export interface EntityRelation { - /** - * The entity ref of the target of this relation. - */ - targetRef: string; - /** - * The type of the relation. - */ - type: string; -} diff --git a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TaskRecoverStrategy.model.ts b/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TaskRecoverStrategy.model.ts deleted file mode 100644 index e00b2dfa88..0000000000 --- a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TaskRecoverStrategy.model.ts +++ /dev/null @@ -1,32 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** - -/** - * @public - */ -export type TaskRecoverStrategy = 'none' | 'startOver'; - -/** - * @public - */ -export const TaskRecoverStrategy = { - None: 'none' as TaskRecoverStrategy, - StartOver: 'startOver' as TaskRecoverStrategy, -}; diff --git a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TaskStep.model.ts b/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TaskStep.model.ts deleted file mode 100644 index c36049b9a6..0000000000 --- a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TaskStep.model.ts +++ /dev/null @@ -1,46 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** -import { TaskStepEach } from '../models/TaskStepEach.model'; - -/** - * An individual step of a scaffolder task, as stored in the database. - * @public - */ -export interface TaskStep { - [key: string]: any; - - /** - * A unique identifier for this step. - */ - id: string; - /** - * A display name to show the user. - */ - name: string; - /** - * The underlying action ID that will be called as part of running this step. - */ - action: string; - /** - * A type representing all allowed JSON object values. - */ - input?: { [key: string]: any }; - each?: TaskStepEach; -} diff --git a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TaskStepEach.model.ts b/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TaskStepEach.model.ts deleted file mode 100644 index 398a19ee88..0000000000 --- a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TaskStepEach.model.ts +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** -import { JsonValue } from '../models/JsonValue.model'; - -/** - * Run step repeatedly. - * @public - */ -export type TaskStepEach = Array | string; diff --git a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TemplateInfo.model.ts b/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TemplateInfo.model.ts deleted file mode 100644 index ea5b9da6e9..0000000000 --- a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TemplateInfo.model.ts +++ /dev/null @@ -1,36 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** -import { TemplateInfoEntity } from '../models/TemplateInfoEntity.model'; - -/** - * Information about a template that is stored on a task specification. Includes a stringified entityRef, and the baseUrl which is usually the relative path of the template definition - * @public - */ -export interface TemplateInfo { - /** - * The entityRef of the template. - */ - entityRef: string; - /** - * Where the template is stored, so we can resolve relative paths for things like `fetch:template` paths. - */ - baseUrl?: string; - entity?: TemplateInfoEntity; -} diff --git a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TemplateInfoEntity.model.ts b/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TemplateInfoEntity.model.ts deleted file mode 100644 index 993b995512..0000000000 --- a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/TemplateInfoEntity.model.ts +++ /dev/null @@ -1,28 +0,0 @@ -/* - * Copyright 2024 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. * -// ****************************************************************** -import { EntityMeta } from '../models/EntityMeta.model'; - -/** - * The Template entity. - * @public - */ -export interface TemplateInfoEntity { - metadata: EntityMeta; -} diff --git a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/index.ts b/plugins/scaffolder-common/client/src/schema/openapi/generated/models/index.ts index 7f5a2de608..d9a4ff832c 100644 --- a/plugins/scaffolder-common/client/src/schema/openapi/generated/models/index.ts +++ b/plugins/scaffolder-common/client/src/schema/openapi/generated/models/index.ts @@ -32,10 +32,6 @@ export * from '../models/DryRunResult.model'; export * from '../models/DryRunResultLogInner.model'; export * from '../models/DryRunResultLogInnerBody.model'; export * from '../models/DryRunResultLogInnerBodyAllOf.model'; -export * from '../models/Entity.model'; -export * from '../models/EntityLink.model'; -export * from '../models/EntityMeta.model'; -export * from '../models/EntityRelation.model'; export * from '../models/ErrorError.model'; export * from '../models/ErrorRequest.model'; export * from '../models/ErrorResponse.model'; @@ -51,14 +47,9 @@ export * from '../models/SerializedFile.model'; export * from '../models/SerializedTask.model'; export * from '../models/SerializedTaskEvent.model'; export * from '../models/TaskEventType.model'; -export * from '../models/TaskRecoverStrategy.model'; export * from '../models/TaskSecrets.model'; export * from '../models/TaskSecretsAllOf.model'; export * from '../models/TaskStatus.model'; -export * from '../models/TaskStep.model'; -export * from '../models/TaskStepEach.model'; -export * from '../models/TemplateInfo.model'; -export * from '../models/TemplateInfoEntity.model'; export * from '../models/TemplateParameterSchema.model'; export * from '../models/TemplateParameterSchemaStepsInner.model'; export * from '../models/ValidationError.model'; diff --git a/plugins/scaffolder-common/src/ScaffolderClient.test.ts b/plugins/scaffolder-common/src/ScaffolderClient.test.ts index 03064d7086..eff0356bc9 100644 --- a/plugins/scaffolder-common/src/ScaffolderClient.test.ts +++ b/plugins/scaffolder-common/src/ScaffolderClient.test.ts @@ -365,21 +365,18 @@ describe('api', () => { it('should list tasks with limit and offset', async () => { server.use( - rest.get( - `${mockBaseUrl}/v2/tasks?limit=5&offset=0`, - (_req, res, ctx) => { - return res( - ctx.json([ - { - createdBy: null, - }, - { - createdBy: null, - }, - ]), - ); - }, - ), + rest.get(`${mockBaseUrl}/v2/tasks`, (_req, res, ctx) => { + return res( + ctx.json([ + { + createdBy: null, + }, + { + createdBy: null, + }, + ]), + ); + }), ); const result = await apiClient.listTasks({