42 Commits

Author SHA1 Message Date
Claire Peng 5185e919cf delete trailing whitespace
Signed-off-by: Claire Peng <clairep@spotify.com>
2026-04-09 11:42:10 +01:00
Claire Peng f713b2459b add note about API Base URL in api-docs plugin Readme
Signed-off-by: Claire Peng <clairep@spotify.com>
2026-04-09 10:57:56 +01:00
Patrik Oldsberg 98b6b9701b Address review feedback on plugin README updates
- Apply freben's suggested wording for old frontend system sections to
  clarify they can be skipped on the new frontend system
- Fix scaffolder README: add missing imports (AnyApiFactory,
  scmIntegrationsApiRef), closing bracket, and update link text
- Fix devtools README: correct closing tag from `</ FlatRoutes>` to
  `</FlatRoutes>`
- Fix kubernetes README: reword "must be explicitly added" to avoid
  conflicting with feature discovery paragraph

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-16 13:20:01 +01:00
Patrik Oldsberg 17dff0ba25 docs: rename package discovery to feature discovery and reduce duplication
Rename "package discovery" to "feature discovery" across all plugin
READMEs and docs to match the established terminology. Slim down the
Feature Discovery section in the architecture docs to avoid duplicating
the configuration details now covered in the installing plugins page.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-04 12:57:49 +01:00
Patrik Oldsberg ae71853b45 docs(api-docs): update README for new frontend system as default
Add new frontend system installation as the default path with package
discovery. Move old frontend system wiring to an "Old Frontend System"
section. Update README-alpha.md to be an extension reference rather
than experimental documentation.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
2026-03-04 11:38:40 +01:00
luccas 69a66d9661 run prettier
Signed-off-by: luccas <luccasmtxr@gmail.com>
2024-11-05 15:02:02 -03:00
luccas 4ead5772a5 update readme
Signed-off-by: luccas <luccasmtxr@gmail.com>
2024-11-05 14:54:14 -03:00
Simon Stamm ebfeb40305 feat(apidocs): add resolvers prop to AsyncApiDefinitionWidget
Signed-off-by: Simon Stamm <simon.stamm@tui.com>
2024-06-19 17:55:40 +02:00
Patrik Oldsberg 70de473b42 Merge pull request #22536 from Lazzaretti/feature/asyncapi3
feat(docs): Add documentation & example that AsyncApi 3 is supported
2024-02-13 13:24:46 +01:00
Fabrizio Lazzaretti a6620fbc5a Merge branch 'backstage:master' into feature/asyncapi3 2024-02-08 10:24:03 +01:00
Camila Belo 101d3a7067 docs(api-docs): add alpha readme file
Signed-off-by: Camila Belo <camilaibs@gmail.com>
2024-02-08 09:56:03 +01:00
Fredrik Adelöw 9aac2b0d36 move cwd as the first argument to yarn
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2024-02-04 20:13:00 +01:00
Lazzaretti d105626ef6 feat(docs): Add documentation & example that AsyncApi 3 is supported
Signed-off-by: Lazzaretti <fabrizio@lazzaretti.me>
2024-01-26 14:19:40 +01:00
marmionl 170c023384 feat: adding supportedSubmitMethods prop to SwaggerUI component
Signed-off-by: marmionl <l.marmion@elsvier.com>
Signed-off-by: marmionl <l.marmion+copilot@elsvier.com>
2024-01-22 12:27:42 +00:00
River Phillips 76b2ea6a49 fix: use latest AsyncAPI instead of specific version
Signed-off-by: River Phillips <riverphillips1@gmail.com>
2024-01-02 15:18:54 +00:00
River Phillips 3515ccc6bd fix(docs): replace AsyncAPI spec urls with valid ones
Signed-off-by: River Phillips <riverphillips1@gmail.com>
2024-01-02 14:17:36 +00:00
Guillaume Rahbari 62310404b7 fix(api-docs): override oauth2RedirectUrl
Signed-off-by: Guillaume Rahbari <guillaume.rahbari@protonmail.com>
2023-10-27 11:54:36 +02:00
Mauricio Martinez e3993a0f3b Adding ticks to requestInterceptor on docs to avoid spell change
Signed-off-by: Mauricio Martinez <mauricio.martinez@premise.com>
2023-09-12 14:19:22 -06:00
Mauricio Martinez 03c9e4c570 Remove cors-anywhere example in favor of simple header change
Signed-off-by: Mauricio Martinez <mauricio.martinez@premise.com>
2023-09-12 14:17:06 -06:00
Mauricio Martinez aad197a601 Update definitionWidgets to map instead of forEach loop
Signed-off-by: Mauricio Martinez <mauricio.martinez@premise.com>
2023-09-11 17:42:51 -06:00
Mauricio Martinez d457253de9 Comments
Signed-off-by: Mauricio Martinez <mauricio.martinez@premise.com>
2023-09-04 10:57:23 -06:00
Mauricio Martinez 0117a6b47e Adding requestInterceptor
Signed-off-by: Mauricio Martinez <mauricio.martinez@premise.com>
2023-08-17 12:09:20 -06:00
blam 12db47680b chore: fixing api-docs
Signed-off-by: blam <ben@blam.sh>
2023-01-20 11:03:30 +01:00
Patrik Oldsberg 89bb53685c vale: prune accepted vocabulary
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2022-04-27 18:44:55 +02:00
LvffY f3101fb9d2 [#10459] 📝 Update documentation to use yarn --cwd arg
Signed-off-by: LvffY <louberger@hotmail.fr>
2022-03-30 15:53:05 +02:00
Patrik Oldsberg f0adfda527 api-docs: use hardcoded script sha for oauth2-redirect.html CSP
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-11-30 13:41:37 +01:00
Pavel fb7a0bdeac Update README.md
This is needed, otherwise, after you're redirected back there is an error from browser and nothing works.

Signed-off-by: Pavlo Poliakov <pavlo.poliakov@share-now.com>
2021-11-07 21:44:54 +01:00
Philipp Hugenroth 5b0b5baa5e Fix Grid in EntityPage for smaller screens
Signed-off-by: Philipp Hugenroth <philipph@spotify.com>
2021-07-14 18:52:03 +02:00
Oliver Sand f852f7381c Revert "Add support for json schema to API docs"
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-05-03 17:25:15 +02:00
Oliver Sand 2b5506a5d7 Merge pull request #5532 from SDA-SE/feat/json-schmea
Add support for json schema to API docs
2021-05-03 13:15:50 +02:00
Fredrik Adelöw b99ac3f6e1 Minor composability etc docs changes
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
2021-05-02 22:13:05 +02:00
Oliver Sand cec7fb9b37 Add support for json schema to API docs
Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
2021-04-29 16:27:08 +02:00
Patrik Oldsberg 74f74ccbdb Apply suggestions from code review
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2021-04-27 17:16:16 +02:00
Patrik Oldsberg c614ede9a5 docs: update plugin installation docs
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-04-22 18:32:54 +02:00
Dominik Henneke d17b39d04e Document how to customize the API docs rendering
Signed-off-by: Dominik Henneke <dominik.henneke@sda-se.com>
2021-04-08 18:54:15 +02:00
Alan Crosswell 7b9950ce20 Document how to install oauth2-redirect.html
Signed-off-by: Alan Crosswell <alan@columbia.edu>
2021-03-03 16:32:00 -05:00
Oliver Sand 032aba5920 Apply suggestions from code review
Co-authored-by: Fredrik Adelöw <freben@gmail.com>
2020-11-26 16:40:18 +01:00
Oliver Sand fb19e0241d Add providesApis and consumesApis to component spec 2020-11-25 16:01:34 +01:00
Mayursinh Sarvaiya 5c6a0356c0 feat: TechDocs - Add vale linter to check words quality in md files. (#2631)
* fix(docs): typos which were reflacted from vale linter's command

* feat: Implement Vale linter (#2031)
Initialize .vale.ini file
Add 'lint:docs' script to package.json, to lint all md files except the ones which are located in node_modules
Generate 'vocab.txt' by using command 'yarn run lint:docs' | grep -o ''[a-z A-Z]*'' | grep -o '[a-z A-Z]*' | sort | uniq > .github/styles/vocab.txt
Add steps to github workflow 'master' to check docs quality

* chore: Separate workflow for quality checking

* chore: Added 'shx' dev dependency to support grep command in cross platform

* feat: Add script to operate same quality check process on different platform

* ignore: remove lint:docs from lint-stages which was added for experiment purpose

* fix: check-all-files on push event & check-changed-files on pull_request event

* chore(CI): triggle workflow only when there is any updates in .md file(s) on pull request

* fix: use spawnSync to solve 'The command line is too long.' error

* fix: github workflow syntax

* fix: prettier error

* chore: add vale command directly to lint-staged

* chore: use shebang for easy access

* fix: windows script issue & remove shebang

* chore: Add shebang flag

* chore: better error message related to vale

* chore: mention vale linter in documentation

* fix: spelling errors & add keywords to vocab.txt
2020-10-02 07:20:47 +02:00
Andrew Thauer 678a9c90de feat: add graphql api type 2020-09-13 22:01:11 -04:00
Oliver Sand 774a000729 Readme for api-docs Plugin (#2041)
* docs(api-docs): add details to readme

* docs: fix wrong markdown in readme files
2020-08-20 13:57:59 +02:00
Dominik Henneke 812659c024 feat(api-docs): add plugin that provides widgets that display api docs 2020-08-12 13:53:34 +02:00