Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How can extensions introspect application artifacts #5426

Closed
bajtos opened this issue May 14, 2020 · 2 comments
Closed

How can extensions introspect application artifacts #5426

bajtos opened this issue May 14, 2020 · 2 comments

Comments

@bajtos
Copy link
Member

bajtos commented May 14, 2020

This story is extracted from #4099, where we researched existing LoopBack 3 components and various techniques they use.

Now we need to write documentation for extension authors to show how to solve the following use cases in LoopBack 4:

  1. Get a list of all models (entity classes) used by the application

  2. Get definition of a given model (information about properties, relations, mixins, etc.)

  3. Get a list of all remote methods (REST API endpoints) provided by a given model.

  4. Obtain a list of all REST endpoints provided by the application, including metadata about request parameters & response schema, and any other information necessary to configure reverse-proxy routing rules (Kong, nginx,
    etc.).

In most cases, the new content will be useful to authors building new LB4 components too, therefore we should structure the content in two parts:

bajtos added a commit that referenced this issue May 14, 2020
Link to follow-up issues for the following areas:

- Services: #5424
- API transports: #5425
- Instrospection: #5426

Propose to not write any migration guide for auth/auth extensions yet.

Add a placeholder page for migration of Models, finalize LB4 sidebar
and the component-migration overview page.

Signed-off-by: Miroslav Bajtoš <[email protected]>
bajtos added a commit that referenced this issue May 15, 2020
Link to follow-up issues for the following areas:

- Services: #5424
- API transports: #5425
- Instrospection: #5426

Propose to not write any migration guide for auth/auth extensions yet.

Add a placeholder page for migration of Models, finalize LB4 sidebar
and the component-migration overview page.

Signed-off-by: Miroslav Bajtoš <[email protected]>
@stale
Copy link

stale bot commented Dec 25, 2020

This issue has been marked stale because it has not seen activity within six months. If you believe this to be in error, please contact one of the code owners, listed in the CODEOWNERS file at the top-level of this repository. This issue will be closed within 30 days of being stale.

@stale stale bot added the stale label Dec 25, 2020
@stale
Copy link

stale bot commented Jul 14, 2021

This issue has been closed due to continued inactivity. Thank you for your understanding. If you believe this to be in error, please contact one of the code owners, listed in the CODEOWNERS file at the top-level of this repository.

@stale stale bot closed this as completed Jul 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant