[PRFC] API Docs for the whole backend #17535
Conversation
Changed Packages
|
|
Thanks for the contribution! |
sennyeya
force-pushed
the
api-docs-new-backend
branch
from
14af47d
to
1fc3453
Compare
Uffizzi Ephemeral Environment
|
sennyeya
force-pushed
the
api-docs-new-backend
branch
from
1fc3453
to
bdadb3d
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
sennyeya
force-pushed
the
api-docs-new-backend
branch
2 times, most recently
from
842dfb0
to
0b09425
Compare
sennyeya
force-pushed
the
api-docs-new-backend
branch
3 times, most recently
from
cfceb19
to
592ce91
Compare
app-config.yaml
Outdated
| @@ -47,6 +47,7 @@ backend: | |||
| allow: | |||
| - host: example.com | |||
| - host: '*.mozilla.org' | |||
| - host: localhost:7007 | |||
There was a problem hiding this comment.
Catalog imports don't support reading the internal OpenAPI spec without this.
sennyeya
force-pushed
the
api-docs-new-backend
branch
from
518ada2
to
81b7ee6
Compare
There was a problem hiding this comment.
Looking forward to use Backstage to document our plugin APIs 🎉 , thanks for contributing!
The changes to search-backend looks great to me, I've added only a curiosity question below. I'll leave the registry plugin review to @backstage/maintainers , I think they'll have great inputs to share!
|
This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution! |
Signed-off-by: Aramis <sennyeyaramis@gmail.com> Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
sennyeya
force-pushed
the
api-docs-new-backend
branch
from
86ccc1a
to
b0562a1
Compare
Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
|
Need a maintainer @Rugvip |
| 'backstage.io/managed-by-location': | ||
| 'internal-package:@backstage/plugin-catalog-backend-module-openapi-spec', | ||
| 'backstage.io/managed-by-origin-location': | ||
| 'internal-package:@backstage/plugin-catalog-backend-module-openapi-spec', |
There was a problem hiding this comment.
ANNOTATION_LOCATION and ANNOTATION_ORIGIN_LOCATION for these.
I take it this entire structure is fairly experimental and likely to evolve? Otherwise I'm thinking it would make sense to make it possible to configure the name and perhaps some other fields in the entity.
There was a problem hiding this comment.
Yeah, for now I'd like to keep the extensability small as this is all very experimental
Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
|
@Rugvip I updated per your comments. Assuming this builds, it should be ready for another round. |
Signed-off-by: Aramis Sennyey <aramiss@spotify.com>
…schema Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
|
Thank you for contributing to Backstage! The changes in this pull request will be part of the |
Hey, I just made a Pull Request!
Summary
Support serving your Backstage instance's API docs in your Backstage instance's catalog. Inception 🤯 .
Caveats
Testing
Since the Uffizi instance isn't set up to serve the
backend-nextpackage, to see the full benefits of this package, you'll have to test locally.cd packages/backend-next && yarn startoryarn --cwd packages/backend-next startand then issue a GET request to${your_base_url}/api/api-registry.openapi/openapi.json(still a WIP on the URL). You should see all registered OpenAPI specs under their correct prefixes. Currently, this is just the catalog API.✔️ Checklist
Signed-off-byline in the message. (more info)