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

refactor: merging all docs into a single repository #37

Closed
wants to merge 24 commits into from

Conversation

jarrodek
Copy link
Member

@jarrodek jarrodek commented Sep 27, 2021

  • consolidating all components in this module
  • redesigning the parameters and schema UI
  • adding more authorization scheme UIs
  • changing API surface (e.g. domainId instead of selected)
  • basing UI rendering on the "serialized" model using the ApiSerializer
  • significatnly making the code base smaller

TODO

  • Add "try it" button
  • Sync the Operation template
  • Sync the Endpoint template
  • Sync the Schema template
  • Sync the Response template
  • Sync the Payload template
  • Render the request editor side-by-side
  • Render multiple security schemes applied to a single method with tabs/drop-down selector
  • Fix the (unknown path) in the operation
  • Rendering of fragments and the partial model
  • main api-documentation element
  • replace body content type selector with radio buttons like in the request editor
  • move the api-summary element
  • Tests

Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
@jarrodek jarrodek changed the title chore: adding base logic for the docs components refactor: merging all docs into a single repository Sep 28, 2021
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
Signed-off-by: Pawel Psztyc <jarrodek@gmail.com>
@jarrodek
Copy link
Member Author

Closing this in favor of api-components/amf-components#1

This component will be deprecated and a single repository will have all AMF related components and libraries.

@jarrodek jarrodek closed this Oct 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant