q-shift / backstage-plugins

Apache License 2.0
3 stars 7 forks source link

Add missing description, examples and schema for the Quarkus actions #6

Closed cmoulliard closed 10 months ago

cmoulliard commented 10 months ago

Issue

Add the missing description, examples and schema for our Quarkus actions to allow to document them when the user opens http://localhost:3000/create/actions

We dont set the field description part of our actions using createTemplateAction like examples and our schema is not exposed !!

Example of what we should do:

  return createTemplateAction<{ url: string; targetPath: string }>({
    id: 'fetch:plain:file',
    description: 'Downloads single file and places it in the workspace.',
    examples,
    schema: {
      input: {
        type: 'object',
        required: ['url', 'targetPath'],
        properties: {
          url: {
            title: 'Fetch URL',
            description:
              'Relative path or absolute URL pointing to the single file to fetch.',
            type: 'string',
          },
...

Screenshot 2024-01-15 at 19 14 14